概要
has_action アクションは、WordPressのフックシステムの一部であり、特定のアクションフックに対して、どの関数が登録されているかを調べる機能を持っています。このアクションは、プラグインやテーマに対して特定のイベントが発生するかどうかを把握するために使用され、以下のような機能の実装に使われることがよくあります。
- プラグインの依存関係を確認する
- 特定のアクションフックにカスタムコードを動的に追加する
- 複数のプラグインが同じアクションを使用しているか確認する
- テーマやプラグインの設定を適切に管理する
- スクリプトやスタイルの読み込み条件を制御する
- 開発時のデバッグ情報を取得する
- パフォーマンス最適化のための動的な条件確認
- 他のプラグインとの競合を回避する
構文
has_action( string $hook_name, callable|null $callback = null )
パラメータ
$hook_name(string): チェックしたいアクションフックの名前。$callback(callable|null): オプション。確認したいコールバック関数。指定しない場合は、フックに登録されているすべての関数を確認します。
戻り値
- 指定したアクションフックに登録されているコールバック関数の数（integer）。関数が登録されていない場合は
falseを返します。
関連する関数
使用可能なバージョン
このアクションはWordPress 2.0.0以降で使用可能です。
コアファイルのパス
wp-includes/plugin.php
この関数のアクションでの使用可能性
| アクション名 | 使用可能性 |
|---|---|
| mu_plugin_loaded | 〇 |
| registered_post_type | 〇 |
| plugins_loaded | 〇 |
| wp_roles_init | 〇 |
| setup_theme | 〇 |
| after_setup_theme | 〇 |
| set_current_user | 〇 |
| init | 〇 |
| register_sidebar | 〇 |
| wp_loaded | 〇 |
| send_headers | 〇 |
| parse_query | 〇 |
| pre_get_posts | 〇 |
| wp | 〇 |
| template_redirect | 〇 |
| get_header | 〇 |
| wp_head | 〇 |
サンプルコード
サンプルコード 1: アクションフックのチェック
このコードは、wp_head アクションフックに特定のコールバックが登録されているかどうかを確認します。
if ( has_action( 'wp_head', 'my_custom_function' ) ) {
echo 'my_custom_function is registered to wp_head';
}
引用元: https://developer.wordpress.org/reference/functions/has_action/
サンプルコード 2: アクションフックの数を調べる
複数の関数が登録されている場合の数を取得する例です。
$count = has_action( 'wp_footer' );
echo 'Number of functions hooked to wp_footer: ' . $count;
引用元: https://developer.wordpress.org/reference/functions/has_action/
サンプルコード 3: 動的な条件でスクリプトを追加
wp_enqueue_scripts アクションに特定のスクリプトが登録されているか確認し、条件によりスクリプトを追加します。
add_action( 'wp_enqueue_scripts', 'conditionally_enqueue_script' );
function conditionally_enqueue_script() {
if ( ! has_action( 'wp_enqueue_scripts', 'some_script_function' ) ) {
wp_enqueue_script( 'new-script', get_template_directory_uri() . '/js/new-script.js' );
}
}
引用元: https://developer.wordpress.org/reference/functions/has_action/
サンプルコード 4: テストの実行
フックのテストを行い、登録された場合にメッセージを表示します。
function my_test_function() {
echo "This function is hooked!";
}
add_action( 'init', 'my_test_function' );
if ( has_action( 'init', 'my_test_function' ) ) {
echo 'my_test_function is hooked to init';
}
引用元: https://developer.wordpress.org/reference/functions/has_action/
サンプルコード 5: エラーロギング
特定のアクションフックに対して登録されている関数がない場合、エラーログに記録します。
if ( ! has_action( 'wp_footer' ) ) {
error_log( 'No functions registered to wp_footer' );
}
引用元: https://developer.wordpress.org/reference/functions/has_action/