get_postsとquery_postsを使い分け

同じような機能を持つquery_postsとget_postsは、どうを使い分けたらいいのか整理してみた

説明

get_postsと query_postsは、どちらも複数の投稿情報を取得することができる便利な関数である。パラメータとして指定できる内容も共通しているものが多く、query_postsがより詳細なパラメータを指定でき、高機能になっている。
まずは、パラメータで指定できる意味（目的）が同じキーワードを見ていこう。

意味	get_postsのキーワード	query_postsのキーワード
取得件数	numberposts	posts_per_page
取得開始位置	offset	offset
ソート対象	orderby	orderby
ソート順	order	order
取得する投稿情報ID	include	post__in
除外する投稿情報ID	exclude	post__not_in
投稿情報タイプ	post_type	post_type
取得・除外するカテゴリID	category	cat
カスタムフィールドの名前	meta_key	meta_key
カスタムフィールドの値	meta_value	meta_value

キーワード名に若干違いはあるが、値の指定方法も共通しており、これらの条件で投稿情報を取得するならばどちらでも対応できることがわかる。
次に、query_postsにのみ存在する主なキーワードを見てみよう。

キーワード	意味
s	検索文字
category_name	カテゴリ名
tag	投稿タグのスラッグ
author	投稿者ID
author_name	投稿者名

これのほか、カテゴリや投稿タグについては別のキーワードがあり、さらに投稿日時による絞り込みも可能である。投稿タグや投稿者、投稿日時をによる仕込みこみを行う場合は、query_postsを使用するのが妥当だろう。

このように、query_postsはget_postsの検索機能を内包し、さらにプラスアルファの検索機能を備えていることを確認できたわけだが、この2つの関数には検索機能のほかに本質的な違いがある。それは、グローバル変数へ影響を及ぼすかどうか。query_postsの検索結果はさまざまなグローバル変数に影響を及ぼすが、get_postsの検索結果にはそういったことがない。

具体的な使い方の違いを少し紹介する。

$posts1 = get_posts( 'category=1' );
$posts2 = query_posts( 'cat=1' );

この場合、どちらもカテゴリIDが1のカテゴリに属する投稿情報が取得でき、$posts1と$posts2の内容は同じ。どちらも$posts1および$posts2に直接アクセスできるが、$posts2の内容に関しては have_postsおよび the_postを使ったおなじみのループ処理も利用可能である。

<?php while ( have_posts() ) : the_post(); ?>
// ここに処理を記述
<php endwhile; ?>

この違いこそが、get_postsとquery_postsの本質的な違いといえる。

次は、サイドバーに特定のカテゴリの投稿記事の見出しを表示するケース。この場合は、get_postsを使用するほうがいい。

<ul>
<?php
$info_posts = query_posts( 'cat=1' );
foreach ( $info_posts as $info ) {
	echo '<li>'.$info->post_title.'</li>';
}
?>
</ul>

その理由は、query_postsを使用すると、一部のグローバル変数（ $postsなど）の内容だけでなく、 is_singleなどの一部の関数の結果も変わってしまうから。タイミングにもよるが、テーマが意図していない振る舞い（表示内容）になってしまう可能性がある。

今度は、キーワード検索で特定のカテゴリのみを検索する場合。こちらは、query_postsを使用するほうがいいだろう。具体的な使い方としては、テーマ内のsearch.phpの冒頭で次のような処理を行えばいい。

<?php
global $query_string;
query_posts( $query_string.'&cat=1,2,3' );
?>

$query_stringには、検索キーワードを含んだ検索条件のパラメータが格納されており、こうすることでカテゴリIDが1、2、3の何れかに属する投稿情報を検索できる。検索結果の内容は、グローバル変数にも反映されるので、基本的にはそのほかの部分を修正する必要はないだろう。

get_postsとquery_postsのおおよその違いはこんな感じだ。

2011/8/1追記：「時代はWP_Queryなのか」も合わせてお読みください。

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

お勧め

wp_get_attachment_image（2018年5月27日更新）

string wp_get_attachment_image( int $attachment_id [ , mixed $size = 'thumbnail' [ , bool $icon = false [ , mixed attr = '' ] ] ] )

アタッチメント情報のHTMLテキストを取得する。

get_parent_theme_file_path（2018年5月27日更新）

string get_parent_theme_file_path( string $file = '' )

親テーマ内にあるファイルのパス名を取得する。

get_post_format_slugs（2011年9月12日更新）

string get_post_format_slugs( )

投稿フォーマットのスラッグ一覧を取得する。

get_status_header_desc（2018年5月27日更新）

string get_status_header_desc( int $code )

HTTPステータス説明文を取得する。

get_network_option（2018年5月27日更新）

mixed get_network_option( int $network_id, string $option [ , mixed $default = false ] )

ネットワークオプション（サイトオプション）を取得する。

説明

関連

お勧め