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

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

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

Webページ（Template Service Events）

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

イベント名 説明
OnAfterLoadDocumentObject
OnBeforeLoadDocumentObject
OnBeforeLoadExtension
OnBeforeParseParams
OnDocPublished 公開開始日時が設定されている場合に、公開開始日時になり公開状態となった時に発生する。
OnDocUnPublished 公開終了日時が設定されている場合に、公開終了日時になり非公開状態となった時に発生する。
OnLoadDocumentObject
OnLoadWebDocument
OnMakeDocUrl
OnParseDocument リソース（ページ）の読み込み中、タグが解析されるたびに発生する。
テンプレート（変数含む）やチャンク、スニペット、プラグインなどタグの処理が行われるものはそのたびに発生する。
OnParseProperties
OnWebPageComplete リソース（ページ）の読み込み、レスポンスの送信、キャッシュの保存がそれぞれ完了した時に発生する。
OnWebPageInit リソース（ページ）の読み込みの時の最適化時に発生する。
OnWebPagePrerender リソースが解析された後かつレンダリングされる前に発生する。

キャッシュ（Cache Service Events）

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

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

管理画面（Manager Access Events）

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

イベント名 説明
OnBeforeManagerPageInit
OnManagerFrameLoader
OnManagerLoginFormPrerender
OnManagerLoginFormRender
OnManagerMainFrameHeaderHTMLBlock
OnManagerMenuPrerender
OnManagerNodePrerender
OnManagerNodeRender
OnManagerPageInit
OnManagerPreFrameLoader
OnManagerTopPrerender
OnManagerTreeInit
OnManagerTreePrerender
OnManagerTreeRender
OnManagerWelcomeHome
OnManagerWelcomePrerender
OnManagerWelcomeRender

パーサー（Parser Service Events）

関連のイベントです。

イベント名 説明
OnBeforeMailSend
OnBeforeMinifyCss
OnFileManagerUpload ファイルマネージャー（「エレメント」の「Files」）でファイルをアップロードした際に発生する。
evo()->event->paramsで次の内容を得ることができる。

Array (
    [filepath] => アップロード先ディレクトリパス（フルパス）
    [filename] => アップロードしたファイル名
)
OnPageNotFound ページを表示した際にページが見つからず404となった場合に発生する。
OnPageUnauthorized
OnSiteRefresh サイトのキャッシュがリフレッシュされた際に発生する。
管理画面の"サイトをリフレッシュ"を実行した際やページの強制再読み込みなどで発生する。

チャンク（Chunks）

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

イベント名 説明
OnBeforeChunkFormDelete チャンクを削除する前に発生する。
OnBeforeChunkFormSave チャンクの新規作成または編集で保存する前に発生する。
OnChunkFormDelete チャンクを削除した時に発生する。
OnChunkFormPrerender チャンクのレンダリング前に発生する。
チャンクの実行や取得時、作成時、編集時の際に発生する。
OnChunkFormRender チャンクのレンダリング後に発生する。
チャンクの実行や取得時、作成時、編集時の際に発生する。
OnChunkFormSave チャンクの新規作成または編集で保存した時（"更新"ボタンを押した時）に発生する。

リソース（Documents）

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

イベント名 説明
OnAfterMoveDocument

ディレクトリツリーからリソースを移動する後に発生する。
evo()->event->paramsで次の内容を得ることができる。

Array (
    [id] => 対象のリソースID
    [old_parent] => 移動前のリソースID
    [new_parent] => 移動後のリソースID
)
OnBeforeDocDuplicate リソースを複製する前に発生する。
evo()->event->paramsで次の内容を得ることができる。

Array (
    [id] => 複製元のリソースID
)
OnBeforeDocFormDelete リソースを削除する前に発生する。
完全な削除ではなく復元できる状態のリソースを対象とする。
evo()->event->paramsで次の内容を得ることができる。

Array (
    [id] => 対象のリソースID
    [children] => サブリソースID（配列）
)
OnBeforeDocFormSave リソースの新規投稿（作成）または編集で保存する前に発生する。
evo()->event->paramsで次のような内容を得ることができる。

Array(
    [mode] => 投稿か更新（投稿 ... new　更新 ... upd）
    [id] => 対象のリソースID
    [doc] => リソース変数（配列　更新の場合変更後の内容を返す）
)
OnBeforeEmptyTrash リソースを完全に削除する前に発生する。
evo()->event->paramsで次の内容を得ることができる。

