- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。（詳細）
プラグイン API/アクションフック一覧
提供: WordPress Codex 日本語版
WordPress バージョン2.1以上で利用できるアクションフックの完全（だといいのですが）なリストです。詳しい情報については下記もご覧ください。
- フィルターフック、アクションフックについてもっと詳しく知るには、プラグイン API をご覧ください。
- プラグインの書き方については、プラグインの作成 をご覧ください。
- フィルターフックの一覧リファレンスは、プラグイン API/フィルターフック一覧をご覧ください。
- 他のバージョンのプラグインフックについては、Plugin API/Hooks 2.0.x（英語）をご覧ください。
注: もしこの文書に情報を追加したり、内容をより分かりやすく書き換えたい場合は、現在のスタイルに従って編集を行ってください。
目次
一般的リクエスト中に実行されるアクション
以下はバージョン 3.3.1でログインしているユーザーがホームページを表示したときに呼びだされるアクションです。この一覧には、各アクションが最初に呼び出される際のみの情報が含まれている可能性があり、多くの場合ではアクションにフックされている関数がない場合もあります。テーマやプラグインによってさらに違ったタイミングで何度かアクションが呼び出されることもあります。その証拠に、Twenty Eleven テーマ特有のアクションコールも以下に見ることができます。また、Cron タスクもユーザーがサイトを訪問した際にアクションを実行することがあります。以下の一覧は明確なスペックではなくガイドラインまたは WordPress がアクションを実行する順序の大体の目安として参照してください。
アクションは do_action() 関数 で呼び出されます。ただし (参照配列) と書かれたものは do_action_ref_array() 関数で呼び出されます。
| muplugins_loaded /en | must-use プラグインが読み込まれた後 |
| registered_taxonomy /en | カテゴリー、post_tag など用 |
| registered_post_type /en | 投稿、固定ページなど用 |
| plugins_loaded /en | 有効なプラグインとプラガブルな関数が読み込まれた後 |
| sanitize_comment_cookies /en | HTTPリクエストからCookieが読み取られた後に実行する |
| setup_theme /en | |
| load_textdomain /en | default ドメイン用 |
| after_setup_theme /en | 通常、テーマ設定・オプションを初期化するために使われる。これはテーマで最初に使えるアクションフックであり、有効なテーマの functions.php ファイルが読み込まれた直後にトリガーされる。init アクションフックは一部の機能には遅すぎるため、add_theme_support() はここで呼び出されるべきである。この段階では、現在のユーザーに対する認証は行われていない。 |
| auth_cookie_malformed /en | |
| auth_cookie_valid /en | |
| set_current_user /en | デフォルトの wp_set_current_user 関数でユーザーが変更された後に実行する |
| init /en | 通常プラグインの初期化に使われる。この段階で現在のユーザーに対する認証は完了している。 |
| └─ widgets_init /en | サイドバーの登録に使われる。'init' の際に、優先順位「1」で、したがって優先順位「1」以上の他の 'init' アクションよりも前に、実行される。 |
| register_sidebar /en | 各サイドバー、フッターエリア用 |
| wp_register_sidebar_widget /en | 各ウィジェット用 |
| wp_default_scripts /en | (参照配列) |
| wp_default_styles /en | (参照配列) |
| admin_bar_init /en | |
| add_admin_bar_menus /en | |
| wp_loaded /en | WordPress が完全に読み込まれた後 |
| parse_request /en | リクエスト処理を変更できるようにする (参照配列) |
| send_headers /en | ヘッダーを変更できるようにする (参照配列) |
| parse_query /en | クエリ変数が設定された後 (参照配列) |
| pre_get_posts | クエリが実行される前にクエリ変数オブジェクトを露出する (参照配列) 。 |
| posts_selection /en | |
| wp /en | WP オブジェクトが設定された後 (参照配列) |
| template_redirect /en | |
| get_header /en | |
| wp_enqueue_scripts /en | |
| twentyeleven_enqueue_color_scheme (Twenty Eleven 特有) | |
| wp_head | |
| wp_print_styles /en | |
| wp_print_scripts /en | |
| get_search_form /en | |
| loop_start /en | (参照配列) |
| the_post | (参照配列) クエリの直後に投稿オブジェクトを変更できるようにする |
| get_template_part_content /en | コンテンツのテンプレート部分 |
| loop_end /en | (参照配列) |
| get_sidebar /en | |
| dynamic_sidebar /en | |
| get_search_form /en | |
| pre_get_comments /en | (参照配列) |
| wp_meta /en | |
| get_footer /en | |
| get_sidebar /en | |
| twentyeleven_credits | (Twenty Eleven 特有) |
| wp_footer | |
| wp_print_footer_scripts /en | |
| admin_bar_menu /en | (参照配列) |
| wp_before_admin_bar_render /en | |
| wp_after_admin_bar_render /en | |
| shutdown /en | PHP の実行が終わりかけの時点 |
管理画面リクエスト中に実行されるアクション
以下はバージョン 3.3.1でログインしているユーザーが管理画面の投稿ページを表示したときに実行されるアクションです。この一覧には、アクションが最初に呼び出される際のみの情報が含まれています。表示している管理画面ページや使っているプラグインによって違ったアクションが呼び出されます。以下の一覧は明確なスペックではなく大体の目安として参照してください。
以下のアクションの (hookname) はページによって異なります。投稿ページでは edit.php、テーマの背景ページでは appearance_page_custom-background になります。
アクションは do_action() 関数 で呼び出されます。ただし (参照配列) と書かれたものは do_action_ref_array() 関数で呼び出されます。
タクソノミーとターム
- edit_terms
- (actually an action, but often used like a filter) hooked in prior to saving taxonomy/category change in the database
- edited_terms
- applied after saving taxonomy/category change in the database.
- edited_$taxonomy
- applied after saving specific taxonomy change in the database
投稿、ページ、添付ファイル、カテゴリー関連のアクション
- post_submitbox_misc_actions / en
- 「公開」ボタンのある Submit ボックスにフィールドなどのコンテンツの追加のため、編集ページが生成される際に実行する。
- アクション関数引数: なし
- add_attachment / en
- データベースに添付ファイルが新規追加された際に実行する。
- アクション関数引数: 添付ファイル ID
- add_category（非推奨）
- create_category と同様。
- category_add_form_fields
- 管理画面でカテゴリー追加フォームが作成される際に実行する。このフォーム の Submit ボタンの前にフィールドを追加する場合に有用。
- category_edit_form
- 管理画面でカテゴリー編集フォームが作成される際に実行する。このフォームに新しいフィールドを追加する場合に有用。
- clean_post_cache / en
- 投稿キャッシュのクリア後に実行する。clean_post_cache() /en を参照。
- アクション関数引数: 投稿 ID
- create_category
- カテゴリーが新規作成された際に実行する。
- アクション関数引数: カテゴリー ID
- delete_attachment / en
- データベースから添付ファイルが削除される直前に実行する。
- アクション関数引数: 添付ファイル ID
- delete_category
- データベースからカテゴリーが削除され、属していたリンク項目や投稿などからそのカテゴリー情報が削除される前に実行する(バージョン 2.8 以前では、このフックは添付ファイルが削除された後に実行されていた) 。
- アクション関数引数: カテゴリー ID
- trash_post / en
- 投稿またはページがゴミ箱に移動されようとする際に実行する。
- アクション関数引数: 投稿 ID またはページ ID
- trashed_post / en
- 投稿またはページがゴミ箱に移動された後に実行する。
- アクション関数引数: 投稿 ID またはページ
- untrash_post / en
- 投稿またはページがゴミ箱から復元される前に実行する。
- アクション関数引数: 投稿 ID またはページ
- untrashed_post / en
- 投稿またはページがゴミ箱から復元された後に実行する。
- アクション関数引数: 投稿 ID またはページ
- before_delete_post / en
- 投稿またはページが削除されようとする際に実行する。コメント、添付ファイル、メタ情報はまだ利用できる。
- アクション関数引数: 投稿 ID またはページ
- delete_post / en
- 投稿またはページが削除されようとする際に実行する。コメント、添付ファイル、メタ情報はすでに削除されている。
- アクション関数引数: 投稿 ID またはページ
- deleted_post / en
- 投稿またはページが削除された直後に実行する。
- アクション関数引数: 投稿 ID またはページ ID
- edit_attachment / en
- データベースで添付ファイル情報が編集・更新された際に実行する。
- アクション関数引数: 添付ファイル ID
- edit_category
- カテゴリーが更新・編集する際に実行する。これには、そのカテゴリーに属する投稿やリンクが追加・削除された場合（カテゴリー内の項目数が更新される）も含む。
- アクション関数引数: カテゴリー ID
- edit_post / en
- 投稿またはページが更新・編集された際に実行する。これには、コメントが追加・更新された場合（投稿またはページのコメント数が更新される）も含む。
- アクション関数引数: 投稿 ID またはページ ID
- pre_post_update / en
- 投稿またはページが更新される直前に実行する。
- アクション関数引数: 投稿 ID またはページ ID
- post_updated / en
- 投稿または固定ページが更新された後に実行する。
- アクション関数引数: 投稿 ID またはページ ID、変更前、および変更後の投稿の WP_Post オブジェクト
- transition_post_status /en
- 投稿ステータスの遷移が発生する際に実行する。
- アクション関数引数: $new_status、$old_status、$post オブジェクト (Post Status Transitions参照)。
- (old status)_to_(new status)
- 投稿ステータスが $old_status から $new_status に変わる際に実行する。
- アクション関数引数: $post オブジェクト (Post Status Transitions参照)。
- (status)_(post_type)
- タイプ $post_type の投稿が、$status に他のステータスから遷移した際に実行する。
- アクション関数引数: 投稿 ID、$post オブジェクト (Post Status Transitions参照)。
- publish_post / en (非推奨ではない)
- 投稿が公開された際、または編集されてステータスが「公開済み」に変わった際に実行する。このアクションフックは (status)_(post_type) アクションフックタイプと同じ。
- アクション関数引数: 投稿 ID、$post オブジェクト (Post Status Transitions参照)。
- publish_page / en
- 固定ページが公開された際、または編集されてステータスが「公開済み」に変わった際に実行する。このアクションフックは(status)_(post_type) アクションフックタイプと同じ。
- アクション関数引数: 投稿 ID、$post オブジェクト (Post Status Transitions参照)。
- publish_phone / en
- メールから投稿が公開された直後に実行する。
- アクション関数引数: 投稿 ID
- publish_future_post / en
- 予約投稿またはページが公開された際に実行する。
- アクション関数引数: 投稿 ID
- save_post / en
- インポート機能の利用、投稿・ページ編集フォームの利用、XMLRPC での投稿、メールでの投稿のうちいずれかの方法で投稿・ページが作成・更新された際に実行する。実行されるタイミングはデータがデータベースに保存された後。
- アクション関数引数: 投稿 ID, WP_Post オブジェクト, 真偽値(更新かどうか)
- 投稿 ID は最後に保存した投稿ではなく投稿履歴を参照していることもある。実際の投稿の ID を取得するには、wp_is_post_revision /en を使う。
- updated_postmeta / en
- メタ情報が更新された際に実行する。
- wp_insert_post / en
- 動作はsave_postと同じ。
save_postの直後に実行する。
- xmlrpc_publish_post / en
- XMLRPC リクエストによる投稿が作成された際、または XMLRPC を通してステータスが「公開」に変更された際に実行する。
- アクション関数引数: 投稿 ID
コメント、ピンバック、トラックバック関連のアクション
- comment_closed
- コメントを受け付けない指定をした投稿で、コメント送信フォームを表示しようとする際に実行する。
- アクション関数引数: 投稿 ID
- comment_id_not_found
- コメント送信フォームを表示しようとする際、投稿 ID が見つからなかった場合に実行する。
- アクション関数引数: 投稿 ID
- comment_flood_trigger
- 連続コメントエラーが検出された際、wp_dieが呼び出されてコメントを拒否する直前に実行する。
- アクション関数引数: 前回のコメント送信日時、今回のコメント送信日時
- comment_(old status)_to_(new status) / en
- コメントステータスの遷移が発生した際に実行する。
- アクション関数引数: コメントオブジェクト
- comment_on_draft
- コメント投稿フォームまたはコメントを表示しようとしている際、投稿が非公開状態の場合に実行する。
- アクション関数引数: 投稿 ID
- comment_post / en
- コメントがデータベースに保存される直前に実行する。
- アクション関数引数: コメント ID、承認ステータス（spam/スパム、0/未承認、1/承認済み）
- edit_comment
- データベース内でコメントが編集・更新された後に実行する。
- アクション関数引数: コメント ID
- delete_comment
- コメントが削除される直前に実行する。
- アクション関数引数: コメント ID
- deleted_comment
- コメントが削除された直後に実行する。
- アクション関数引数: コメント ID
- trash_comment
- コメントがゴミ箱に移動される直前に実行する。
- アクション関数引数: コメント ID
- trashed_comment
- コメントがゴミ箱に移動された直後に実行する。
- アクション関数引数: コメント ID
- comment_closed
- コメントが非スパムとしてマークされた際に実行する。
- pingback_post
- ピンバックが投稿に追加された際に実行する。
- アクション関数引数: コメント ID
- pre_ping
- ピンバックが完全に処理される前に実行する。
- アクション関数引数: 処理する投稿リンクの配列、投稿のピンバック受け付け設定
- trackback_post
- 投稿にトラックバックが追加された際に実行する。
- アクション関数引数: コメント ID
- wp_blacklist_check
- コメントをブラックリストに分類するかどうかチェックするために実行する。コメントを拒否するには、関数内でwp_dieを実行するか、入力引数に設定したブラックリストキーワードが含まれるように変更することができる。
- アクション関数引数: 投稿者名、投稿者メールアドレス、投稿者URL、コメント本文、投稿者のIPアドレス、投稿者のユーザーエージェント情報
- wp_insert_comment / en
- コメントが作成された際に実行する。
- wp_set_comment_status
- コメントのステータスが変更された際に実行する。
- アクション関数引数: コメント ID、変更後のステータスを表す文字列（delete/approve/spam/hold）
リンク集関連のアクション
- add_link
- リンク集にリンク項目が新規追加された際に実行する。
- アクション関数引数: リンク ID
- delete_link
- リンク集からリンク項目が削除された際に実行する。
- アクション関数引数: リンク ID
- edit_link
- リンク集のリンク項目が編集された際に実行する。
- アクション関数引数: リンク ID
フィード関連のアクション
- atom_entry （Atom フィード）
- rdf_item（RDF フィード）
- rss_item（RSS フィード）
- rss2_item（RSS2 フィード）
- 各フィードで投稿情報が表示された直後、entry または item タグを閉じる前に実行する。
- atom_head （Atom フィード）
- rdf_header（RDF フィード）
- rss_head（RSS フィード）
- 各フィードでブログの情報が表示された直後、一つ目の投稿の直前で実行する。
- commentrss2_item / en
- コメントフィードにコメント情報が表示された直後、<item>タグを閉じる前に実行する。
- アクション関数引数: コメント ID、投稿 ID
- do_feed_フィード名
- RSS2、Atom、RDFなどのフィードが生成される直前に実行する。フィード名には rss2、atom などフィードの種類を入れる。フィードが表示される前に実行するには、10以下のプライオリティを指定すること。
- アクション関数引数: フィードの種類（コメントフィードなら true、投稿フィードなら false）
テンプレート関連のアクション
- after_setup_theme / en
- テーマ初期化中に実行する。通常、基本設定、登録、テーマの init アクションに使われる。
- comment_form / en
- comment_form() がコメントフォームを出力する際、最後に終了タグ</form>を出力する直前で実行する。
- アクション関数引数: 投稿 ID
- do_robotstxt / en
-
do_robots()関数内でrobots.txtファイルに Disallow リストを表示する際に実行する。
- get_footer / en
- テンプレートが get_footer() 関数を呼び出した際、
footer.phpファイルが読み込まれる直前に実行する。
- get_header / en
- テンプレートが get_header() 関数を呼び出した際、
header.phpファイルが読み込まれる直前に実行する。
- switch_theme / en
- ブログのテーマが変更された際に実行する。テーマ内で使われた場合、このアクションを追加するテーマが無効化される際にのみ動作する。
- アクション関数引数: 変更されたテーマの名称
- after_switch_theme / en
- ブログのテーマが変更された際に実行する。テーマ内で使われた場合、このアクションを追加するテーマが有効化される際にのみ動作する。テーマを有効化する際に特定のコードを実行するために使える。
- アクション関数引数: 新テーマの名称
- load-themes.php / en
- テーマが有効化された際、または（他のテーマの有効化によって）無効化された際に実行する。
- template_redirect / en
- リクエストされたページを表示するのに使うため、テンプレートファイルを判断する前に実行する。
- wp_footer / en
- テンプレートが wp_footer 関数を呼び出す際に実行する。
wp_footer関数は通常、ブログページの最後付近で使われる。
- wp_head / en
- テンプレートが wp_head 関数を呼び出す際に実行する。wp_head 関数は通常、ブログページの先頭付近の
<head>要素内で使われる。 - アクション関数引数: なし
- wp_meta / en
-
sidebar.phpテンプレートが wp_meta 関数 を呼び出す際に実行し、プラグインがサイドバーにコンテンツを挿入できるようにする。
- wp_print_scripts / en
- ページの
<head>要素に、登録された JavaScript を出力する直前に実行する。
管理画面関連のアクション
- activate_プラグインファイル名 / en
- プラグインを初めて有効化する際に実行する。register_activation_hook() を参照。
- activity_box_end / en
- 管理画面ダッシュボードページで、「ブログの最新状況/現在の状況」ボックス部分の最後に実行する。
- add_category_form_pre / en
- 管理画面で、カテゴリー追加フォームがページに表示される前に実行する。
- add_option_(option_name) / en
- WordPress オプションが add_option() 関数で追加された後に実行する。例えばオプション "foo" が追加された際に反応させたい場合は、'add_option_foo' などのように、特定のオプションへのアクションを追加する必要がある。
- アクション関数引数: オプション名、オプション値
- add_option / en
- オプションがデータベースに追加される前に実行する。
- added_option / en
- オプションが追加された後に実行する。
- admin_head / en
- 管理画面各ページ HTML の
<head>要素内で実行する。
- admin_head-ページフック名 / en
- admin_head-プラグイン管理ページ名 / en
- プラグインが生成した管理画面ページ、またはプラグインが作成した管理画面の
<head>要素内で実行する。
- admin_init / en
- 管理画面各ページの最初、ページがレンダリングされる前に実行する。"wp-admin/admin.php"、"wp-admin/admin-post.php"、"wp-admin/admin-ajax.php" を参照。
- admin_footer-(plugin_page) / en
- プラグインが生成した管理画面ページの
<body>要素の最後で実行する。
- admin_post_(action) / en
- 汎用 GET または POST リクエストのハンドラを実行する。admin_post_nopriv_(action) も同じ。
- admin_footer / en
- 管理画面各ページの
<body>要素の終盤で実行する。
- admin_enqueue_scripts / en
- HTML ヘッダーで実行し、プラグインまたはテーマが JavaScript および CSS をすべての管理画面で enqueue できるようにする。
- admin_print_scripts / en
- 管理画面各ページの
<head>要素に JavaScript を追加するために実行する。
- admin_print_scripts-ページフック名 / en
- admin_print_scripts-プラグイン管理ページ名 / en
- プラグインが生成した管理画面ページの
<head>要素に JavaScript を追加するために実行する。「ページフック名」は add_management_page()、add_options_page() などのプラグインメニュー項目を追加する関数を使った場合に返される。例は以下のとおり。
function myplugin_menu() {
if ( function_exists('add_management_page') ) {
$page = add_management_page( 'myplugin', 'myplugin', 'manage_options', 'myplugin_slug', 'myplugin_admin_page' );
add_action( "admin_print_scripts-$page", 'myplugin_admin_head' );
}
}
- admin_print_styles / en
- HTML ヘッダーで実行する。プラグインはすべての管理画面に CSS / スタイルシートを追加できる。
- admin_print_styles-(page_hook) または admin_print_style-(plugin_page) / en
- 特定の管理画面用にスタイルが wp_enqueue_style() で enqueue される際に実行する。(page_hook) の値を決定するには add_submenu_page() などの関数の戻り値を使用する。
- check_passwords / en
- 新規ユーザー登録の際、パスワードの二重入力がマッチするか確認するために実行する。
- アクション関数引数: ログイン名配列、1度目に入力されたパスワード、2度目に入力されたパスワード
- dbx_post_advanced / en（投稿）
- dbx_page_advanced / en（ページ）
- 各編集管理画面の、詳細オプション部分の最後に実行する。
- dbx_post_sidebar / en（投稿）
- dbx_page_sidebar / en（ページ）
- 各編集管理画面のサイドバー部分の最後に実行する。WordPress 2.5以上では add_meta_box() を使用すること。
- deactivate_プラグインファイル名 / en
- プラグインが無効化された際に実行する。
- delete_option_(option_name) / en
- delete_option() 関数によって WordPress オプションが削除された後に実行する。例えばオプション "foo" が追加された際に反応させたい場合は、'delete_option_foo' などのように、特定のオプションへのアクションを追加する必要がある。
- アクション関数引数: オプション名
- delete_option / en
- オプションがデータベースから削除される前に実行する。
- deleted_option / en
- オプションがデータベースから削除された後に実行する。
- delete_user / en
- ユーザーが削除された際に実行する。
- アクション関数引数: ユーザー ID
- edit_category_form / en
- カテゴリー追加・編集フォームが管理画面に表示された後、<form> 要素の閉じタグの前に実行する。
- edit_category_form_pre / en
- カテゴリー編集フォームが管理画面に表示される前に実行する。
- edit_tag_form / en
- タグ編集フォームが管理画面メニューに表示される前に実行する。
- edit_tag_form_pre / en
- タグ追加・編集フォームが管理画面に表示された後、HTML フォームタグの最後よりも前に実行する。
- edit_form_top / en
- フォームの内部で、WordPress 投稿編集画面 (およびカスタム投稿タイプ) のタイトルの前、かつ、最初の隠しフィールド (user_ID、アクション 等) の後で実行する。
- edit_form_after_title / en
- WordPress 投稿編集画面 (およびカスタム投稿タイプ) のタイトルの後、かつ、ビルトインの WordPress コンテンツ領域の前で実行する。
- edit_form_after_editor / en
- WordPress 投稿編集画面の後、かつ、すべての他のメタボックスの前で実行する。カスタム投稿タイプでも同じ。
- edit_form_advanced / en（投稿）
- edit_page_form / en（ページ）
- 編集画面で、詳細設定のセクションが読み込まれる直前に実行する。
- edit_user_profile / en
- 管理画面のユーザープロフィール編集ページ終盤で実行する。
管理メニューに追加するための詳細は管理画面のカスタマイズを参照。 直接使いたい場合は add_options_page() やこれに似た関数の返り値としてアクション名の「ページ名」の部分が返される。
- login_form / en
- ログインフォームが読み込みが完了する直前に実行する。
- login_head / en
- ログインページの
<head>要素の読み込みが完了する直前に実行する。
- lost_password / en
- ログイン画面のパスワード紛失フォームが表示される直前に実行する。
- lostpassword_form / en
- パスワード紛失フォームの終盤で実行され、プラグインがフォームにフィールドを追加できるようにする。
- lostpassword_post / en
- ユーザーがパスワードの再発行をリクエストした際に実行する。これにより、処理の前に PHP の $_POST 変数を修正できるようになる。
- manage_link_custom_column / en
- リンク管理画面で不明なカラム名が存在する際に実行する。詳しくはプラグイン API/フィルターフック一覧、
manage_posts_columnsの項を参照。 - アクション関数引数: カラム名、リンク ID
- manage_posts_custom_column / en
- 投稿管理画面で不明なカラム名が存在する際に実行する。詳しくはプラグイン API/フィルターフック一覧、manage_posts_columns フィルター（カスタムカラムの追加）の項を参照（例と使い方については Scompt のチュートリアルを参照）。
- アクション関数引数: カラム名、投稿 ID
- manage_pages_custom_column / en
- 固定ページ管理画面で不明なカラム名が存在する際に実行する。詳しくはプラグイン API/フィルターフック一覧、manage_pages_columns フィルター（カスタムカラムの追加）の項を参照。
- アクション関数引数: カラム名、ページ ID
- manage_media_custom_column / en
- メディア管理画面で不明なカラム名が存在する際に実行する。詳しくはプラグイン API/フィルターフック一覧、manage_media_columns フィルター（カスタムカラムの追加）の項を参照。
- アクション関数引数: カラム名、ページ ID
- manage_{$post_type}_posts_custom_column / en
- カスタム投稿タイプ管理画面で不明なカラム名が存在する際に実行する。詳しくはプラグイン API/フィルターフック一覧、manage_$post_type_posts_columns フィルター（カスタム投稿タイプ用カスタムカラムの追加）の項を参照。
- アクション関数引数: カラム名、投稿 ID
- mce_options / en
- リッチテキストエディター用に出力された、JavaScript 設定リストの最後で実行する。
- password_reset / en
- ユーザーのパスワードがランダムな新パスワードにリセットされる前に実行する。
- personal_options_update / en
- ユーザーが管理画面から個人設定を更新した際に実行する。
- plugins_loaded / en
- すべてのプラグインが読み込まれた後に実行する。
- profile_personal_options / en
- ユーザープロフィールページの個人設定編集部分が読み込まれる終盤で実行する。
- profile_update / en
- ユーザープロフィールが更新された際に実行する。
- アクション関数引数: ユーザー ID
- quick_edit_custom_box / en
- クイック編集エディターを作成する際に不明なカラム名が存在する際に実行する。
- register_form / en
- 新規ユーザー登録フォームの終わり直前で実行する。
- register_post / en
- 新規ユーザー登録リクエストが処理される前に実行する。
- restrict_manage_posts / en
- 管理画面で編集する投稿の一覧が出力される前に実行する。
- retrieve_password / en
- リマインダーメールを送信するためにユーザーのパスワードを取得した際に実行する。
- アクション関数引数: ユーザーのログイン名
- set_current_user / en
- デフォルトの wp_set_current_user() 関数で、ユーザーが変更された後に実行する（この関数はプラグインによる上書きが可能。詳しくはプラグイン API を参照）。
- show_user_profile / en
- ユーザープロフィール編集画面が読み込まれる終盤で実行する。
- sidebar_admin_page / en
- ウィジェット管理画面のメインコンテンツの後で実行する。
- sidebar_admin_setup / en
- 編集しているウィジェットがサイドバーに表示された際に最初に実行する。
- simple_edit_form / en
- 詳細設定のセクションが含まれない「シンプルモード」記事投稿フォームの終盤で実行する。デフォルトではシンプルモードフォームが使われるのはブックマークレットからの投稿のみ。
- update_option_オプション名 / en
- update_option() 関数でブログの設定を更新した後に実行する。例えば "foo" という設定が更新された場合にアクションを加えたい場合は、'update_option_foo' というアクションフックを定義する。
- アクション関数引数: 古い設定値、新しい設定値
- update_option / en
- オプションがデータベースで更新される前に実行する。
- updated_option / en
- オプションが更新された後に実行する。
- upload_files_タブ / en
- アップロードファイル管理画面を出力する際に実行する。タブ名にはカスタムアクションのタブ名を入れ、wp_upload_tabs フィルターでカスタムタブを定義する。詳しくはプラグイン API/フィルターフック一覧、wp_upload_tabs の項を参照。
- user_new_form / en
- ユーザー新規追加画面の最後に実行する。
- アクション関数引数: マルチサイトでは "add-existing-user" という文字列を、シングルサイトまたは特権管理者に対しては "add-new-user" という文字列を渡す。
- user_profile_update_errors / en
- 更新されたユーザー情報の詳細がデータベースにコミットされる直前に実行する。
- wpmu_new_user / en
- マルチサイト環境で最初にユーザーのプロフィールが作成された際に実行する。マルチサイトではない場合、user_register を使うこと。
- アクション関数引数: ユーザー ID
- user_register / en
- ユーザーのプロフィールを新規追加する際に実行する。
- アクション関数引数: ユーザー ID
- welcome_panel / en
- ダッシュボードの「ウェルカム」画面を非表示にする。これはスマートなフィルタでもあり、関連する表示オプションも非表示にしてくれる。
- wp_ajax_アクション名 / en
- 不明なタイプの AJAX リクエストハンドラを行うために実行する。wp_ajax_nopriv_(action) も参照。
- wp_authenticate / en
- ユーザーのログイン認証時に実行する。
- アクション関数引数: ユーザー名とパスワードの配列
ダッシュボード「現在の状況」ウィジェットアクション
- right_now_content_table_end / en
- 「現在の状況」ダッシュボードウィジェットの下にテーブル行を追加する。
- right_now_table_end
- スパムコメント数が「現在の状況」ウィジェットのディスカッションカラムに表示された後に呼び出される。
- right_now_discussion_table_end
- スパムコメント数が表示された後、さらに「現在の状況」ウィジェットのディスカッションカラムで right_now_table_end アクションの後に呼び出される。
- right_now_end
- 現在のバージョン情報が「現在の状況」ウィジェット上に表示された直後に呼び出される。注: バージョン3.4で、rightnow_end になっている。チケット #21046 を参照。
- activity_box_end / en
- 「現在の状況」ウィジェットで呼び出される最後のアクション。
その他の高度なアクション
このセクションでは、表示する投稿を判断するクエリ、WordPressループ、プラグインの有効化など、WordPressの基本的なコードに関連する高度なアクションを紹介しています。
- activated_plugin / en
- プラグインの有効化に成功した際に実行する。
- add_meta_boxes / en
- 投稿編集画面が読み込まれた際に実行する（バージョン3.0以降）。
- admin_menu / en
- 管理画面メニューの基本構造が配置された後に実行する。
- network_admin_notices / en
- 管理メニューがネットワーク管理画面に出力された後に実効する。
- user_admin_notices / en
- 管理メニューがユーザー管理画面に出力された後に実効する。
- admin_notices / en
- ネットワーク管理画面・ユーザー管理画面を除く管理画面メニューがページに出力された後に実行する。
- all_admin_notices / en
- 管理メニューがすべての画面に出力された後に実効する。
- blog_privacy_selector / en
- デフォルトのブログプライバシー設定がページに出力された後に実行する。
- check_admin_referer / en
- デフォルトの check_admin_referrer() 関数内で、セキュリティ用に nonce（セッションをユニークにするための暗号化に使われる乱数）を確認した後に実行する（この関数はプラグインによる上書きが可能。詳しくはプラグイン API を参照）。
- check_ajax_referer / en
- ユーザーのログイン IDとパスワードが Cookie によって認証された後、デフォルトの check_ajax_referer() 関数は wp-admin/admin-ajax.php スクリプトに対して AJAX リクエストがあった場合に呼び出される（この関数はプラグインによる上書きが可能。詳しくはプラグイン API を参照）。
- customize_register / en
- すべてのリクエストで実行する。開発者は新規のテーマのオプションを登録し、Theme Customization API を使用して制御できる (Version 3.4)。
- deactivated_plugin / en
- プラグインの無効化に成功した際に実行する。
- generate_rewrite_rules / en
- URL リライトルールが生成された後に実行する。
- アクション関数引数: WP_Rewrite クラスの変数リスト
- 注: リライトルールを修正するには、このアクションよりも rewrite_rules_array フィルターの方が使いやすい。
- loop_start / en
- 最初の WordPress ループが処理される前に実行する。
- network_admin_menu / en
- ネットワーク管理画面で基本的なメニュー構造の用意ができた際に実行する（管理メニュー）。
- parse_query / en
- クエリ解析の終盤で実行する。
- アクション関数引数: $wp_queryオブジェクトの内容（リスト形式）
- parse_request / en
- クエリリクエストが wp 関数内で解析された後に実行する。
- アクション関数引数: $wp オブジェクトへの参照を含む配列
- pre_get_posts / en
- the main query /the main query|en または WP_Query, such as query_posts()、get_posts()、get_children()などのようなインスタンス内でクエリが実行される前に実行する。このフックはクエリ変数オブジェクトが生成された後、クエリが実際に実行される前に実行される。プライマリクエリが実行される前に変更するのに使える。is_main_query() も参照。
- アクション関数引数: $wp_query オブジェクトの内容（リスト形式）
- sanitize_comment_cookies / en
- HTTPリクエストからCookieが読み取られた後に実行する。
- send_headers / en
- wp 関数内でHTTPヘッダーが送信された後に実行する。
- アクション関数引数: グローバル $wp オブジェクトへの参照がある配列
- update_(meta_type)_meta / en
- メタ情報が保存される際に実行する。
- updated_(meta_type)_meta / en
- メタ情報が更新される際に実行する。
- upgrader_process_complete / en
- プラグインダウンロード・アップグレードツールの動作が終了した際に実行する。
- wp / en
- wp 関数内でクエリが解析されて投稿が読み込まれ、テンプレートが実行されるまでの間に実行する。出力にテンプレートを必要しないデータにアクセスする場合に活用できる。
- アクション関数引数: $wp オブジェクトへの参照を含む配列
これも読んでみよう
- プラグインの作成 - プラグイン作成方法の説明
- プラグイン API - フィルターやアクションの使い方に関する記事
- プラグイン・リソース - プラグインに関するリソースの総合的な一覧
- WordPress Hooks Database WordPress フックすべてのデータベース。どのバージョンから存在するかや、フックが使われる部分のソースコードへのリンク。
このページ「プラグイン API/アクションフック一覧」は 一部未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています。
最新英語版： WordPress Codex » Plugin API/Action Reference （最新版との差分）
