典型リクエスト中に実行されるアクション
これらのアクションは、ログインしたユーザーがホームページを開くときに呼び出されます。このリストは古くなっている可能性があります。このリストは、各アクションが呼び出される最初の回のみを示す場合があり、多くの場合、アクションにフックされている関数はありません。テーマやプラグインによって、リクエスト中にアクションが複数回呼び出されることがあります。この証拠として、リストには Twenty Eleven テーマに特有のアクション呼び出しが表示されます。ユーザーがサイトを訪れると、Cronタスクも発火し、追加のアクション呼び出しが行われることがあります。このリストは、WordPressのアクション実行順序のガイドラインまたは近似値として見るべきであり、具体的な仕様ではありません。
アクションは、関数 do_action()
で呼び出されますが、(ref array) とマークされたものは、関数 do_action_ref_array()
で呼び出されます。
muplugins_loaded | 必須プラグインが読み込まれた後。 |
registered_taxonomy | カテゴリ、post_tag、etc. 用。 |
registered_post_type | 投稿、ページ、etc. 用。 |
plugins_loaded | アクティブなプラグインが読み込まれた後、プラグイン可能な関数の前。 |
sanitize_comment_cookies | コメントクッキーがサニタイズされるとき。 |
setup_theme | テーマが読み込まれる前。 |
load_textdomain | default ドメイン用 |
after_setup_theme | 一般的にテーマ設定/オプションを初期化するために使用されます。これは テーマに利用可能な最初のアクションフック であり、アクティブテーマの functions.php ファイルが読み込まれた直後にトリガーされます。add_theme_support() はここで呼び出されるべきです。init アクションフックは、いくつかの機能を追加するには遅すぎます。この段階では、現在のユーザーはまだ認証されていません。 |
auth_cookie_malformed | |
auth_cookie_valid | |
set_current_user | |
init | 通常、プラグインによって初期化に使用されます。この時点で、現在のユーザーはすでに認証されています。 |
└─ widgets_init | サイドバーを登録するために使用されます。‘init’ プライオリティ 1 で発火します(したがって、プライオリティ ≥ 1 の ‘init’ アクションの前に!) |
register_sidebar | 各サイドバーおよびフッターエリア用 |
wp_register_sidebar_widget | 各ウィジェット用 |
wp_default_scripts | (ref array) |
wp_default_styles | (ref array) |
admin_bar_init | |
add_admin_bar_menus | |
wp_loaded | WordPressが完全に読み込まれた後 |
parse_request | HTTPリクエスト処理の操作を許可します (ref array) |
send_headers | HTTPヘッダーのカスタマイズを許可します (ref array) |
parse_query | クエリ変数が設定された後 (ref array) |
pre_get_posts | クエリが実行される前にクエリ変数オブジェクトを公開します。(ref array) |
posts_selection | キャッシングプラグインによって使用されます。 |
wp | WPオブジェクトが設定された後 (ref array) |
template_redirect | どのテンプレートを読み込むかを決定する前。 |
get_header | ヘッダーテンプレートファイルが読み込まれる前。 |
wp_enqueue_scripts | スクリプトとスタイルがキューに追加されるとき。 |
twentyeleven_enqueue_color_scheme | (Twenty Elevenに特有) |
wp_head | フロントエンドのヘッダータグにスクリプトまたはデータを印刷するために使用されます。 |
wp_print_styles | $handles キュー内のスタイルが印刷される前。 |
wp_print_scripts | $handles キュー内のスクリプトが印刷される前。 |
get_search_form | |
loop_start | (ref array) |
the_post | (ref array) クエリの直後に投稿オブジェクトを変更することを許可します |
get_template_part_content | コンテンツのためのテンプレートパート |
loop_end | (ref array) |
get_sidebar | サイドバーテンプレートファイルが読み込まれる前。 |
dynamic_sidebar | ウィジェットの表示コールバックが呼び出される前。 |
get_search_form | |
pre_get_comments | (ref array) |
wp_meta | サイドバーにエコーされたコンテンツを表示する前。 |
get_footer | フッターテンプレートファイルが読み込まれる前。 |
get_sidebar | サイドバーテンプレートファイルが読み込まれる前。 |
twentyeleven_credits | (Twenty Elevenに特有) |
wp_footer | どのテンプレートを読み込むかを決定する前。 |
wp_print_footer_scripts | フッターのスクリプトが印刷されるとき。 |
admin_bar_menu | (ref array) |
wp_before_admin_bar_render | 管理バーがレンダリングされる前。 |
wp_after_admin_bar_render | 管理バーがレンダリングされた後。 |
shutdown | PHPの実行が終了しようとしている前。 |
## 管理ページリクエスト中に実行されるアクション
これらのアクションは、ログインしたユーザーが Posts ページを開くときに実行されます。このリストは、アクションが呼び出される最初の回のみを示し、多くの場合、アクションにフックされている関数はありません。各管理ページは、ページの目的やインストールされているプラグインに応じて異なるアクションのリストを持っています。このリストは、ガイドラインまたは近似値として見るべきであり、具体的な仕様ではありません。
これらのアクションでは、(hookname)
はページに依存します。投稿ページの場合は edit.php、テーマの背景ページの場合は appearance_page_custom-background
です。
アクションは、関数 do_action()
で呼び出されますが、(ref array) とマークされたものは、関数 do_action_ref_array()
で呼び出されます。
| | |
| —- | —- |
| muplugins_loaded | 必須プラグインが読み込まれた後 |
| registered_taxonomy | カテゴリ、post_tag、etc. 用 |
| registered_post_type | 投稿、ページ、etc. 用 |
| plugins_loaded | アクティブなプラグインとプラグイン可能な関数が読み込まれた後 |
| sanitize_comment_cookies | |
| setup_theme | |
| load_textdomain | ドメイン default
用 |
| after_setup_theme | この段階では、現在のユーザーはまだ認証されていません。 |
| load_textdomain | ドメイン twentyeleven
用 |
| auth_cookie_valid | |
| set_current_user | |
| init | 通常、プラグインによって初期化に使用されます。この時点で、現在のユーザーはすでに認証されています。 |
| └─ widgets_init | サイドバーを登録するために使用されます。これは ‘init’ で発火し、プライオリティは 1 です。 |
| register_sidebar | 各サイドバー用 |
| wp_register_sidebar_widget | 各ウィジェット用 |
| wp_default_scripts | (ref array) |
| wp_default_styles | (ref array) |
| admin_bar_init | |
| add_admin_bar_menus | |
| wp_loaded | WordPressが完全に読み込まれた後 |
| auth_cookie_valid | |
| auth_redirect | |
| _admin_menu | 参照: _user_admin_menu、_network_admin_menu |
| admin_menu | 参照: user_admin_menu、network_admin_menu |
| admin_init | |
| current_screen | |
| load-{$page_hook} | |
| send_headers | カスタムHTTPヘッダーを追加できる場所 |
| pre_get_posts | クエリが実行される前にクエリ変数オブジェクトを公開します。(ref array) |
| posts_selection | |
| wp | WPオブジェクトが設定された後 (ref array) |
| admin_xml_ns | |
| admin_xml_ns | |
| admin_enqueue_scripts | |
| admin_print_styles-{$hook_suffix} | |
| admin_print_styles | |
| admin_print_scripts-{$hook_suffix} | |
| admin_print_scripts | |
| wp_print_scripts | |
| admin_head-{$hook_suffix} | |
| admin_head | |
| admin_menu | |
| in_admin_header | |
| admin_notices | |
| all_admin_notices | |
| restrict_manage_posts | |
| the_post | (ref array) |
| pre_user_query | (ref array) |
| in_admin_footer | |
| admin_footer | |
| admin_bar_menu | (ref array) |
| wp_before_admin_bar_render | |
| wp_after_admin_bar_render | |
| admin_print_footer_scripts | |
| admin_footer-{$hook_suffix} | 管理ページのフッター |
| shutdown | PHPの実行が終了しようとしている |
| wp_dashboard_setup | 管理ダッシュボードのカスタマイズを許可します。
投稿、ページ、添付ファイル、およびカテゴリアクション(管理)
post_submitbox_misc_actions : 編集ページが生成されるときに実行され、送信ボックス(公開ボタンが表示される場所)にいくつかのコンテンツ(例:フィールド)を追加します。関数引数はありません。
add_attachment : 添付ファイルが最初にデータベースに追加されるときに実行されます。アクション関数引数:添付ファイルID。
add_category : create_category
と同じです。
{$taxonomy}_add_form_fields : 管理でタクソノミー追加フォームが作成されるときに実行されます。送信ボタンの前にこのフォームにフィールドを追加するのに便利です。例えば category_add_form_fields
。
{$taxonomy}_edit_form : 管理でタクソノミー用語編集フォームが作成されるときに実行されます。このフォームに新しいフィールドを追加するのに便利です。
clean_post_cache : 投稿キャッシュがクリアされるときに実行されます。アクション関数引数:投稿ID。 clean_post_cache()
を参照してください。
create_{$taxonomy} : 新しいタクソノミー用語が作成されるときに実行されます。アクション関数引数:用語ID。
delete_attachment : 添付ファイルがデータベースから削除される直前に実行されます。アクション関数引数:添付ファイルID。
delete_{$taxonomy} : タクソノミー用語がデータベースから削除された直後に実行され、その対応するリンク/投稿が用語を削除するように更新されます。アクション関数引数:用語ID。
wp_trash_post : 投稿またはページがゴミ箱に入れられようとするときに実行されます。アクション関数引数:投稿またはページID。
trashed_post : 投稿またはページがゴミ箱に入れられた直後に実行されます。アクション関数引数:投稿またはページID。
untrash_post : 復元されるとき、投稿またはページが削除される直前に実行されます。アクション関数引数:投稿またはページID。
untrashed_post : 復元された直後に実行されます。アクション関数引数:投稿またはページID。
before_delete_post : 投稿またはページが削除されようとするときに実行されます。コメント、添付ファイル、メタデータはまだ利用可能です。アクション関数引数:投稿またはページID。
delete_post : 投稿またはページが削除されようとするときに実行されます。コメント、添付ファイル、メタデータはすでに削除されています。アクション関数引数:投稿またはページID。
deleted_post : 投稿またはページが削除された直後に実行されます。アクション関数引数:投稿またはページID。
edit_attachment : 添付ファイルがデータベースに編集/更新されるときに実行されます。アクション関数引数:添付ファイルID。
edit_category : カテゴリが更新/編集されるときに実行されます。投稿またはブログロールリンクが追加/削除されるときや、そのカテゴリが更新されるとき(カテゴリのカウントが更新される原因となります)。アクション関数引数:カテゴリID。
edit_post : 投稿またはページが更新/編集されるときに実行されます。コメントが追加または更新されるとき(投稿のコメントカウントが更新される原因となります)。アクション関数引数:投稿またはページID。
pre_post_update : 投稿またはページが更新される直前に実行されます。アクション関数引数:投稿またはページID。
post_updated : 投稿またはページが更新された後に実行されます。アクション関数引数:投稿またはページID、更新前と更新後の WP_Post オブジェクト。
transition_post_status : 任意の投稿ステータス遷移が発生したときに実行されます。アクション関数引数:$new_status
、$old_status
、$post
オブジェクト。(投稿ステータス遷移 も参照してください。)
(古いステータス)から(新しいステータス) : 投稿が $old_status
から $new_status
にステータスを変更するときに実行されます。アクション関数引数:$post
オブジェクト。(投稿ステータス遷移 も参照してください。)
{$newstatus}{$post-
→post_type} : 投稿タイプ $post_type
の投稿が他のステータスから $status
に遷移するときに実行されます。アクション関数引数:投稿ID、$post object
。(投稿ステータス遷移 も参照してください。)
publish_post (非推奨ではない) : 投稿が公開されるとき、または編集されてそのステータスが「公開」に変更されるときに実行されます。このアクションフックは、{$newstatus}{$post-
→post_type} アクションフックタイプに準拠しています。アクション関数引数:投稿ID、$post object
。(投稿ステータス遷移 も参照してください。)
publish_page : ページが公開されるとき、または編集されてそのステータスが「公開」に変更されるときに実行されます。このアクションフックは、{$newstatus}{$post-
→post_type} アクションフックタイプに準拠しています。アクション関数引数:投稿ID、$post object
。(投稿ステータス遷移 も参照してください。)
publish_phone : 投稿がメールで追加された直後に実行されます。アクション関数引数:投稿ID。
save_post : 投稿またはページが作成または更新されるたびに実行されます。これはインポート、投稿/ページ編集フォーム、xmlrpc、またはメールによる投稿からのものである可能性があります。アクション関数引数:投稿IDと投稿オブジェクト。データがデータベースに保存された後に実行されます。投稿IDは投稿のリビジョンを参照する場合があり、最後に保存された投稿ではないことに注意してください。実際の投稿のIDを取得するには wp_is_post_revision()
を使用します。
updated_postmeta : メタデータが更新されたときに実行されます。
wp_insert_post : save_post
と同じで、すぐにその後に実行されます。
xmlrpc_publish_post : 投稿がXMLRPCリクエストを介して公開されるとき、またはXMLRPCを介して編集されてそのステータスが「公開」に変更されるときに実行されます。アクション関数引数:投稿ID。
タクソノミーと用語
create_term : 新しい用語が作成された後、用語キャッシュがクリアされる前に実行されます。
created_term : 新しい用語が作成された後、用語キャッシュがクリアされた後に実行されます。
create_$taxonomy : 特定のタクソノミーのために新しい用語が作成された後に実行されます。
created_$taxonomy : 特定のタクソノミーで新しい用語が作成された後、用語キャッシュがクリアされた後に実行されます。
add_term_relationship (バージョン 2.9.0 以降) : オブジェクト-用語関係が追加される前に実行されます。
added_term_relationship (バージョン 2.9.0 以降) : オブジェクト-用語関係が追加された後に実行されます。
set_object_terms (バージョン 2.8.0 以降) : オブジェクトの用語が設定された後に実行されます。
edit_terms (バージョン 2.9.0 以降) : 指定された用語が編集される前に実行されます。
edited_terms : データベースにタクソノミー/カテゴリの変更が保存された後に実行されます。
edit_term_taxonomy : 用語-タクソノミー関係が更新される前に実行されます。
edited_term_taxonomy : 用語-タクソノミー関係が更新された後に実行されます。
edit_term_taxonomies (バージョン 2.9.0 以降) : 削除する用語の子が親に再割り当てされる前に実行されます。
edited_term_taxonomies (バージョン 2.9.0 以降) : 削除する用語の子が親に再割り当てされた後に実行されます。
edit_$taxonomy : 特定のタクソノミーのために用語が編集された後に実行されます。
edited_$taxonomy : 特定のタクソノミーで用語が編集された後、用語キャッシュがクリアされた後に実行されます。
pre_delete_term (バージョン 4.1.0 以降) : 投稿または用語に対する変更が行われる前に実行されます。
delete_term_taxonomy (バージョン 2.9.0 以降) : 用語タクソノミーIDがデータベースから削除される前に実行されます(子の用語を変更した後)。
deleted_term_taxonomy (バージョン 2.9.0 以降) : 用語タクソノミーIDが削除された後に実行されます。
delete_term (バージョン 2.5.0 以降) : 用語がデータベースから削除され、キャッシュがクリアされた後に実行されます。(パラメータ:$Term_ID, $Term_taxonomy_ID, $Taxonomy_slug, $already_deleted_term)
delete_$taxonomy (バージョン 2.3.0 以降) : 特定のタクソノミーで用語が削除された後に実行されます。(パラメータ:$Term_ID, $Term_taxonomy_ID, $already_deleted_term)
delete_term_relationships (バージョン 2.9.0 以降) : オブジェクト-用語関係が削除される前に実行されます。
deleted_term_relationships (バージョン 2.9.0 以降) : オブジェクト-用語関係が削除された後に実行されます。
clean_object_term_cache (バージョン 2.5.0 以降) : オブジェクト用語キャッシュがクリアされた後に実行されます。
clean_term_cache (バージョン 2.5.0 以降) : 各タクソノミーの用語キャッシュがクリアされた後に実行されます。
split_shared_term (バージョン 4.2.0 以降) : 以前に共有されたタクソノミー用語が2つの別々の用語に分割された後に実行されます。
preterm{$field} : タクソノミー用語のデータがデータベースに保存される前に実行されます。例えば、pre_term_description
。
pre{$taxonomy}{$field} : 用語のフィールドがデータベースに保存される前に実行されます。例えば、pre_category_description
。
コメント、ピン、トラックバックアクション
comment_closed : コメントの入力フォームを表示しようとしたときに、投稿がコメントを許可しないとマークされた場合に実行されます。アクション関数の引数:投稿ID。
comment_id_not_found : コメントまたはコメント入力フォームを表示しようとしたときに、投稿IDが見つからない場合に実行されます。アクション関数の引数:投稿ID。
comment_flood_trigger : コメントの洪水が検出されたときに実行され、wp_die
が呼び出されてコメントの受け入れを停止する直前です。アクション関数の引数:前のコメントの時間、現在のコメントの時間。
comment{$old_status}*_to*{$new_status} : コメントのステータス遷移が発生したときに実行されます。アクション関数の引数:コメントオブジェクト。
comment_on_draft : コメント入力フォームまたはコメントを表示しようとしたときに、投稿がドラフトである場合に実行されます。アクション関数の引数:投稿ID。
comment_post : コメントがデータベースに保存された直後に実行されます。アクション関数の引数:コメントID、承認ステータス(「スパム」または0/1で不承認/承認)。
edit_comment : コメントがデータベースで更新/編集された後に実行されます。アクション関数の引数:コメントID。
delete_comment : コメントがデータベースから削除される直前に実行されます。アクション関数の引数:コメントID。
deleted_comment : コメントがデータベースから削除された直後に実行されます。アクション関数の引数:コメントID。
trash_comment : コメントがゴミ箱に送信される直前に実行されます。アクション関数の引数:コメントID。
trashed_comment : コメントがゴミ箱に送信された直後に実行されます。アクション関数の引数:コメントID。
untrash_comment : コメントがゴミ箱から復元される直前に実行されます。アクション関数の引数:コメントID。
untrashed_comment : コメントがゴミ箱から復元された直後に実行されます。アクション関数の引数:コメントID。
spam_comment : コメントがスパムとしてマークされる直前に実行されます。アクション関数の引数:コメントID。
spammed_comment : コメントがスパムとしてマークされた直後に実行されます。アクション関数の引数:コメントID。
unspam_comment : コメントがスパムとしてのマークを解除される直前に実行されます。アクション関数の引数:コメントID。
unspammed_comment : コメントがスパムとしてのマークを解除された直後に実行されます。アクション関数の引数:コメントID。
pingback_post : 投稿にピンが追加されたときに実行されます。アクション関数の引数:コメントID。
pre_ping : ピンが完全に処理される前に実行されます。アクション関数の引数:処理される投稿リンクの配列、および投稿の「pung」設定。
trackback_post : 投稿にトラックバックが追加されたときに実行されます。アクション関数の引数:コメントID。
wp_blacklist_check : コメントがブラックリストに登録されるべきかどうかを確認するために実行されます。アクション関数の引数:著者名、著者メール、著者URL、コメントテキスト、著者IPアドレス、著者のユーザーエージェント(ブラウザ)。あなたの関数は、コメントを拒否するためにwp_die
を実行するか、WordPressオプションに設定されたブラックリストキーワードの1つを含むように入力引数の1つを変更することができます。
wp_insert_comment : コメントが作成されるたびに実行されます。
wp_set_comment_status : コメントのステータスが変更されるときに実行されます。アクション関数の引数:コメントID、新しいステータスを示すステータス文字列(「削除」、「承認」、「スパム」、「保留」)。
ブログロールアクション
add_link : 新しいブログロールリンクが最初にデータベースに追加されたときに実行されます。アクション関数の引数:リンクID。
delete_link : ブログロールリンクが削除されたときに実行されます。アクション関数の引数:リンクID。
edit_link : ブログロールリンクが編集されたときに実行されます。アクション関数の引数:リンクID。
フィードアクション
atom_entry : 各ブログエントリのアトムフィードでエントリ情報が印刷された直後に実行されます(ただし、エントリタグを閉じる前)。
atom_head : アトムフィードでブログ情報が印刷された直後に実行されます。最初のエントリの前です。
atom_ns : アトムフィードのルートXML要素内で実行されます(名前空間を追加するため)。
commentrss2_item : コメントフィードで単一のコメント情報が印刷された直後に実行されます(ただし、アイテムタグを閉じる前)。アクション関数の引数:コメントID、投稿ID。
dofeed{$feed} : フィードが生成されるときに実行されます。feedはフィードのタイプ(rss2, atom, rdf
など)です。フィードを印刷する前に優先度を10未満に設定します。アクション関数の引数:true(フィードはコメント用)またはfalse(投稿用)。
rdf_header : RDFフィードでブログ情報が印刷された直後に実行されます。最初のエントリの前です。
rdf_item : 各ブログエントリのRDFフィードでエントリ情報が印刷された直後に実行されます(ただし、アイテムタグを閉じる前)。
rdf_ns : RDFフィードのルートXML要素内で実行されます(名前空間を追加するため)。
rss_head : RSSフィードでブログ情報が印刷された直後に実行されます。最初のエントリの前です。
rss_item : 各ブログエントリのRSSフィードでエントリ情報が印刷された直後に実行されます(ただし、アイテムタグを閉じる前)。
rss2_head : RSS 2フィードでブログ情報が印刷された直後に実行されます。最初のエントリの前です。
rss2_item : 各ブログエントリのRSS 2フィードでエントリ情報が印刷された直後に実行されます(ただし、アイテムタグを閉じる前)。
rss2_ns : RSS 2フィードのルートXML要素内で実行されます(名前空間を追加するため)。
テンプレートアクション
after_setup_theme : テーマの初期化中に実行されます。一般的に、テーマの基本設定、登録、および初期化アクションを実行するために使用されます。
comment_form : comment_form()によってレンダリングされたコメントフォームの下部で実行されます。閉じる直前です。
comment_form_after : comment_form()によってレンダリングされたコメントフォームの後に実行されます。閉じた直後です。
do_robots : テンプレートファイル選択者がrobots.txtリクエストであると判断したときに実行されます。
do_robotstxt : do_robots()
関数内で、robots.txtファイルのDisallowリストを印刷する前に実行されます。
get_footer : テンプレートがget_footer()
関数を呼び出すときに実行されます。footer.php
テンプレートファイルが読み込まれる直前です。
get_header : テンプレートがget_header()
関数を呼び出すときに実行されます。header.php
テンプレートファイルが読み込まれる直前です。
switch_theme : ブログのテーマが変更されたときに実行されます。アクション関数の引数:新しいテーマの名前。テーマ内で使用される場合、アクションを追加するテーマが無効にされている場合にのみ機能します。
after_switch_theme : ブログのテーマが変更されたときに実行されます。アクション関数の引数:新しいテーマの名前。テーマ内で使用される場合、アクションを追加するテーマが有効にされている場合にのみ機能します。テーマを有効にするときに特定のコードを実行するために使用できます。
load-themes.php : テーマがアクティブまたは非アクティブになるときに実行されます(他のものに置き換えられます)。
template_redirect : リクエストされたページを表示するために使用されるテンプレートファイルの決定の前に実行されます。
wp_footer : テンプレートがwp_footer()
関数を呼び出すときに実行されます。一般的にブログページの下部近くで実行されます。
wp_head : テンプレートがwp_head()
関数を呼び出すときに実行されます。このフックは、ページテンプレートの上部近くに配置されることが一般的です。
wp_meta : sidebar.phpテンプレートファイルがwp_meta()
関数を呼び出すときに実行されます。プラグインがサイドバーにコンテンツを挿入できるようにします。
wp_print_scripts : WordPressが登録されたJavaScriptスクリプトをページヘッダーに印刷する直前に実行されます。
管理アクション
activate_{$plugin} : プラグインが最初にアクティブ化されたときに実行されます。Function_Reference/register_activation_hookを参照してください。
activity_box_end : 管理ダッシュボード画面のアクティビティボックスの最後で実行されます。
add_category_form_pre : 管理メニューでカテゴリ追加フォームが画面に表示される前に実行されます。
addoption{$option} : add_option()関数によってWordPressオプションが追加された後に実行されます。アクション関数の引数:オプション名、オプション値。応答したい特定のオプションに対してアクションを追加する必要があります。たとえば、「add_option_foo」を使用してオプション「foo」が追加されたときに応答します。
add_option : オプションがデータベースに追加される前に実行されます。
added_option : オプションが追加された後に実行されます。
admin_head : HTML内で実行されます。
admin_head-{$hook_suffix} : HTML内で実行されます。
admin_init : ページがレンダリングされる前のすべての管理ページの最初に実行されます。wp-admin/admin.php、wp-admin/admin-post.php、およびwp-admin/admin-ajax.phpを参照してください。
adminpost{$action} : adminpost_nopriv{$action} – 未指定のGETまたはPOSTリクエストのハンドラーを実行します。
admin_footer : 管理パネルのボディタグ内の最後で実行されます。
admin_enqueue_scripts : プラグインまたはテーマがすべての管理ページにJavaScriptおよびCSSをエンキューできるように、HTMLヘッダー内で実行されます。
admin_print_scripts : プラグインがすべての管理ページにJavaScriptスクリプトを追加できるように、HTMLヘッダー内で実行されます。
admin_print_scripts-{$hook_suffix} : 特定のプラグイン生成の管理ページのHTMLヘッドセクションにJavaScriptスクリプトを印刷するために実行されます。(page_hook)は、管理メニューにプラグインメニュー項目を追加する関数を使用する際に返されます: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 : プラグインがすべての管理ページにCSS/スタイルシートを追加できるように、HTMLヘッダー内で実行されます。
admin_print_styles-{$hook_suffix} : 特定の管理ページに対してwp_enqueue_style()
でスタイルをエンキューする必要があるときに実行されます。関数の戻り値を使用して(page_hook)の値を決定します。
check_passwords : 新しいユーザーを作成するときにパスワードの二重入力を検証するために実行されます。アクション関数の引数:ログイン名、最初のパスワード、2番目のパスワードの配列。
dbx_post_advanced : 管理メニューのページ編集画面の「詳細」セクションの下部で実行されます。
dbx_post_sidebar : 管理メニューのページ編集画面のサイドバーの下部で実行されます。
dbx_post_advanced : 管理メニューの投稿編集画面の「詳細」セクションの下部で実行されます。
dbx_post_sidebar : 管理メニューの投稿編集画面のサイドバーの下部で実行されます。WordPress 2.5以降ではadd_meta_box()
を使用します。
deactivate_{$plugin} : プラグインが非アクティブ化されたときに実行されます。
deleteoption{$option} : delete_option()関数によってWordPressオプションが削除された後に実行されます。アクション関数の引数:オプション名。応答したい特定のオプションに対してアクションを追加する必要があります。たとえば、「delete_option_foo」を使用してオプション「foo」が削除されたときに応答します。
delete_option : オプションがデータベースから削除される前に実行されます。
deleted_option : オプションが削除された後に実行されます。
delete_user : ユーザーが削除されたときに実行されます。アクション関数の引数:ユーザーID。
edit_category_form : カテゴリの追加/編集フォームが画面に表示された後に実行されます(ただし、HTMLフォームタグの終了前)。
edit_category_form_pre : 編集カテゴリフォームが管理メニューに表示される前に実行されます。
edit_tag_form : タグの追加/編集フォームが画面に表示された後に実行されます(ただし、HTMLフォームタグの終了前)。
edit_tag_form_pre : 編集タグフォームが管理メニューに表示される前に実行されます。
edit_form_top : WordPress投稿編集画面(およびカスタム投稿タイプ)のタイトルの前にフォーム内で実行されますが、初期の隠しフィールド(user_ID、actionなど)の後です。
edit_form_after_title : WordPress投稿編集画面(およびカスタム投稿タイプ)のタイトルの後に実行されますが、WordPressのコンテンツエリアの前です。
edit_form_after_editor : WordPress投稿エディタの直後に実行されますが、他のすべてのメタボックスの前です。カスタム投稿タイプでも利用可能です。
edit_form_advanced : 管理メニューの投稿編集フォームの「詳細」セクションの直前に実行されます。
edit_page_form : 管理メニューのページ編集フォームの「詳細」セクションの直前に実行されます。
edit_user_profile : 管理メニューのユーザープロファイル編集画面の最後近くで実行されます。
load-{$pagenow} : 管理メニューページが読み込まれたときに実行されます。このアクションは通常直接追加されません。管理メニューの追加方法の詳細についてはAdding Administration Menusを参照してください。直接使用する場合、add_options_page()
および類似の関数からの戻り値がアクション名の「(page)」部分を提供します。
login_form : ログインフォームの終了直前に実行されます。
login_head : ログインページのHTMLヘッドセクションの終了直前に実行されます。
lost_password : ログイン画面に「メールでパスワードを取得する」フォームが印刷される前に実行されます。
lostpassword_form : ユーザーのパスワードをメールで取得するために使用されるフォームの終了時に実行され、プラグインが追加のフィールドを提供できるようにします。
lostpassword_post : ユーザーがパスワードを取得するためのメールメッセージをリクエストしたときに実行され、プラグインが処理前にPHP $_POST
変数を変更できるようにします。
manage_link_custom_column : 管理画面で不明な列名があるときに実行されます。アクション関数の引数:列名、リンクID。Plugin API/Filter Referenceのフィルターid}_columnsも参照してください。カスタム列を追加します。
manage_posts_custom_column : 投稿管理管理画面で不明な列名があるときに実行されます。アクション関数の引数:列名、投稿ID。Plugin API/Filter Referenceのフィルターmanage_posts_columnsも参照してください。カスタム列を追加します。(例と使用についてはScomptのチュートリアルを参照してください。)
manage_pages_custom_column : ページ管理管理画面で不明な列名があるときに実行されます。アクション関数の引数:列名、ページID。Plugin API/Filter Referenceのフィルターmanage_pages_columnsも参照してください。カスタム列を追加します。
manage_media_custom_column : メディア管理管理画面で不明な列名があるときに実行されます。アクション関数の引数:列名、ページID。Plugin API/Filter Referenceのフィルターmanage_media_columnsも参照してください。カスタム列を追加します。
manage_{$post-
>post_type}_posts_custom_column : カスタム投稿タイプ管理画面で不明な列名があるときに実行されます。アクション関数の引数:列名、投稿ID。manage_{$post_type}_posts_columnsのフィルターも参照してください。カスタム投稿タイプのカスタム列を追加します。
password_reset : ユーザーのパスワードがランダムな新しいパスワードにリセットされる前に実行されます。
personal_options_update : ユーザーが管理画面から個人オプションを更新するときに実行されます。
plugins_loaded : すべてのプラグインが読み込まれた後に実行されます。
profile_personal_options : ユーザープロファイル編集画面の個人オプションセクションの最後で実行されます。
profile_update : ユーザープロファイルが更新されたときに実行されます。アクション関数の引数:ユーザーID。
quick_edit_custom_box : クイックエディタを作成するときに不明な列名があるときに実行されます。
register_form : 新しいユーザー登録フォームの終了直前に実行されます。
register_post : 新しいユーザー登録リクエストが処理される前に実行されます。
restrict_manage_posts : 編集する投稿のリストが管理メニューに表示される前に実行されます。
retrieve_password : ユーザーのパスワードが取得されるときに実行され、リマインダーメールを送信します。アクション関数の引数:ログイン名。
set_current_user : ユーザーがデフォルトのwp_set_current_user()
関数によって変更された後に実行されます。wp_set_current_user()
も「プラグ可能」な関数であり、プラグインがオーバーライドできることに注意してください。Plugin APIを参照してください。
show_user_profile : ユーザープロファイル編集画面の最後近くで実行されます。
sidebar_admin_page : ウィジェット管理ページのメインコンテンツの後に実行されます。
sidebar_admin_setup : サイドバーに表示されるウィジェットを編集するときに早い段階で実行されます。
updateoption{$option} : WordPressオプションがupdate_option()
関数によって更新された後に実行されます。アクション関数の引数:古いオプション値、新しいオプション値。応答したい特定のオプションに対してアクションを追加する必要があります。たとえば、「update_option_foo」を使用してオプション「foo」が更新されたときに応答します。
update_option : オプションがデータベースに更新される前に実行されます。
updated_option : オプションが更新された後に実行されます。
user_new_form : 「新規追加」ユーザー画面の終了近くで実行されます。アクション関数の引数:マルチサイトでは「add-existing-user」、シングルサイトおよびネットワーク管理者では「add-new-user」という文字列を渡します。
user_profile_update_errors : 更新されたユーザーの詳細がデータベースにコミットされる直前に実行されます。
wpmu_new_user : マルチサイト環境でユーザープロファイルが最初に作成されたときに実行されます。アクション関数の引数:ユーザーID。マルチサイトでない場合はuser_registerを使用します。
user_register : ユーザープロファイルが最初に作成されたときに実行されます。アクション関数の引数:ユーザーID。
welcome_panel : ダッシュボードでウェルカムパネルを非表示にすることを許可します。これはスマートフィルターでもあり、関連する画面オプションを非表示にします。
wpajax{$action} : wpajax_nopriv{$action} – 不明なタイプのAJAXリクエストハンドラーを実行します。
wp_authenticate : ユーザーがログインするときに認証を実行します。アクション関数の引数:ユーザー名とパスワードの配列。
wp_login : ユーザーがログインしたときに実行されます。
wp_logout : ユーザーがログアウトしたときに実行されます。
高度なアクション
このセクションには、WordPressが表示する投稿を特定するために使用するクエリ、WordPressループ、プラグインのアクティブ化、その他の基本的なWordPressコードに関連するアクションが含まれています。
activated_plugin : プラグインが正常にアクティブ化されるたびに実行されます。
add_meta_boxes : 「投稿を編集」ページが読み込まれるときに実行されます。(3.0+)
admin_menu : 基本的な管理パネルメニュー構造が整った後に実行されます。
network_admin_notices : 管理メニューがネットワーク管理画面に印刷された後に実行されます。
user_admin_notices : 管理メニューがユーザー管理画面に印刷された後に実行されます。
admin_notices : 管理メニューがネットワークまたはユーザー管理画面以外の画面に印刷された後に実行されます。
all_admin_notices : 管理メニューがすべての画面に印刷された後に実行されます。
blog_privacy_selector : デフォルトのブログプライバシーオプションが画面に印刷された後に実行されます。
check_admin_referer : セキュリティ目的でnonceがチェックされた後、デフォルトの check_admin_referrer()
関数内で実行され、プラグインがWordPressを強制終了させることができます。 check_admin_referrer
も「プラグイン可能」な関数であり、プラグインがオーバーライドできることに注意してください。詳細はPlugin APIを参照してください。
check_ajax_referer : ユーザーのログインとパスワードがクッキーから正常に検証された後、デフォルトの check_ajax_referer()
関数内で実行され、プラグインがWordPressを強制終了させることができます。 check_ajax_referer
も「プラグイン可能」な関数であり、プラグインがオーバーライドできることに注意してください。詳細はPlugin APIを参照してください。
customize_controls_enqueue_scripts : WPテーマカスタマイザーのカスタマイズコントロールが初期化された後にトリガーされ、そのアクション/コールバックが実行され、独自のスタイルとスクリプトがキューに追加されるので、このフックを使用してWPテーマカスタマイザー用の独自のスクリプトとスタイルを登録できます。Theme Customization API(バージョン3.4以降)で使用します。
customize_register : 各リクエストで実行され、開発者がTheme Customization API(バージョン3.4以降)で使用するための新しいテーマオプションとコントロールを登録できるようにします。
customize_preview_init : テーマカスタマイザー内でのみアセット(JavaScriptファイルなど)を直接キューに追加できます。Theme Customization API(バージョン3.4以降)で使用します。
deactivated_plugin : プラグインが正常に非アクティブ化されるたびに実行されます。
generate_rewrite_rules : リライトルールが生成された後に実行されます。アクション関数の引数:WP_Rewrite
オブジェクト($wp_rewrite
)を参照で。リライトルールを変更するには、このアクションの代わりにrewrite_rules_array
フィルターを使用する方が簡単です。
init : WordPressの読み込みが完了した後、ヘッダーが送信される前に実行されます。$_GETまたは$_POSTトリガーをインターセプトするのに便利です。
loop_end : WordPressループの最後の投稿が処理された後に実行されます。
loop_start : WordPressループの最初の投稿が処理される前に実行されます。
network_admin_menu : Network管理ページの基本メニュー構造が準備されるときに実行されます。 (管理メニュー)
parse_query : メインクエリまたはWP_Queryの任意のインスタンス(query_posts、get_posts、またはget_childrenなど)のクエリ解析の最後に実行されます。アクション関数の引数:WP_Query
オブジェクトを参照で。
parse_request : メインWordPress関数 wp
内でクエリリクエストが解析された後に実行されます。アクション関数の引数:WP
オブジェクト($wp)を参照で。
pre_get_posts : メインクエリまたはWP_Query
の任意のインスタンス(query_posts()
、get_posts()
、またはget_children()
など)でクエリが実行される前に実行されます。このフックは、クエリ変数オブジェクトが作成された後、実際にクエリが実行される前に呼び出され、実行される前にプライマリクエリを変更するために使用できます。詳細はis_main_query()
も参照してください。アクション関数の引数:WP_Query
オブジェクトを参照で。
sanitize_comment_cookies : HTTPリクエストからクッキーが読み取られた後に実行されます。
send_headers : メインWordPress関数 wp()
内で基本的なHTTPヘッダーが送信された後に実行されます。アクション関数の引数:WP
オブジェクト($wp)を参照で。
shutdown : ページ出力が完了したときに実行されます。
update_{$meta_type}_meta : メタデータが保存されるときに実行されます。
updated_{$meta_type}_meta : メタデータが更新されたときに実行されます。
upgrader_process_complete : プラグインダウンローダー/アップグレーダークラスの実行が完了したときに実行されます。
wp_loaded : WP、すべてのプラグイン、およびテーマが完全に読み込まれ、インスタンス化されたときにこのフックが発火します。
wp : クエリが解析され、投稿が読み込まれた後、テンプレートの実行の前にメインWordPress関数 wp()
内で実行されます。投稿データにアクセスする必要があるが、出力にテンプレートを使用できない場合に便利です。アクション関数の引数:WP
オブジェクト($wp
)を参照で。
管理者ログインアクション
このセクションには、WordPress管理ログインページが表示、認証、登録、パスワードのリセット、パスワードを忘れた場合、その他のユーザー処理を処理するために使用するアクションが含まれています。
login_init : ログインフォームが初期化されるときに発火します。
loginform{$action} : 指定されたログインフォームアクションの前に発火します。
login_enqueue_scripts : ログインページ用のスクリプトとスタイルをキューに追加します。
login_head : スクリプトがキューに追加された後、ログインページのヘッダーで発火します。
login_header : ボディタグが開かれた後、ログインページのヘッダーで発火します。
login_form : ログインフォームの「パスワード」フィールドの後に発火します。
lostpassword_post : パスワードリセットリクエストからエラーが返される前に発火します。
admin_email_confirm : 管理者メール確認フォームの前に発火します。
admin_email_confirm_form : 隠しフィールドの前に、admin-email-confirm-formフォームタグ内で発火します。
lost_password : パスワードを忘れたフォームの前に発火します。
lostpassword_form : 隠しフィールドの前に、lostpasswordフォームタグ内で発火します。
validate_password_reset : パスワードリセット手続きが検証される前に発火します。
resetpass_form : ユーザーパスワードリセットフォームの「強度インジケーター」メーターの後に発火します。
register_form : ユーザー登録フォームの「メール」フィールドの後に発火します。
user_request_action_confirmed : アカウントアクションがユーザーによって確認されたときにアクションフックを発火します。
login_footer : ログインページのフッターで発火します。
さらなる読み物
- Plugin Handbook – プラグインの書き方の説明
- Plugin API – フィルターとアクションの使用方法に関する記事
- Plugin API/Filter Reference – フィルターフックの参照リスト
- Plugin Resources – プラグイン関連リソースの包括的なリスト
- Hooks Database – 公式WordPressコードリファレンスのすべてのフックに関するドキュメント。
- WordPress Hooks Database – WordPressのすべてのフックのデータベースで、どのバージョンから来ているかを示し、それらを使用するソースコードの場所にリンクしています。