システムイベント一覧

このエントリーをはてなブックマークに追加

これはシステムイベントの全てではありませんが需要性の高そうなものから少しづつ追加していきます。

 出力関連
イベント名発生タイミング
90 OnWebPageInit リソースの存在を確認した直後
リソースがない場合OnPageNotFoundが先
101 OnLoadDocumentObject リソース内容をドキュメントオブジェクトに読み込んだ直後
ドキュメントオブジェクトが操作可能になります(テンプレート変数は今後実装)
キャッシュを使用する場合実行されない
91 OnLoadWebDocument 表示可能なリソースと判断された後
キャッシュを使用する場合実行されない
92 OnParseDocument パースされる直前
最終的な出力結果を作るまでに複数回発生します
3 OnWebPagePrerender リソースを出力する直前
94 OnWebPageComplete リソースを出力した直後
1 OnDocPublished ドキュメントが「公開」状態になった直後
2 OnDocUnPublished ドキュメントが「非公開」状態になった直後
キャッシュ関連
OnBeforeSaveWebPageCache キャッシュファイルを新しく作成する直前
OnWebPageCompleteの前
OnBeforeCacheUpdate キャッシュファイルを更新して作成する直前
OnCacheUpdate キャッシュファイルを更新して作成した直後
OnLoadWebPageCache キャッシュが存在してそれを読み込んだ直後
OnWebPageInitの次
ユーザーアクセス関連
78 OnBeforeWebLogin ログイン処理の直前
4 OnWebLogin ログイン処理の直後
5 OnBeforeWebLogout ログアウト処理の直前
6 OnWebLogout ログアウト処理の直後
7 OnWebSaveUser ユーザー情報を保存した直後
OnWUsrFormSaveの前
8 OnWebDeleteUser ユーザー情報を削除した直後
OnWUsrFormDeleteの前
9 OnWebChangePassword パスワードを変更した直後
ユーザー情報を編集している場合OnWebSaveUserの後
10 OnWebCreateGroup ユーザーグループを作成した直後
79 OnWebAuthentication スニペットのWebloginが使用される場合
ユーザー認証をする直前
管理ユーザー関係
OnBeforeUserFormSave ユーザー情報を保存する前
OnUserFormSave ユーザー情報を保存した後
OnBeforeUserFormDelete ユーザー情報を削除する前
OnUserFormDelete ユーザー情報を削除した後
OnUserFormPrerender ユーザー情報編集フォームを出力する前
OnUserFormRender ユーザー情報編集フォームを出力した後
ウェブユーザー関連
OnBeforeWUsrFormSave ユーザー情報を保存する前
OnWUsrFormSave ユーザー情報を保存した後
OnBeforeWUsrFormDelete ユーザー情報を削除する前
OnWUsrFormDelete ユーザー情報を削除した後
OnWUsrFormPrerender ユーザー情報編集フォームを出力する前
OnWUsrFormRender ユーザー情報編集フォームを出力した後
リソースの編集関連
204 OnBeforeDocDuplicate リソースを移動する直前
32 OnBeforeDocFormDelete リソースをゴミ箱に入れる直前
30 OnBeforeDocFormSave リソースを保存する直前
97 OnBeforeEmptyTrash リソースをゴミ箱から完全に削除する直前
200 OnCreateDocGroup リソースグループを作成した直後
205 OnDocDuplicate リソースを移動した直後
23 OnDocFormDelete リソースをゴミ箱に入れた直後
28 OnDocFormPrerender リソース編集フォームを出力する直前
29 OnDocFormRender リソース編集フォームを出力した直後
31 OnDocFormSave リソースを保存した直後
98 OnEmptyTrash リソースをゴミ箱から完全に削除した直後
100 OnStripAlias エイリアス文字をフォーマットする直前
マネージャー関連
99 OnManagerLoginFormPrerender ログインフォームを作成する前
同名のプレースホルダにセットできます
93 OnManagerLoginFormRender ログインフォームを作成した後
同名のプレースホルダにセットできます
80 OnBeforeManagerLogin ログイン処理の前
11 OnManagerLogin ログイン処理の後
81 OnManagerAuthentication ログイン可能なIDか確認した後、外部認証処理が可能
OnBeforeManagerLoginの後、OnManagerLoginの前
12 OnBeforeManagerLogout ログアウト処理の前
13 OnManagerLogout ログアウト処理の後
96 OnBeforeManagerPageInit ページアクセスして最初
89 OnManagerPageInit マネージャーアクションを振り分ける直前
207 OnManagerPreFrameLoader フレーム用HTMLを出力する前
OnManagerFrameLoader フレーム用HTMLを出力した後
OnManagerWelcomePrerender ダッシュボード画面の表示をする時
上から連続で呼ばれますが
$modx->event->output()で返した値は同名のプレースホルダにセットされます
OnManagerWelcomeHome
OnManagerWelcomeRender
209 OnManagerTreeInit リソースツリー用ページのHTML(body)を出力する前
210 OnManagerTreePrerender リソースツリー本体を出力する前
211 OnManagerTreeRender リソースツリー本体を出力した後
206 OnManagerMainFrameHeaderHTMLBlock メインフレームのHTMLヘッダー部分
ヘッダーを追加できます
OnManagerSaveUser 管理ユーザー情報を保存した後
新規ならOnUserFormSaveの前
編集ならOnManagerChangePasswordの前
15 OnManagerDeleteUser
16 OnManagerChangePassword
17 OnManagerCreateGroup
301 OnExportPreExec
302 OnExportExec

左の数字はイベントのIDですが実際プラグインでの分岐はOnから始まるイベント名を使用するので特に意識する必要は無いと思います。ソースを追いながらタイミングを確認してちょこちょこと追加していますが、間違っているものがあればご連絡ください(o-ω-))ペコ

参考サイト

MODX Evolution - ページ出力の処理の流れ

Edited on 2014.05.30 Created on 2014.05.27 MODXCMSEvoアドオン開発
PAGE TO TOP