Array (
    [ids] => 対象のリソースID（配列　サブリソースを含む）
)
OnBeforeMoveDocument

ディレクトリツリーからリソースを移動する前に発生する。
evo()->event->paramsで次の内容を得ることができる。

Array (
    [id] => 対象のリソースID
    [old_parent] => 移動前のリソースID
    [new_parent] => 移動後のリソースID
)
OnCreateDocGroup
OnDocDuplicate リソースを複製した後に発生する。
evo()->event->paramsで次の内容を得ることができる。

Array (
    [id] => 複製元のリソースID
    [new_id] => 複製後のリソースID
)
OnDocFormDelete リソースを削除した後に発生する。
完全な削除ではなく復元できる状態のリソースを対象とする。
evo()->event->paramsで次の内容を得ることができる。

Array (
    [id] => 対象のリソースID
    [children] => サブリソースID（配列）
)
OnDocFormPrerender リソースの新規投稿（作成）または編集のレンダリングをする前に発生する。
OnDocFormRender リソースの新規投稿（作成）または編集のレンダリングをした時に発生する。
OnDocFormSave リソースの新規投稿（作成）または編集で保存した時（"更新"ボタンを押した時）に発生する。
evo()->event->paramsで次のような内容を得ることができる。

Array(
    [mode] => 投稿か更新（投稿 ... new　更新 ... upd）
    [id] => 対象のリソースID
    [doc] => リソース変数（配列　更新の場合変更後の内容を返す）
)
OnDocFormTemplateRender テンプレートが読み込まれた時に発生する。
リソースの投稿や編集を開始した時、「使用テンプレート」を切り替えた時に発生する。
OnDocFormUnDelete リソースを復元した後に発生する。
evo()->event->paramsで次の内容を得ることができる。

Array (
    [id] => 対象のリソースID
    [children] => サブリソースID（配列）
)
OnEmptyTrash リソースを完全に削除した後に発生する。
evo()->event->paramsで次の内容を得ることができる。

Array (
    [ids] => 対象のリソースID（配列　サブリソースを含む）
)
OnStripAlias

ファイルマネージャー（File Browser Events）

画像管理、ファイル管理機能で発生するイベントです。

  • ※ 「エレメント」の「Files」でのファイルマネージャーでは発生しません。
イベント名 説明
OnBeforeFileBrowserCopy
OnBeforeFileBrowserDelete ファイルの削除前に発生する。
OnBeforeFileBrowserMove
OnBeforeFileBrowserRename ファイル名を変更する前に発生する。
OnBeforeFileBrowserUpload ファイルのアップロード前に発生する。
OnFileBrowserCopy
OnFileBrowserDelete ファイルの削除後に発生する。
OnFileBrowserInit 画面が表示された際に発生する。
ツリーとファイル一覧の両方で発生し、表示切り替えなど表示が切り替わるたびに発生する。
OnFileBrowserMove
OnFileBrowserRename ファイル名を変更した後に発生する。
OnFileBrowserUpload ファイルのアップロード後に発生する。

ログ（Log Event）

ログ関連のイベントです。

イベント名 説明
OnLogEvent evo()->addLog

モジュール（Modules）

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

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

プラグイン（Plugins）

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

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

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

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

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

スニペット（Snippets）

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

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

グローバル設定（System Settings）

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

イベント名 説明
OnFileManagerSettingsRender
OnFriendlyURLSettingsRender "フレンドリーURL"に関連する画面をレンダリングした後に発生する。
OnInterfaceSettingsRender
OnLoadSettings
OnMiscSettingsRender
OnSecuritySettingsRender
OnSiteSettingsRender "サイト"に関連する画面をレンダリングした後に発生する。
OnUserSettingsRender

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

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

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

テンプレート（Templates）

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

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

ユーザー（Users）

ユーザー関連のイベントです。

イベント名 説明
OnBeforeUserDelete
OnBeforeUserLogin
OnBeforeUserLogout
OnBeforeUserSave
OnUserAuthentication
OnUserChangePassword
OnUserCreateGroup
OnUserDelete
OnUserFormPrerender
OnUserFormRender
OnUserLogin
OnUserLogout
OnUserSave

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