do_action() の使い方説明・引数・注意点
do_action() は、指定した名前のアクションフックを実行し、add_action() で登録された関数を順番に呼び出す関数です。テーマやプラグインに独自の拡張ポイントを作るときに使います。
説明
do_action() は、指定した名前のアクションフックを実行し、add_action() で登録された関数を順番に呼び出す関数です。テーマやプラグインに独自の拡張ポイントを作るときに使います。
基本構文
do_action( string $hook_name, mixed ...$arg ): void
引数
$hook_name:実行するアクションフック名...$arg:コールバックに渡す引数(任意の数)
戻り値
戻り値はありません。
使い方(サンプル)
// 独自フックを用意
do_action( 'my_before_content', $post_id );
// 別の場所で処理を登録
add_action( 'my_before_content', function( $post_id ) {
echo '<p>ID: ' . (int) $post_id . '</p>';
}, 10, 1 );
注意点
- アクションは値を返さないので、値を加工したい場合は
apply_filters()を使います。 - 独自フック名には接頭辞を付けて衝突を避けます。
- 登録されていないフックを実行しても何も起きず、エラーにもなりません。
実務での使いどころ
- 自作のプラグインやテーマに、他の人が処理を差し込める場所(独自のフック)を、作るとき。
- 処理の途中に、「ここで追加の処理を呼ぶ」という、拡張ポイントを置くとき。
よくあるミスと対策
- 値を返すつもりで使っている。
do_action()は、値を返さない。値を加工して返したいときは、apply_filters()を使う。 - フック名に、接頭辞を付けていない。他のプラグインと、名前が重なる。
my_plugin_after_saveのように、接頭辞を付ける。 - 渡した引数の数と、
add_action()側の、受け取る数(第4引数)が、合っていない。
NG例
do_action( 'after_save' ); // 接頭辞がなく、他と重なりうる
OK例
do_action( 'my_plugin_after_save', $post_id, $data );
// 受け取る側: add_action( 'my_plugin_after_save', 'my_func', 10, 2 );
使い分け早見表
| 関数 | 役割 |
|---|---|
do_action() |
アクションを実行する(値は返らない) |
apply_filters() |
フィルターを適用して、値を返す |
add_action() |
アクションに、処理を登録する |
PR エックスサーバー
WordPressを、速く・止まらずに運営したい方へ
サーバー選びを間違えると、表示が遅い・サイトが止まるリスクがあります
こんなお悩みはありませんか?
- どのレンタルサーバーを選べばよいか分からない
- 表示が遅い・サイトが落ちるのが心配
- WordPressの設定やセキュリティに自信がない
サーバーは、あとから乗り換えると、データの移行やドメインの設定に手間がかかります。表示が遅い、突然止まるといったトラブルは、訪問者が離れる原因にもなります。最初に、稼働率の保証や実績を確認して選ぶのが安全です。
エックスサーバーなら、WordPressの運営に強いレンタルサーバーを、迷わず選べます。国内でWordPressを利用して運用されているサイトの集計(Dataprovider.com調べ、2025年6月)で、国内シェアNo.1と公式サイトに記載されています。
選ばれるポイント
- WordPressサイトの国内シェアNo.1。実績で選びたいときの安心材料(Dataprovider.com調べ、2025年6月)
- サイトが止まりにくい。月間稼働率99.99%以上を保証し、下回ると月額費用の一部を返金
- 攻撃に強い。WordPressを狙った攻撃の99%以上を未然に防ぐ機能(2024年9月15日〜11月15日の当社調べ)
- ドメイン代を節約できる。独自ドメインが永久無料(対象ドメイン・契約期間などの条件あり)
- テーマ選びも安心。人気テーマ「Cocoon」の開発・提供元が運営
- 10日間の無料お試しで、契約前に操作や表示の速さを確かめられる
10日間の無料お試しで、契約前に試せます
10日間無料でお試し
広告(アフィリエイト)を含みます。特長は2026年11月8日時点の公式サイトの記載で、数値・順位は各調査・調べの時点のものです。料金・条件は公式サイトでご確認ください。
関連項目
add_action()、has_action()、apply_filters()
公式リファレンス:do_action() | Function | WordPress Developer Resources
本記事は情報提供を目的としています。WordPress本体やテーマ・プラグインのバージョンによって動作が異なる場合があるため、本番環境に反映する前に、必ずテスト環境で動作を確認してください。