do_action()


WordPressのdo_action()関数は、特定のアクションフックを実行するために使用されます。この関数を使うことで、プラグインやテーマ開発者は、特定のタイミングでカスタムコードを実行することができます。

構文

do_action( string $tag, mixed $arg = '' );

引数の説明:

  • $tag (string) — 実行するアクションフックの名前。
  • $arg (mixed) — アクションフックに渡す追加の引数。

例1: 基本的なアクションフックの実行

この例では、my_custom_actionというアクションフックを実行します。

do_action('my_custom_action');

例2: 引数を渡してアクションフックを実行

この例では、my_custom_actionに引数を渡して実行します。

do_action('my_custom_action', $arg1, $arg2);

例3: テーマ内でのアクションフックの使用

テーマのheader.phpファイル内でアクションフックを使用する例です。

do_action('before_header');

例4: プラグイン内でのアクションフックの使用

プラグイン内でアクションフックを使用して、特定のタイミングでコードを実行します。

do_action('after_plugin_loaded');

例5: 複数の引数を渡す

複数の引数を渡してアクションフックを実行する例です。

do_action('my_custom_action', $arg1, $arg2, $arg3);

例6: アクションフックにオブジェクトを渡す

オブジェクトを引数として渡してアクションフックを実行します。

$my_object = new My_Class();
do_action('my_custom_action', $my_object);

例7: アクションフックに配列を渡す

配列を引数として渡してアクションフックを実行します。

$my_array = array('key' => 'value');
do_action('my_custom_action', $my_array);

例8: アクションフックにコールバック関数を渡す

コールバック関数を引数として渡してアクションフックを実行します。

do_action('my_custom_action', 'my_callback_function');

注意点

  • アクションフックの名前は一意である必要があります。
  • 引数の数と型は、アクションフックに紐づけられた関数と一致させる必要があります。
  • アクションフックを多用すると、パフォーマンスに影響を与える可能性があります。

関連機能: