TOP
PHP
get_posts() と WP_Query() の使い分け

2023.03.08

get_posts() と WP_Query() の使い分け

PHP WordPress

get_posts() と WP_Query() の違い

get_posts() と WP_Query() は、WordPress で投稿を取得するために使用される 2 つの主要な関数です。これらの関数は似ていますが、使用方法にはいくつかの違いがあります。

get_posts() を使用すると、ループを使用せずに投稿を取得できます。これにはいくつかのメリットがあります：

簡単に使用できる：get_posts() は、単純なパラメーターの配列を受け取るため、初心者でも簡単に使用できます。
軽量で高速：ループを使用せずに投稿を取得することにより、処理速度が向上し、サイトのパフォーマンスが向上します。
メモリ使用量の低減：ループを使用しないため、メモリ使用量が低減されます。
グローバル変数を変更しない：get_posts() はグローバル変数 $wp_query を変更しないため、他のテンプレートタグやプラグインとの互換性が高く、コードの衝突を回避できます。

一方、WP_Query() を使用する場合、ループを使用して投稿を取得する必要があります。これにより、より詳細なクエリを作成できます。また、複雑な条件で投稿を取得する場合にも便利です。

WordPressにおけるループとは

WordPressでのループとは、通常、記事を表示するために使用される “The Loop” と呼ばれる構造のことを指します。このループは、WP_Query() を使用して記事を取得し、それをテンプレートに表示するために使用されます。

<?php if ( have_posts() ) : while ( have_posts() ) : the_post(); ?>

  <h2><a href="<?php the_permalink(); ?>"><?php the_title(); ?></a></h2>
  <?php the_excerpt(); ?>

<?php endwhile; else : ?>

  <p><?php esc_html_e( 'Sorry, no posts matched your criteria.' ); ?></p>

<?php endif; ?>

get_posts() を使用する場合、このループの構造を使用せずに、投稿を取得することができます。つまり、記事の取得後、各記事をループで処理する必要がなく、そのまま配列として使用することができます。

また、get_posts() はグローバル変数 $wp_query を変更しないため、他のテンプレートタグやプラグインとの互換性が高く、コードの衝突を回避できます。

ただし、get_posts() は単に記事の配列を返すだけであり、記事のメタデータやターム情報など、より詳細な情報を必要とする場合には、WP_Query() を使用する必要があります。

get_posts()では取得出来ないパターン

以下は、get_posts() では取得できないパターンの例です。

‘meta_query’ を使用して、カスタムフィールドの値に基づいて投稿をフィルタリングする場合。
タクソノミーの特定のタームに基づいて投稿をフィルタリングする場合。
投稿タイプの特定のスラッグを持つ投稿をフィルタリングする場合。
‘custom_post_status'(カスタム投稿ステータス)を持つ投稿をフィルタリングする場合。
複雑な条件に基づいて、複数の投稿タイプまたはタクソノミーから投稿をフィルタリングする場合。

これらの場合、通常は WP_Query() を使用する必要があります。

get_posts() でそのまま使用出来ないテンプレートタグ

get_posts() を使用して投稿の内容を表示する場合、次のようなテンプレートタグには注意する必要があります。

the_post_thumbnail()

このタグは、投稿のアイキャッチ画像を表示するためのタグですが、get_posts() で取得した投稿にはデフォルトでアイキャッチ画像が含まれていません。そのため、アイキャッチ画像を表示するには、get_posts() で取得した投稿のIDを指定して、get_the_post_thumbnail() を使用する必要があります。

<?php
$posts = get_posts();
foreach ($posts as $post) {
  setup_postdata($post);
  echo get_the_post_thumbnail($post->ID);
}
wp_reset_postdata();
?>

the_permalink()

このタグは、投稿のパーマリンクを取得するためのタグですが、get_posts() で取得した投稿にはデフォルトでパーマリンクが含まれていません。そのため、get_permalink() を使用して、投稿のパーマリンクを取得する必要があります。

<?php
$posts = get_posts();
foreach ($posts as $post) {
  setup_postdata($post);
  echo '<a href="' . get_permalink() . '">' . get_the_title() . '</a>';
}
wp_reset_postdata();
?>

the_content()

このタグは、投稿のコンテンツを表示するためのタグですが、get_posts() で取得した投稿の場合、デフォルトでは投稿の本文以外のコンテンツ（例えば、抜粋）が表示されることがあります。そのため、get_the_content() を使用して、投稿の本文を表示する必要があります。

<?php
$posts = get_posts();
foreach ($posts as $post) {
  setup_postdata($post);
  echo get_the_content();
}
wp_reset_postdata();
?>

get_posts() と WP_Query() のパラメータの違い

get_posts() と WP_Query() のパラメータはほぼ同じですが、一部異なるものがあります。以下に、それぞれのパラメータの違いについて説明します。

post_type（投稿タイプ）

get_posts() では、post_type パラメータに投稿タイプを指定することができますが、複数の投稿タイプを取得することはできません。一方、WP_Query() では、post_type パラメータに複数の投稿タイプを含めることができます。

例えば、get_posts() では post_type=’post’ とすると投稿のみを取得できますが、WP_Query() では post_type=array(‘post’, ‘page’) とすることで、投稿と固定ページの両方を取得することができます。

posts_per_page（ページあたりの投稿数）

get_posts() では、posts_per_page パラメータを使用してページあたりの投稿数を指定できます。一方、WP_Query() では、posts_per_page パラメータと一緒に、paged パラメータを使用する必要があります。

例えば、get_posts() では posts_per_page=10 とすることで、1ページあたり10件の投稿を取得できますが、WP_Query() では posts_per_page=10 と一緒に paged=2 とすることで、2ページ目の10件の投稿を取得することができます。

nopaging（ページネーションしない）

get_posts() では、nopaging パラメータを true に設定することで、ページネーションを無効にすることができます。一方、WP_Query() では、posts_per_page パラメータを -1 に設定することで、すべての投稿を1ページに表示することができます。

例えば、get_posts() では nopaging=true とすることで、すべての投稿を1ページに表示できますが、WP_Query() では posts_per_page=-1 とすることで、同じ結果を得ることができます。

これらのパラメータ以外にも、get_posts() と WP_Query() では、オーダーパラメータやタクソノミーの取得方法など、微妙に異なるパラメータがあります。

WP_Query() のデバッグ用のログ出力の方法

WP_Query() を使用して、クエリのデバッグ用にログ出力を行うには、以下の手順に従います。

WP_Query() の引数に 'debug' => true を追加します。
クエリを実行し、結果を変数に代入します。例えば、以下のようにします。

$query = new WP_Query( array(
    'debug' => true,
    'post_type' => 'post',
    'posts_per_page' => 5,
) );

クエリのログを確認するために、WordPress のデバッグログを有効にします。wp-config.php ファイルに以下のコードを追加します。

define( 'WP_DEBUG', true );
define( 'WP_DEBUG_LOG', true );

ログファイルにアクセスするために、以下のコードを使用して、ログファイルのパスを取得します。

$log_file = ini_get('error_log');

ログファイルを開いて、クエリのログを確認します。ログファイルには、クエリの SQL 文が出力されます。

ブログ一覧へ