プラグインのシステムイベント一覧

プラグインに付与できるシステムイベントの一覧です。

  • ※ 調べきれなかったイベントもありますのでご了承ください。
目次
  1. Webページ（Template Service Events）
  2. キャッシュ（Cache Service Events）
  3. Webページ認証（Web Access Service Events）
  4. 管理画面（Manager Access Events）
  5. パーサー（Parser Service Events）
  6. チャンク（Chunks）
  7. リソース（Documents）
  8. モジュール（Modules）
  9. プラグイン（Plugins）
  10. リッチテキストエディタ"TinyMCE"（RichText Editor）
  11. スニペット（Snippets）
  12. グローバル設定（System Settings）
  13. テンプレート変数（Template Variables）
  14. テンプレート（Templates）
  15. 管理画面ユーザー（Users）
  16. Webページ認証用ユーザー（Web Users）

Webページ（Template Service Events）

Webページ関連のイベントです。
ブラウザからWebページとしてアクセスした際に発生するイベントです。

No イベント名 説明
104 OnBeforeGetDocID  
101 OnLoadDocumentObject  
91 OnLoadWebDocument レスポンスが送信される直前、およびリソース（ページ）が読み込まれた時に発生する。
例えば、ブラウザでページ自体をリクエストした時、CSSファイルをリクエストした時などに発生する。
MODXとしてリクエストした場合に発生するイベントなので、htaccessなどMODXを通らないようにしているリクエストは発生しない。
95 OnLogPageHit  
92 OnParseDocument リソース（ページ）の読み込み中、タグが解析されるたびに発生する。
テンプレート（変数含む）やチャンク、スニペット、プラグインなどタグの処理が行われるものはそのたびに発生する。
94 OnWebPageComplete リソース（ページ）の読み込み、レスポンスの送信、キャッシュの保存がそれぞれ完了した時に発生する。
90 OnWebPageInit リソース（ページ）の読み込みの時の最適化時に発生する。
3 OnWebPagePrerender リソースが解析された後かつレンダリングされる前に発生する。

キャッシュ（Cache Service Events）

キャッシュ関連のイベントです。

No イベント名 説明
18 OnBeforeCacheUpdate キャッシュを更新する前に発生する。
リソースの更新やサイトをリフレッシュした際などで発生する。
21 OnBeforeSaveWebPageCache  
19 OnCacheUpdate キャッシュを更新した時に発生する。
リソースの更新やサイトをリフレッシュした際などで発生する。
20 OnLoadWebPageCache  

Webページ認証（Web Access Service Events）

会員限定ページなどWebページ上の認証に関連するイベントです。
独自開発したものはもちろん、スニペット"WebLogin"での認証でも発生します。

No イベント名 説明
78 OnBeforeWebLogin ログインを試みた時（ログインする前）に発生する。
入力ミスなどでログインに失敗した時でも発生する。
5 OnBeforeWebLogout ログアウトする前に発生する。
79 OnWebAuthentication  
9 OnWebChangePassword パスワードを変更したときに発生する。
Webページ側からでも管理画面からでも発生する。
管理画面のウェブユーザーの編集でパスワードを変更せずに更新ボタンを押した時も発生する。
10 OnWebCreateGroup グループ管理(ウェブ)でグループを作成した時に発生する。
8 OnWebDeleteUser 管理画面の"ウェブユーザー管理"からユーザーを削除した時に発生する。
4 OnWebLogin ログインした後（ログインに成功した時）に発生する。
6 OnWebLogout ログアウトした時に発生する。
7 OnWebSaveUser 管理画面のウェブユーザー管理からユーザーを作成または編集で保存した時（更新ボタンを押した時）に発生する。

管理画面（Manager Access Events）

管理画面に関連するイベントです。

No イベント名 説明
80 OnBeforeManagerLogin ログインを試みた時（ログインする前）に発生する。
入力ミスなどでログインに失敗した時でも発生する。
12 OnBeforeManagerLogout ログアウトする前に発生する。
96 OnBeforeManagerPageInit 管理画面のページの最適化前に発生する。
302 OnExportExec エクスポートを実行した時に発生する。
301 OnExportPreExec  
71 OnFileManagerUpload 管理画面のファイル管理からファイルをアップロードした時に発生する。
TinyMCEの画像の画像挿入時のアップロードでは発生しない。
81 OnManagerAuthentication  
16 OnManagerChangePassword パスワードを変更したときに発生する。
17 OnManagerCreateGroup  
15 OnManagerDeleteUser ユーザーを削除した時に発生する。
208 OnManagerFrameLoader  
11 OnManagerLogin ログインした後（ログインに成功した時）に発生する。
99 OnManagerLoginFormPrerender  
93 OnManagerLoginFormRender  
13 OnManagerLogout ログアウトした時に発生する。
206 OnManagerMainFrameHeaderHTMLBlock 管理画面のメインとなる画面（フレーム要素）をレンダリングする前に発生する。
このイベントを使用してメインとなる画面のhead要素内にマークアップすることが可能。
213 OnManagerNodePrerender  
214 OnManagerNodeRender  
89 OnManagerPageInit 管理画面のページの最適化後に発生する。
207 OnManagerPreFrameLoader  
14 OnManagerSaveUser ユーザーを作成または編集で保存した時（更新ボタンを押した時）に発生する。
209 OnManagerTreeInit  
210 OnManagerTreePrerender  
211 OnManagerTreeRender  
202 OnManagerWelcomeHome  
201 OnManagerWelcomePrerender  
203 OnManagerWelcomeRender  

