WordPressでメインクエリの一部を保持しながら取得条件を変えたい

WordPressでメインクエリを変更したい時、query_posts を使うことは公式からも非推奨とされています。
実際に query_posts はページ送りがうまくいかない、条件をリセットし忘れて他所で検索条件が変わってしまう…など、カスタマイズ時の使い方を誤ると問題が起こりやすい関数です。
なので、代わりに pre_get_posts を使いましょう。

今回はメインクエリを変更する際利用するアクションフック pre_get_posts について紹介します。

その前に…メインクエリとは？サブクエリとは？

今回変更したいメインクエリとはそのページに設定された基本的な検索条件のことを指します。
メインクエリの内容はURLと連動しています。
以下は表示設定を10件と設定したWordPressでのメインクエリ例です。

サブクエリとは

サブクエリとは、ざっくり言うとメインクエリではないものです。
メインクエリはURLと連動した内容でしたが、サブクエリはそれとは関係のないクエリです。
例えば下記のようなものです。

などなど。

関数名、クラス名で言えば get_posts 、WP_Queryがサブクエリを生成するものです。
メインクエリを変更せずに記事を条件指定で取得したい場合はこのどちらかを使います。

pre_get_posts を使ってメインクエリを変更する

それでは実際にメインクエリを変更する方法を紹介します。
pre_get_posts はアクションフックなので functions.php で操作します。
query_posts ではテーマテンプレート内に条件を記述していましたが、pre_get_posts はテーマテンプレートを呼び出す前の時点で検索条件を変更する仕様になります。

function edit_home_main_query( $query ) {
    if ( is_admin() OR !$query->is_main_query() ){
         return;
    }
	
	// トップページ
    if ( $query->is_home() ) {
        $query->set('posts_per_page', 5);
    }

	// カテゴリページ
    if ( $query->is_category() ) {
        $query->set('posts_per_page', 20);
    }

	// タグページ
    if ( $query->is_tag() ) {
        $query->set('posts_per_page', 20);
    }
}
add_action('pre_get_posts','edit_home_main_query');

functions.php は管理画面など至るところで使用されています。
管理画面以外のメインクエリにのみ反映させるため、上部で条件分岐させています。
ページ別に条件を変えたい場合は、is_home()、is_category() などの関数を利用しましょう。

$query->set に渡すパラメーターは WP_Query のものとほぼ同じです。

WordPressのサイト制作、保守運用にお困りの方はお気軽にご相談ください。

No Image

WordPress外から記事やカテゴリデータなどを呼び出す方法

カスタム

特定のページのみにも対応！WordPressで独自のスタイルシート、jQueryを呼び出す方法

カスタム

管理画面のサイドバーから特定のプラグインのメニュー等を非表示

カスタム

WordPressで本体アップデートに失敗！？FTPを使って手動でアップデートする方法

カスタム

WordPressで絞り込み検索！検索機能を拡張してカスタムフィールド・複数カテゴリ・日付範囲で検索できるようにする

カスタム