2022年04月25日

WP関数：set_query_var()

この関数の説明

WP関数の set_query_var() は、メインクエリquery_posts()の検索条件を変更する関数です。

これを利用する事により、抽出したデータの並び順を変更したり、抽出方法を変更する事ができます。

メモ

WordPressでは、DBから投稿や固定ページ情報を取り出し関数としてquery_posts()を利用しています。

これをメインクエリを呼びます。

一方、ユーザがDBから投稿や固定ページ情報を取り出す場合はWP_Query()を利用します。

これをサブクエリと呼びます。

関数

set_query_var( $var, $value )

パラメータ

$var（文字列）（必須）

クエリ変数のキー

初期値：なし

詳細は1項のQueryの主要なキーと値を参照して下さい。

$value（文字列|整数|配列）（必須）

クエリ変のキーにセットする値。

初期値：なし

事例

①下記はメインクエリを実行する条件を下記仕様に変更する命令です。

・カテゴリ表示の時はタイトル名が小さい順に表示させる。

・検索ページは、投稿だけを検索させる。

function my_query() {
	// カテゴリ表示はタイトル名が小さい順に表示させる
	if(is_category()){
		set_query_var( 'order', 'asc' );
		set_query_var( 'orderby', 'title' );
	}
	// 検索結果ページは投稿文書だけを対象にする
	if(is_search()){
		set_query_var( 'post_type', 'post');
	}
}
add_action( 'pre_get_posts', 'my_query' );

■3～6行目

抽出した投稿や固定ページは、作成日が新しい物から並べるのがデフォルトです。

これをカテゴリ表示の時だけは、タイトルが小さい物から並べる様に指定しています。

■8～10行目

検索のデフォルトは投稿と固定ページを抽出します。

これを投稿だけに抽出する様に変更しています。

■12行目

アクション：pre_get_posts は、メインクエリを実行する時にフックされるアクションフックです。

1.Queryの主要なキーと値

下記は Queryの主要なキーと値を解説しています。元に戻る

区分キー名タイプ説明

抽出方法

'post_type'

文字列

抽出する文書タイプを指定します。

値	説明
'post'	投稿を抽出します
'page'	固定ページを抽出します
'any'	投稿と固定ページを抽出します default
'××x''	カスタム投稿のxxxを抽出します

'category_name' 文字列指定したカテゴリのスラッグ名の投稿を抽出します。

'cat' 整数指定したカテゴリIDの投稿を抽出します。

'tag' 文字列指定したタグ名の投稿を抽出します。

'tag_id' 整数指定したタグIDの投稿を抽出します。

's' 文字列指定した検索ワードでヒットする投稿を抽出する

'post_in' 配列リストしたい文書IDを配列で指定します。

'post__not_in'

配列

リストから省きたい文書IDを配列で指定します。

現在の投稿をリストから省きたい場合は下記を指定します。

'post__not_in' => array(get_the_ID()),

並び順

'orderby'

文字列

対象リストの並び順を指定します。

値	説明
'date'	作成日順 default
'modified'	更新日順
'id'	投稿ID順
'title'	タイトル名順
'rand'	ランダム表示
'`meta_value_num'`	'meta_key'の値でソートします。
'post_in'	'post__in' パラメータの投稿IDの順

'meta_key' 文字列カスタムフィールドの名前を指定します。