フィルターフックの引数の意味

WordPress関連の記事

WordPressCodex日本語版にはこう書いてあります。

<?php add_filter( $tag, $function_to_add, $priority, $accepted_args ); ?>

けれどいまいち、一見しただけでは何のことを言っているのかよくわからないですよね。
僕もWordPressを触り始めた頃(9年くらい前)は、何のことやらさっぱりでした。
そして、フィルターフックの仕組み自体よくわかってませんでした。

上の引数の意味を日本語でかみくだくと、

左から順に、

$tag
フィルターフック対象の関数名(この関数の実行時に実行),

$function_to_add
フィルターが適用されたときに実行する関数名(やりたい事を定義),

$priority
実行優先順位(デフォルト=10),

$accepted_args
受け取る引数の数(デフォルト=1);

となります。

functions.phpに追記して、
「あるWordPress関数の実行時に、一緒に実行されるふるまいを定義して、デフォルトのふるまいを変える」ときに使います。

$tag にあたる部分に指定できるWordPress関数は、WordPressCodex日本語版の中のこのページ → プラグイン API/フィルターフック一覧
にまとまっています。

フィルターフックを使いこなせるようになると、WordPressでできる事の幅が一段と広がりますよ。

この記事をシェアする: