この記事は最後に更新してから1年以上経過しています。

時代はWP_Queryなのか

ページ内の部分要素はWP_Queryクラスを使う

説明

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。
WP_Queryクラスはとても多機能であり、WordPressの投稿記事を検索・表示するための重要なクラスである。このWP_Queryクラスを使用した投稿記事の表示処理は、それほど特別なものではない。例えば'ニュース'というカテゴリーの最新投稿を5件取得する場合は、次のように記述する。

$apart_args = array(
	'order' => 'DESC',
	'posts_per_page' => 5,
	'category_name' => 'ニュース'
	);
$apart_posts = new WP_Query( $apart_args );
if ( $apart_posts->have_posts() ) :
	// ここに投稿記事を表示する前のの処理を記述
	while ( $apart_posts->have_posts() ) : $apart_posts->the_post();
	// ここに投稿記事の表示処理を記述
	endwhile;
	// ここに投稿記事を表示した後の処理を記述
	wp_reset_postdata();
else :
	// ここで投稿記事が見つからなかった場合の処理を記述
endif;

WP_Queryオブジェクトの生成時に指定するパラメータは、 query_posts関数とまったく同じである。生成されたWP_Queryオブジェクト（ここでは$apart_posts）には、検索結果の投稿記事データとそれを操作するためのメソッドが含まれている。投稿記事を表示するループ処理では、WP_Queryオブジェクトのhave_postsメソッド、the_postメソッドを使う（通常のループ処理のように have_posts関数や the_post関数は使用できない）。また後処理として、 wp_reset_postdata関数を呼び出すのも忘れずに行うこと。
上記の例は比較的単純な条件なのでget_posts関数でも実現可能だが、より詳細の条件を指定したい場合はget_posts関数では力不足になる。そんな時はこのWP_Queryクラスを使用する方法が適している。サイドバーやフッターなど、ページ中のパーツ要素として投稿記事を取得して表示する場合は、必要に応じてget_posts関数かWP_Queryクラスを使い分ければいい。WP_Queryクラスを使用する方法はそれなりにメモリーを消費しそうなので、サーバー環境を考慮して使い過ぎないように注意したほうがいいだろう。
余談になるが、query_posts関数の実行によってWP_Queryオブジェクトが生成され、グローバル変数$wp_queryに格納される。またhave_posts関数やthe_post関数は、$wp_queryの同名のメソッドを呼び出しているだけである。

最終更新 : 2011年08月01日 18:04

お勧め

convert_invalid_entities（2018年5月27日更新）

string convert_invalid_entities( string $content )

コンテントに含まれる無効なHTMLエンティティを変換する。

wp_die（2019年5月10日更新）

void wp_die( string | WP_Error $message [ , string | int $title = '' [ , mixed $args = array() ] ] )

エラーメッセージ（ページ）を表示する。

remove_meta_box（2011年8月25日更新）

void remove_meta_box( string $id, string $page, string $context )

投稿ページのメタボックスを削除（非表示）する。

get_header_image_tag（2018年5月27日更新）

string get_header_image_tag( array $attr = array() )

カスタムヘッダーのimg要素を取得する。

wp_schedule_single_event（2019年3月20日更新）

~~void~~ bool wp_schedule_single_event( int $timestamp, string $hook [ , array $args = array() ] )

一度だけ実行するアクションをスケジュールに登録する。

説明

関連

お勧め