パーサー（Parser Service Events）

パーサー関連のイベントです。

No イベント名 説明
303 OnGetConfig グローバル設定が読み込まれるたびに発生する。
様々な場所で発生するため頻繁に発生する。
300 OnMakeUrl URLを生成した時に発生する。
キャッシュを生成する際にリソースのURLを生成する時や、ページを読み込んだ時のアドレスバーに表示されるURLなどの生成で発生する。
1000 OnPageNotFound リクエストした際に404エラーとなった場合に発生する。
999 OnPageUnauthorized  
70 OnSiteRefresh サイトのキャッシュがリフレッシュされた際に発生する。
管理画面の"サイトのリフレッシュ"を実行した際やページの強制再読み込みなどで発生する。

（Chunks）

チャンク関連のイベントです。

No イベント名 説明
26 OnBeforeChunkFormDelete チャンクを削除する前に発生する。
24 OnBeforeChunkFormSave チャンクの新規作成または編集で保存する前に発生する。
304 OnCallChunk チャンクの何かしらの操作を行ったときに発生する。
チャンクの実行や取得時、作成時、編集時の際に発生する。
チャンクの作成や編集時の表示やキャンセル時にも発生する。
チャンクを削除したときは発生しない。
27 OnChunkFormDelete チャンクを削除した時に発生する。
22 OnChunkFormPrerender チャンクのレンダリング前に発生する。
チャンクの実行や取得時、作成時、編集時の際に発生する。
23 OnChunkFormRender チャンクのレンダリング後に発生する。
チャンクの実行や取得時、作成時、編集時の際に発生する。
25 OnChunkFormSave チャンクの新規作成または編集で保存した時（"更新"ボタンを押した時）に発生する。

リソース（Documents）

リソース関連のイベントです。

No イベント名 説明
204 OnBeforeDocDuplicate リソースを複製する前に発生する。
32 OnBeforeDocFormDelete リソースを削除する前に発生する。
完全な削除ではなく復元できる状態のリソースを対象とする。
30 OnBeforeDocFormSave リソースの新規投稿（作成）または編集で保存する前に発生する。
102 OnBeforeDocFormUnDelete リソースを復元する前に発生する。
97 OnBeforeEmptyTrash リソースを完全に削除する前に発生する。
200 OnCreateDocGroup  
205 OnDocDuplicate リソースを複製した後に発生する。
33 OnDocFormDelete リソースを削除した後に発生する。
完全な削除ではなく復元できる状態のリソースを対象とする。
28 OnDocFormPrerender リソースの新規投稿（作成）または編集のレンダリングをする前に発生します。
29 OnDocFormRender リソースの新規投稿（作成）または編集のレンダリングをした時に発生します。
31 OnDocFormSave リソースの新規投稿（作成）または編集で保存した時（"更新"ボタンを押した時）に発生する。
103 OnDocFormUnDelete リソースを復元した後に発生する。
216 OnDocListPrerender  
215 OnDocListRender  
1 OnDocPublished 公開開始日時が設定されている場合に、公開開始日時になり公開状態となった時に発生する。
2 OnDocUnPublished 公開終了日時が設定されている場合に、公開終了日時になり非公開状態となった時に発生する。
98 OnEmptyTrash リソースを完全に削除した後に発生する。
100 OnStripAlias  

モジュール（Modules）

モジュール関連のイベントです。

No イベント名 説明
74 OnBeforeModFormDelete モジュールを削除する前に発生する。
76 OnBeforeModFormSave モジュールの作成または編集で保存する前に発生する。
75 OnModFormDelete モジュールを削除した後に発生する。
72 OnModFormPrerender モジュールの作成または編集する時の画面のレンダリング前に発生する。
73 OnModFormRender モジュールの作成または編集する時の画面をレンダリングした後に発生する。
77 OnModFormSave モジュールの作成または編集で保存した時（更新ボタンを押した時）に発生する。

プラグイン（Plugins）

プラグイン関連のイベントです。

