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

検索ワード「-10,000円」を検索できるようにしたい

標準の区切り文字と「-」の働き

説明

とあるサイトで「-10,000円」をキーワードに検索した際、予想と異なるページが表示され、ちょっと驚いた。今回はその原因調査と対策についてまとめてみた。

標準の区切り文字と「-」の働き

まずは検索ワード「-10,000円」がどんなクエリーになっているのか現行バージョンの4.8.0で確認（適宜改行）。

(
(wp_posts.post_title NOT LIKE '%10%') AND 
(wp_posts.post_excerpt NOT LIKE '%10%') AND 
(wp_posts.post_content NOT LIKE '%10%')
) AND (
(wp_posts.post_title LIKE '%000円%') OR 
(wp_posts.post_excerpt LIKE '%000円%') OR 
(wp_posts.post_content LIKE '%000円%')
)

タイトル、抜粋、本文のすべてに「10」が含まれず、かつタイトル、抜粋、本文のいずれかに「000円」が含まれる投稿にマッチするクエリーになっている。まず「,」で2つに分割され、単語の先頭の「-」によって「NOT LIKE」が適用されている。また検索対象がタイトルと本文のほか、抜粋が追加されていることもわかる。

とりあえずバージョンをさかのぼりながら確認していくと、検索対象に抜粋が追加されたのはバージョン4.5.0だった。バージョン4.5.0以降では原則上記のクエリーとなることがわかった（バージョン4.7.0では'wp_query_search_exclusion_prefix'フィルターが用意され、「-」ではなく別の字に変更可能）。

さらにバージョンをさかのぼると、「-」によって「NOT LIKE」が適用される件はバージョン4.4.0で追加されいた。検索ワード「-10,000円」のクエリーは次のようになる。

(
(wp_posts.post_title NOT LIKE '%10%') AND 
(wp_posts.post_content NOT LIKE '%10%')
) AND (
(wp_posts.post_title LIKE '%000円%') OR 
(wp_posts.post_content LIKE '%000円%')
)

これに対し4.4.0より前のバージョン（ここでは4.3.1）で検索ワード「-10,000円」のクエリーは次のようになる。

(
(wp_posts.post_title LIKE '%-10%') OR 
(wp_posts.post_content LIKE '%-10%')
) AND (
(wp_posts.post_title LIKE '%000円%') OR 
(wp_posts.post_content LIKE '%000円%')
)

このようにバージョンによって検索ワードの解釈が異なるので、この点は注意したい。

検索ワードの「,」で分割問題

検索ワードが「,」で分割されることの対応については、分割される前に「,」を適当な字に置き換えて、クエリーが生成された後に「,」に戻す方法を試してみる。

function mytheme_pre_get_posts( $query ) {
	$s = $query->get( 's' );
	if ( !empty( $s ) && preg_match_all( '/(?<!\d)\d{1,3}(,\d{3})+(?!\d)/u', $s, $matches ) ) {
		$new_s = $s;
		foreach ( $matches[0] as $match )
			$new_s = preg_replace( '#'.$match.'#', str_replace( ',', '■', $match ), $new_s, 1 );
		$query->set( 's', $new_s );
	}
}
add_action( 'pre_get_posts', 'mytheme_pre_get_posts' );

function mytheme_posts_search( $search, $query ) {
	$query->set( 's', str_replace( '■', ',', $query->get( 's' ) ) );
	return str_replace( '■', ',', $search );
}
add_filter( 'posts_search', 'mytheme_posts_search', 10, 2 );

ここで使用したのは'pre_get_posts'アクションと'posts_search'フィルターである。
'pre_get_posts'アクションでは、検索ワードにカンマ区切りの数値がないか調べ、あった場合は「,」を「■」に書き換え、検索ワードとして格納し直している。なお、ここでは置き換え文字として「■」を使用しているが、実運用時する場合はもっと使用される可能性が低い字をあてるほうがよい。
'posts_search'フィルターは、検索ワードからクエリーを生成した後に実行されるフィルターでパラメータ$searchには生成されたクエリーが格納されている。そこで検索ワードとクエリーのそれぞれについて「■」を「,」に書き換えている。

上記を適用した結果、クエリーは次のようになる。

(
(wp_posts.post_title NOT LIKE '%10,000円%') AND 
(wp_posts.post_excerpt NOT LIKE '%10,000円%') AND
(wp_posts.post_content NOT LIKE '%10,000円%')
)

除外記号の「-」を「!」に変更

今度は除外記号の「-」を「!」に変更する。これはWordPressのバージョンによって対応が異なるが、4.7.0以降であれば先に触れたように'wp_query_search_exclusion_prefix'フィルターを利用するのが手っ取り早い。

function mytheme_search_exclusion_prefix( $exclusion_prefix ) {
	return '!';
}
add_filter( 'wp_query_search_exclusion_prefix', 'mytheme_search_exclusion_prefix' );

上記を適用した結果、クエリーは次のようになり、無事「-10,000円」が含まれるページが検索されるようになった。

(
(wp_posts.post_title LIKE '%-10,000円%') OR 
(wp_posts.post_excerpt LIKE '%-10,000円%') OR 
(wp_posts.post_content LIKE '%-10,000円%')
)

なおここでは「!」を使用しているが、検索ワードの区切り文字（記号）を指定してしまうと意図した検索結果が得られない場合があるので、その点は注意したい。

「,」を置き換えない方法

さて検索ワードを「,」で分割させない方法として、そのワードを「"」で囲む方法がある。'pre_get_posts'フィルターでそういった対応ができないわけではないのだが、元の検索ワードに「"」が含まれるケースを考えるといろいろと悩ましいので、今回は「,」を置き換える方法を採用した。

【追記】'wp_query_search_exclusion_prefix'フィルターで返す文字はシングルバイトでなければ正しく機能しない。またnullを返すことで、除外検索そのものを無効化できる（バージョン4.4.0より前のバージョンと同等になる）。

最終更新 : 2018年05月27日 10:43

お勧め

add_shortcode（2018年5月27日更新）

void add_shortcode( string $tag, mixed $func )

ショートコード（独自タグ）を追加する。ショートコードは、投稿記事内でテキスト内容がない[tag]や、テキストを内包する[tag]テキスト[/tag]の書式で使用できる独自タグのこと。標準の状態では、 the_content関数によって表示する直前のフィルター処理内でパラメータ$funcで指定した関数・メソッドが実行される。

get_user_setting（2022年1月31日更新）

mixed get_user_setting( string $name [ , string $default = false ] )

ユーザーインターフェイス設定を取得する。

have_posts（2018年5月27日更新）

bool have_posts( )

次の投稿データが存在するかを調べる。

in_category（2018年5月27日更新）

bool in_category( mixed $category [ , mixed $post = null ] )

投稿情報が指定したカテゴリーに属しているか調べる。

add_feed（2024年6月24日更新）

string add_feed( string $feedname, callable $callback )

フィードを追加する。

説明

標準の区切り文字と「-」の働き

検索ワードの「,」で分割問題

除外記号の「-」を「!」に変更

「,」を置き換えない方法

関連

お勧め