WordPress開発備忘録

 

開発

アクションフック&アクションフィルター

add_acctionの記述方法

add_action( フック名, 関数名 , 優先順位[初期値:10] , 関数の引数の数[初期値:1] )

  • 優先順位・引数を省略した場合は初期値
  • 戻り値は常に”true”。

do_actionの記述方法

do_action( フック名, 引数1, 引数2, 引数etc );

  • 引数は省略可

アクションフックとフィルターフックの違い

アクションフィルターとフィルターフックの違いは「値を返すか否か」ということだけです。

アクションフィルター(do_action)は値を返さず、ただ関数を実行します。一方、フィルターフック(apply_filters)は必ず値を返します。

それ以外は同じです。”do_action”と”apply_filters”のソースを見ると同じ命令文になっていることが分かります。つまり、機能的にはほぼ同じです。つまり、関数も共有できます。

しかし、機能的には同じでもWordPressでは概念的に使い分けているようなので、”do_action”には”add_action”、”apply_filters”には”add_filter”を使いましょう。