No イベント名 説明
38 OnBeforePluginFormDelete プラグインを削除する前に発生する。
36 OnBeforePluginFormSave プラグインの作成または編集で保存する前に発生する。
39 OnPluginFormDelete プラグインを削除した後に発生する。
34 OnPluginFormPrerender プラグインの作成または編集する時の画面のレンダリング前に発生する。
35 OnPluginFormRender プラグインの作成または編集する時の画面をレンダリングした後に発生する。
37 OnPluginFormSave プラグインの作成または編集で保存した時（更新ボタンを押した時）に発生する。

リッチテキストエディタ"TinyMCE"（RichText Editor）

リッチテキストエディタ"TinyMCE"に関連のイベントです。

No イベント名 説明
88 OnRichTextEditorInit リッチテキストエディタ"TinyMCE"の最適化が行われた時に発生する。
87 OnRichTextEditorRegister リッチテキストエディタ"TinyMCE"がレンダリングされた時に発生する。

スニペット（Snippets）

スニペット関連のイベントです。

No イベント名 説明
44 OnBeforeSnipFormDelete スニペットを削除する前に発生する。
42 OnBeforeSnipFormSave スニペットの作成または編集で保存する前に発生する。
45 OnSnipFormDelete スニペットを削除した後に発生する。
40 OnSnipFormPrerender スニペットの作成または編集する時の画面のレンダリング前に発生する。
41 OnSnipFormRender スニペットの作成または編集する時の画面をレンダリングした後に発生する。
43 OnSnipFormSave スニペットの作成または編集で保存した時（更新ボタンを押した時）に発生する。

グローバル設定（System Settings）

グローバル設定に関連するイベントです。

No イベント名 説明
83 OnFriendlyURLSettingsRender "フレンドリーURL"に関連する画面をレンダリングした後に発生する。
85 OnInterfaceSettingsRender  
86 OnMiscSettingsRender  
82 OnSiteSettingsRender "サイト"に関連する画面をレンダリングした後に発生する。
212 OnSystemSettingsRender  
84 OnUserSettingsRender  

テンプレート変数（Template Variables）

テンプレート変数関連のイベントです。

No イベント名 説明
56 OnBeforeTVFormDelete テンプレート変数を削除する前に発生する。
54 OnBeforeTVFormSave テンプレート変数の作成または編集で保存する前に発生する。
57 OnTVFormDelete テンプレート変数を削除した後に発生する。
52 OnTVFormPrerender テンプレート変数の作成または編集する時の画面のレンダリング前に発生する。
53 OnTVFormRender テンプレート変数の作成または編集する時の画面をレンダリングした後に発生する。
55 OnTVFormSave テンプレート変数の作成または編集で保存した時（更新ボタンを押した時）に発生する。

テンプレート（Templates）

テンプレート関連のイベントです。

No イベント名 説明
50 OnBeforeTempFormDelete テンプレートを削除する前に発生する。
48 OnBeforeTempFormSave テンプレートの作成または編集で保存する前に発生する。
51 OnTempFormDelete テンプレートを削除した後に発生する。
46 OnTempFormPrerender テンプレートの作成または編集する時の画面のレンダリング前に発生する。
47 OnTempFormRender テンプレートの作成または編集する時の画面をレンダリングした後に発生する。
49 OnTempFormSave テンプレートの作成または編集で保存した時（更新ボタンを押した時）に発生する。

管理画面ユーザー（Users）

管理画面の管理ユーザーに関連するイベントです。

No イベント名 説明
62 OnBeforeUserFormDelete ユーザーを削除する前に発生する。
60 OnBeforeUserFormSave ユーザーの作成または編集で保存する前に発生する。
63 OnUserFormDelete ユーザーを削除した後に発生する。
58 OnUserFormPrerender ユーザーの作成または編集する時の画面のレンダリング前に発生する。
59 OnUserFormRender ユーザーの作成または編集する時の画面をレンダリングした後に発生する。
61 OnUserFormSave ユーザーの作成または編集で保存した時（更新ボタンを押した時）に発生する。

Webページ認証用ユーザー（Web Users）

Webページ認証用ユーザー（ウェブユーザー管理）に関連するイベントです。

No イベント名 説明
68 OnBeforeWUsrFormDelete ユーザーを削除する前に発生する。
66 OnBeforeWUsrFormSave ユーザーの作成または編集で保存する前に発生する。
69 OnWUsrFormDelete ユーザーを削除した後に発生する。
64 OnWUsrFormPrerender ユーザーの作成または編集する時の画面のレンダリング前に発生する。
65 OnWUsrFormRender ユーザーの作成または編集する時の画面をレンダリングした後に発生する。
67 OnWUsrFormSave ユーザーの作成または編集で保存した時（更新ボタンを押した時）に発生する。

CMS「MODX Evolution」逆引きリファレンス一覧へ戻る