query_postsを使うと投稿ページなどで表示する条件を設定することができます。
ただし、このquery_postsを使うことは非推奨とされています。
ではなぜquery_postsを使うことは非推奨なのでしょうか？
この記事では、query_postsについてといった基本的な内容から、注意すべき点についても解説していきます。
・query_postsとは？
・query_postsの使い方
・query_postsは非推奨？代替方法は？
今回はquery_postsについて、わかりやすく解説します。
query_postsとは？
query_postsは、WordPressで投稿を表示するのに使用しているメインクエリを書き換えるテンプレートタグです。
メインクエリとは、ブラウザからリクエストされたURLを元にデータベースから呼び出される記事のデータのことです。
query_postsはメインクエリを新たに上書きします。
表示する投稿を絞り込む場合などに使います。
query_postsの使い方
query_postsを使う際には最後にwp_reset_queryでリセットし、メインクエリを元に戻す必要があります。
サンプルコードで確認しましょう。
<?php
// 条件の設定
$args = Array(
'post_type' => 'post', // 投稿
'posts_per_page' => 5, // 表示する投稿数(-1を指定すると全投稿を表示)
);
// クエリ
query_posts( $args );
// ループ
if ( have_posts() ) {
while ( have_posts() ) {
the_post();
// 処理を記述
}
}
// 投稿データのリセット
wp_reset_query();
?>
より複雑な条件を設定することもできます。
設定でよく使う内容をコードスニペットにまとめたサイトをご紹介しておきます。
https://sole-color-blog.com/blog/265/
query_postsは非推奨？代替方法は？
ここまでquery_postsについて説明してきました。
query_postsは条件を絞って表示するためにメインクエリを書き換えることができます。
しかしwp_reset_queryの記述を忘れると、他のページのクエリも書き換わるなどの意図しない結果が表示される危険性もあるため非推奨とされています。
また、メインクエリを書き換える際に再度データベースを読み込む必要があるのでページの表示速度が遅くなります。
そこで、query_postsの代わりにメインループではpre_get_postsを、サブループではWP_Queryまたはget_postsを使うことが強く推奨されています。
pre_get_posts
pre_get_postsはWordPressのアクションフックの一つです。
アクションフックでは、イベントが発生したときに機能を追加したり削除したりできます。
pre_get_postsはメインループで使います。
pre_get_postsはfunction.phpに記述します。
サンプルコードで確認しましょう。
function five_posts( $query ) {
// 指定したページとメインクエリの場合に限定
if ( $query->is_home() && $query->is_main_query() ) {
$query->set( 'post_type', 'post' );
$query->set( 'posts_per_page', '5' );
}
}
add_action( 'pre_get_posts', 'five_posts' );
他のページでpre_get_postsが働かないようにif文で限定するようにしましょう。
WP_Query
WP_Queryはブログの投稿やページの情報を取得する場合に使うクラスです。
WP_Queryはメインクエリを書き換えません。
メインクエリを表示するメインループとは別にサブループで投稿一覧などを表示するために使います。
<?php
// 条件の設定
$args = Array(
'post_type' => 'post', // 投稿
'posts_per_page' => 5, // 表示する投稿数(-1を指定すると全投稿を表示)
);
// クエリの定義
$wp_query = new WP_Query( $args );
// ループ
if ( $wp_query->have_posts() ) {
while ( $wp_query->have_posts() ) {
$wp_query->the_post();
// 処理を記述
}
}
// 投稿データのリセット
wp_reset_postdata();
?>
WP_Queryについてはこちらでも詳しく解説していますので、ぜひ参考にしてください。
get_posts
get_postsはブログの投稿やページの情報を取得する場合に使うテンプレートタグです。
WP_Queryクラスと同じように、メインループとは別にサブループで投稿一覧などを表示するために使います。
WP_Queryの場合はオブジェクトとして扱えるのでプロパティなども使えますが、get_postsは取得結果を配列としてしか扱えません。
<?php
// 条件の設定
$args = Array(
'post_type' => 'post', // 投稿
'posts_per_page' => 5, // 表示する投稿数(-1を指定すると全投稿を表示)
);
// クエリの定義
$the_query = get_posts( $args );
// ループ
if ( $the_query) {
global $post;
foreach ( $the_query as $post ) {
setup_postdata( $post );
// 処理を記述
}
}
// 投稿データのリセット
wp_reset_postdata();
?>
まとめ
ここではquery_postsについて説明しました。
query_postsは投稿ページなどで条件を絞って表示することができます。
ただしメインクエリを書き換えるので、wp_reset_query関数を呼び出さなければ他のページのクエリも変更するなど意図しない結果になる危険性があるので非推奨とされています。
メインクエリを変更するならpre_get_postsを、サブループで条件を指定する場合はWP_Queryやget_postsを使うようにしましょう。
使いこなすことができるように、この記事を何度も参考にして下さいね！
