この記事は最後に更新してから1年以上経過しています。

6.2に追加されるsearch_columnsパラメータが便利

説明

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

search_columnsパラメータ

まずはsearch_columnsパラメータの仕様を確認。Docコメントには次のように記述されており、'post_title'、'post_excerpt'、'post_content'の組み合わせを配列で指定できるようだ。

Array of column names to be searched. Accepts 'post_title',
'post_excerpt' and 'post_content'. Default empty array.

search_columnsパラメータの効果を確認するため、タイトルに「world」が含まれる投稿とは別に、本文に「world」を含めた投稿を追加する。まずはこれで「world」が含まれる投稿を検索してみる。

$query = new WP_Query( ['s'=>'world'] );
if ( is_array( $query->posts ) ) {
	foreach ( $query->posts as $post ) {
		printf( '%d: %s<br />', $post->ID, esc_html( $post->post_title ) );
	}
}

上記のコードの実行結果は次の通りで2つの投稿が検索された。

1: Hello world!
1030: 本文に〇〇!

今度はsearch_columnsパラメータに'post_title'のみの配列を追加してみる。

$query = new WP_Query( [
	's'              => 'world',
	'search_columns' => ['post_title']
	] );

これで検索結果は1件となり、タイトルに「world」が含まれるもののみとなった。

1: Hello world!

次はsearch_columnsパラメータの'post_title'を'post_content'に変更してみる。

$query = new WP_Query( [
	's'              => 'world',
	'search_columns' => ['post_content']
	] );

この場合の検索結果は、本文に「world」が含まれ1件のみとなった。

1030: 本文に〇〇!

以上のように、バージョン6.2ではWP_Queryクラスにsearch_columnsパラメータを指定することで、キーワード検索の対象を限定できるようになった。

post_search_columnsフィルター

バージョン6.2ではsearch_columnsパラメータの追加にあわせてpost_search_columnsフィルターが追加された。

$search_columns = (array) apply_filters( 'post_search_columns', $search_columns, $search, $query );

このフィルターの第1パラメータ$search_columnsにはWP_Queryオブジェクトが受け取ったsearch_columnsパラメータをパースした内容が格納されており、このフィルターを使用することでキーワード検索の対象を変更できる。

なおこのフィルターの返り値はデフォルトの検索対象である3つのカラムと比較され、3つのカラム以外は検索対象にはならない。仮に'post_name'を含めてもそれが検索対象になることはない。


最終更新 : 2023年03月30日 12:40


お勧め

get_block_editor_settings(2021年8月17日 更新)

array get_block_editor_settings( array $custom_settings, WP_Block_Editor_Context $block_editor_context )
ブロックエディター設定内容を取得する。

wp_insert_attachment(2018年5月27日 更新)

mixed wp_insert_attachment( mixed $args [ , string $file = false[ , int $parent = 0 [ , bool $wp_error = false ] ] ] )
メディア(添付ファイル)を登録する。

remove_all_shortcodes(2018年5月27日 更新)

void remove_all_shortcodes( )
すべてのショートコードを削除する。

is_wp_error(2020年8月31日 更新)

bool is_wp_error( mixed $thing )
WP_Errorオブジェクトか調べる。

delete_user_setting(2022年1月31日 更新)

bool | null delete_user_setting( string | array $names )
ユーザーインターフェイス設定を削除する。