タイトル: do_action

SEOタイトル: Wordpressのdo_actionの使い方

この記事の要点
WordPress の `do_action()` 関数指定したフック (タグ) に登録された関数を一括実行するための関数書式: `do_action($tag, $arg)` 関数登録は `add_action($tag, $callback)` で行うカスタマイズ / プラグイン開発の中核仕組み

本稿ではWordpressのdo_action関数について説明します。

説明

do_action関数を使用することで、Wordpressの既存の関数もしくは自分で定義した関数を呼び出すことができます。

一つの関数を呼び出すのではなく、関数に付与したタグを指定することでタグのついた関数を一度に呼び出すことができます。

$tagに呼び出したいタグを、$argに指定した関数に与える引数を指定します。

<?php do_action( $tag, $arg ); ?>

複数の引数を与える場合は以下のようにします。

<?php do_action( $tag, $arg_a, $arg_b, $etc ); ?>

関数の登録の仕方とタグの付与方法を説明します。

以下、function.phpに関数を定義します。

//関数の定義　中身はなんでもいい

function test_func( $a, $b )
{
echo $a . " and " . $b;
}

//関数を登録する

// add_action( $tag, $function_to_add, $priority, $accepted_args );

add_action( 'test_tag', 'test_func', 10, 2 );

//関数を呼び出す

do_action( 'test_tag', "A", "B" );