wordpress 検索機能カスタマイズで、add

#add_filterの使い方がわかっていない

add_filterについて、日本語版ドキュメントをみても理解できなかったため質問です。

フックにして関数を呼び出しという機能は理解できましたが、

以下のようにしたい場合、posts_searchとは、既定の内容でしょうか？それともユーザが任意で用意するものでしょうか？

このあたりがわかるＵＲＬや、資料などあればご教授頂ければ大変助かります。
#参考にしているスクリプト

####問題点

なぜ、posts_searchと指定しているのか理解できていない。
posts_searchという関数は用意する必要があるのか？

php
1add_filter( 'posts_search', 'my_test' );
2 
3function my_test($content){
4    return str_replace('wp_posts.post_content', 'wp_posts.post_excerpt', $content );
5}

引用元：coreファイルの検索の仕組みと、snippet

行動規範の内容に同意します

回答1件

ベストアンサー

posts_search は、フックの名前で、関数ではありません。

あらかじめ WordPress やプラグインのコードの中に ユーザーが作成した関数を呼び出して、WordPress の動作を変更する 処理が組み込まれています。
そして組み込まれた場所ごとに「名前」がつけられていて、この名前が、フック名です。

つまり、add_action() 関数や add_filter() 関数は、フックの名前が呼ばれた際に実行する関数を紐付けする処理です。

例に挙げられている posts_search の場合、フィルターフック一覧の説明に

WP_Query の WHERE 節で使用される検索 SQL に適用される。

とあります。
実際にソースコードを確認すると WP_Query で、実行される SQL 文の WHERE 句に対して処理を行う部分に記載されています。

my_test を例にすると SQL 文の WHERE 句が、$content として渡されて呼び出されるので、 WHERE 句の wp_posts.post_content を wp_posts.post_excerpt に置き換える処理をしています。
このフックを通過すると WordPress では、通常 wp_posts.post_content から検索するしているわけですが wp_posts.post_excerpt から検索するように WP_Query が実行する SQL の検索条件を書き換えています。

具体的な WordPress のソースコードとしては、 wp-includes/class-wp-query.php の中の get_posts() 関数の処理の中に posts_search フックを呼び出す処理が組み込まれています。
ここが実行されたタイミングで、フック名posts_searchに紐づいた関数が順番に実行されます。

どの名前が、WordPress のどの部分で呼ばれるかというのは、

あたりに記載があります。

また、日本語版ドキュメントには、記載がないものもいろいろあるので、必要に応じて英語版ドキュメントやソースコードを読む必要があるかもしれません。

投稿2018/10/27 04:12

編集2018/10/27 04:18