• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

「関数リファレンス/WP Query」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(順序&順序ベースパラメータ: 途中まで訳)
(タクソノミーパラメータ: 一部訳)
264行目: 264行目:
 
'''重要な参考ポイント:''' <tt>tax_query</tt> は、タクソノミー検索条件('''配列''')の'''配列''' をパラメータにします(つまり配列の配列です)。下記の 2 番目の例を見るとわかりやすいでしょう。この構造によって、複数のタクソノミーを検索できますが、その時は最初の(外側の)配列の '''<tt>relation</tt>''' パラメータによって複数のタクソノミー検索の関係を指定します。
 
'''重要な参考ポイント:''' <tt>tax_query</tt> は、タクソノミー検索条件('''配列''')の'''配列''' をパラメータにします(つまり配列の配列です)。下記の 2 番目の例を見るとわかりやすいでしょう。この構造によって、複数のタクソノミーを検索できますが、その時は最初の(外側の)配列の '''<tt>relation</tt>''' パラメータによって複数のタクソノミー検索の関係を指定します。
  
'''Simple Taxonomy Query:'''
+
'''シンプルなカスタム分類のクエリー:'''
  
 
Display posts tagged with 'bob', under 'people' custom taxonomy:
 
Display posts tagged with 'bob', under 'people' custom taxonomy:
285行目: 285行目:
 
</pre>
 
</pre>
  
'''Multiple Taxonomy Handling:'''
+
'''複数のカスタム分類の取り扱い:'''
  
Display posts from several custom taxonomies:
+
いくつかのカスタム分類から記事を表示します:
  
 
  $query = new WP_Query( array( 'people' => 'bob', 'language' => 'english' ) );
 
  $query = new WP_Query( array( 'people' => 'bob', 'language' => 'english' ) );
  
Display posts from several custom taxonomies, using 'tax_query':
+
'tax_query'を使って、いくつかのカスタム分類から記事を表示します:
  
 
<pre>
 
<pre>
334行目: 334行目:
 
</pre>
 
</pre>
  
'''Nested Taxonomy Handling:'''
+
'''ネストされたカスタム分類の取扱い:'''
  
Starting with [[Version_4.1|4.1]], <tt>'tax_query'</tt> clauses can be nested, to create more complex queries. Example: Display '''posts''' that are in the '''quotes''' category OR both have the '''quote''' post format AND are in the '''wisdom''' category:
+
[[Version_4.1|4.1]]以降から、より複雑なクエリを作成のために、<tt>'tax_query'</tt> 句を入れ子にすることができます。
 +
 
 +
: Display '''posts''' that are in the '''quotes''' category OR both have the '''quote''' post format AND are in the '''wisdom''' category:
  
 
<pre>
 
<pre>

2015年6月14日 (日) 22:39時点における版

このページ「関数リファレンス/WP Query」は一部未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

WP_Queryの役割

WP_Querywp-includes/query.php に定義されているクラスで、WordPress ブログへの複雑なリクエストを取り扱います。 wp-blog-header.php (バージョン 2.0 では WP クラス) が $wp_query オブジェクトに現在のリクエストを定義する情報を与えることで、$wp_query はどのタイプのクエリを扱っているのか (カテゴリーアーカイブ、年月別アーカイブ、フィード、検索など) を確定し、要求された投稿を取り出します。$wp_query はリクエスト上の情報を多く保持していて、後からでも利用することができます。

メソッドとプロパティ

これはWP_Queryの公式な文書です。プロパティを直接書き換えるべきではありません。その代わりにメソッドを使って操作することができます。クラスのメンバとグローバル変数がしっちゃかめっちゃかになることを避ける便利な関数がありますので、WP_Queryに働きかけるを参考にしてください。

プロパティ

$query
$wp_query オブジェクトに WP クラスによって渡されたクエリストリングを含む。
$query_vars
解析された $query を保持する連想配列。クエリ変数と対応する値の配列。
$queried_object
リクエストがカテゴリー、作者ページ、パーマリンク、または固定ページだった場合に適用される。リクエストされたクエリの情報を含む。
$queried_object_id
リクエストがカテゴリー、作者ページ、パーマリンク、または固定ページだった場合、対応する ID を含む。
$posts
要求された投稿をデータベースから取得したもの。
$post_count
表示される投稿の数。
$found_posts
現在のクエリ変数に一致する投稿の合計数。
$max_num_pages
ページの合計数。$found_posts を $posts_per_page で割った結果。
$current_post
(ループ内でのみ使用可能) 表示されようとしている投稿の数。
$post
(ループ内でのみ使用可能) 現在表示されている投稿。
$is_single, $is_page, $is_archive, $is_preview, $is_date, $is_year, $is_month, $is_time, $is_author,

$is_category, $is_tag, $is_tax, $is_search, $is_feed, $is_comment_feed, $is_trackback, $is_home, $is_404, $is_comments_popup, $is_admin, $is_attachment, $is_singular, $is_robots, $is_posts_page, $is_paged

ブーリアンリクエストがどのタイプなのかを判断する。最初の3つの例で言えば、「これはパーマリンクか?」「これは固定ページか?」「これは何らかのアーカイブページか?」となる。

メソッド

(メソッド名の前にあるアンパサンド(&)はそれが参照渡しであることを示します。)

init()
オブジェクトを初期化して、すべてのプロパティをnull、ゼロ、falseにセットする。
parse_query($query)
リクエストを定義するクエリ文字列を受け取り、それを解析して$posts$post_count$post$current_post以外のすべてのプロパティを返す。
parse_query_vars()
古いクエリ文字列をもう一度解析する。
get($query_var)
指定されたクエリ変数を取得する。
set($query_var, $value)
指定されたクエリ変数を任意の値に設定する。
&get_posts()
要求された投稿をデータベースから取得して返す。$posts$post_countも返す。
next_post()
(ループ内でのみ使用可能) $posts で次の投稿に進む。$current_post を1つ増やし、$post を (新規の) 現在の投稿オブジェクトに設定する (注: グローバル $post 変数を設定はせず、WP_Query オブジェクトのインスタンス変数のみに適用される) 。現在の投稿オブジェクトを返す。
the_post()
(ループ内でのみ使用可能)次の投稿に進み、グローバル変数$postを設定する。
have_posts()
(ループ内か、ループの前でのみ使用可能) 表示する投稿が残っているかを示す。
rewind_posts()
$current_post$postをリセットする。
&query($query)
parse_query()get_posts()を呼び出し、get_posts()の結果を返す。
get_queried_object()
$queried_objectを設定し、それがまだ設定されていなければ、返す。
get_queried_object_id()
$queried_object_idを設定し、それがまだ設定されていなければ返す。
WP_Query($query = '') (コンストラクタ)
クエリ文字列を与えれば、それを使ってquery()を呼び出す。

WP_Queryに働きかける

ほとんどの場合、クラスの内部やグローバル変数を使わなくても欲しい情報は手に入れられるでしょう。どこからでも欲しい情報を手に入れるために、厖大な数の関数があるのですから。

WP_Queryを使いたくなるかもしれないケースが二つあります。一つは、WordPressが今扱っているリクエストがどんなものかを知るためです。$is_*プロパティはこの情報を持つよう設計されています: このためには条件分岐タグを使ってください。これはプラグイン作者 (そして、テーマ作者) によくあるケースです。

二つ目はループの中です。WP_Queryはループ内において、よくある要望を実現するための厖大な関数を備えています。たとえば$wp_query->have_posts()を呼び出すhave_posts()は、表示すべき投稿があるかどうかを判断するために呼び出されます。whileループの開始時に、have_posts()を条件として使います。このループは表示すべき投稿がある限り反復されます。反復処理を行うごとに、$wp_query->the_post()を呼び出す the_post() が呼び出され、$wp_query 内の変数とグローバル変数 $post (テンプレートタグはこれに依存します) を設定します。これは上で見た通りです。ループを必要とするテーマを作っている時、使うべき関数はたくさんあります。詳しくはループThe Loop in Action をご覧ください。

注意: あなたのクエリで the_post() を使うのなら、クエリの後に wp_reset_postdata() を実行する必要があります。テンプレートタグがメインクエリの現在の記事を再び使えるようにするためです。

用例

<?php

// クエリ
$the_query = new WP_Query( $args );

// ループ
while ( $the_query->have_posts() ) : $the_query->the_post();
	echo '<li>';
	the_title();
	echo '</li>';
endwhile;

// 投稿データをリセット
wp_reset_postdata();

?>

パラメータ

投稿者パラメータ

ある投稿者に関連付けられた投稿を表示する。

  • author (int) - ユーザーID。
  • author_name (string) - 'user_nicename' (姓・名・ニックネームではなく)。
  • author__in (array) - ユーザーID (バージョン 3.7以降で利用可能)。
  • author__not_in (array) - ユーザーID (バージョン 3.7以降で利用可能)。

ひとりの投稿者の投稿を表示する

ユーザーIDを用いて、ある投稿者の記事を表示する場合:

$query = new WP_Query( 'author=123' );

'user_nicename' を用いて、ある投稿者の記事を表示する場合:

$query = new WP_Query( 'author_name=rami' );

複数の投稿者の投稿を表示する

複数の、特定の投稿者の記事を表示する場合:

$query = new WP_Query( 'author=2,6,17,38' );

ある投稿者による記事を除外する

'-'(マイナス)記号をユーザーIDの頭につけることで、あるひとりの投稿者による記事を除く、すべての記事を表示できます:

$query = new WP_Query( 'author=-12' );

複数の投稿者を扱う

複数の投稿者の記事を表示する:

$query = new WP_Query( array( 'author__in' => array( 2, 6 ) ) );

以下の方法で複数の投稿者を除外することもできます:

$query = new WP_Query( array( 'author__not_in' => array( 2, 6 ) ) );

カテゴリーパラメータ

あるカテゴリーに関連付けられた投稿を表示する。

  • cat (int) - カテゴリIDを使用します。
  • category_name (string) - カテゴリのスラッグ(カテゴリ名ではありません)を使用します。
  • category__and (array) - カテゴリIDを使用します。
  • category__in (array) - カテゴリIDを使用します。
  • category__not_in (array) -カテゴリIDを使用します。

1つのカテゴリの記事を表示

カテゴリIDを使用して、そのカテゴリ(さらにそのカテゴリの子カテゴリ)に属する記事を表示:

$query = new WP_Query( 'cat=4' );

カテゴリスラッグを使用して、そのカテゴリ(さらにそのカテゴリの子カテゴリ)に属する記事を表示:

$query = new WP_Query( 'category_name=staff' );

複数のカテゴリから記事を表示

カテゴリIDを使用して、それらのカテゴリに属する記事を表示:

$query = new WP_Query( 'cat=2,6,17,38' );

カテゴリスラッグを使用して、それらのカテゴリに属する記事を表示:

$query = new WP_Query( 'category_name=staff,news' );

カテゴリに属する記事を除外

IDに'-'(マイナス記号)が付いたカテゴリの記事を除くすべての記事を表示:

$query = new WP_Query( 'cat=-12,-34,-56' );

複数カテゴリの扱い

複数のカテゴリに属する記事を表示。下記はカテゴリID 2と6の両方に属する記事を表示します:

$query = new WP_Query( array( 'category__and' => array( 2, 6 ) ) );

カテゴリID 2または6の記事を表示するには、前述の cat か、または category__in(これらのカテゴリの子カテゴリの記事は表示されないことに注意してください)を使うことで実現します:

$query = new WP_Query( array( 'category__in' => array( 2, 6 ) ) );

下記の方法で、複数のカテゴリの記事を除外することもできます:

$query = new WP_Query( array( 'category__not_in' => array( 2, 6 ) ) );

タグパラメータ

あるタグに関連付けられた投稿を表示する。

  • tag (文字列) - タグのスラッグを指定。
  • tag_id (整数) - タグ ID を指定。
  • tag__and (配列) - タグ ID を指定。
  • tag__in (配列) - タグ ID を指定。
  • tag__not_in (配列) - タグ ID を指定。
  • tag_slug__and (配列) - タグのスラッグを指定。
  • tag_slug__in (配列) - タグのスラッグを指定。

1つのタグの記事を表示

タグのスラッグを使って、このタグを持つ記事を表示:

$query = new WP_Query( 'tag=cooking' );

タグのIDを使って、このタグを持つ記事を表示:

$query = new WP_Query( 'tag_id=13' );

複数のタグから記事を表示

これらのいずれかのタグを持つ記事を表示:

$query = new WP_Query( 'tag=bread,baking' );

これらのすべてのタグを持つ記事を表示:

$query = new WP_Query( 'tag=bread+baking+recipe' );

複数タグの扱い

タグID 37 と 47 の両方にタグ付けられた記事を表示:

$query = new WP_Query( array( 'tag__in' => array( 37, 47 ) ) );

タグID 37 と 47 いずれかの記事を表示するには、前述の tag か、もしくは tag__in を使って明示的に特定することで実現します:

$query = new WP_Query( array( 'tag__in' => array( 37, 47 ) ) );

タグID 37 と 47 、2つのタグのいずれも持たない記事を表示:

$query = new WP_Query( array( 'tag__not_in' => array( 37, 47 ) ) );

tag_slug__intag_slug__and は、タグのスラッグを対象とすることを除いて、それぞれ tag__intag__and とほぼ同様に動作します。

タクソノミーパラメータ

あるタクソノミーに関連付けられた投稿を表示する。

  • {tax} (文字列) - タクソノミーのスラッグを使用します。注:バージョン 3.1 以降は非推奨になりましたので、代わりに 'tax_query' を使用してください。
  • tax_query (配列) - タクソノミーパラメータを使用(バージョン 3.1 から利用可能)。
    • relation (文字列) - 2 つ以上のタクソノミー検索条件(内側の配列)が含まれる場合に、それらの論理的な関係を指定します。有効な値は 'AND' または 'OR' です。1 つしかタクソノミー検索条件を含まない場合は指定しないでください。
    • taxonomy (文字列) - タクソノミー。
    • field (文字列) - タクソノミータームの種類を選択します。有効な値は 'term_id'(デフォルト)、'name' または 'slug' です。
    • terms (整数/文字列/配列) - タクソノミーターム。
    • include_children (真偽値) - 階層を持つタクソノミーの場合に子孫タクソノミーを含めるかどうか。デフォルトは true(含める)です。
    • operator (文字列) - 演算子。使用可能な値は 'IN'(デフォルト)、'NOT IN' または 'AND' です。

重要な参考ポイント: tax_query は、タクソノミー検索条件(配列)の配列 をパラメータにします(つまり配列の配列です)。下記の 2 番目の例を見るとわかりやすいでしょう。この構造によって、複数のタクソノミーを検索できますが、その時は最初の(外側の)配列の relation パラメータによって複数のタクソノミー検索の関係を指定します。

シンプルなカスタム分類のクエリー:

Display posts tagged with 'bob', under 'people' custom taxonomy:

$query = new WP_Query( array( 'people' => 'bob' ) );

Display posts tagged with 'bob', under 'people' custom taxonomy, using 'tax_query':

$args = array(
	'tax_query' => array(
		array(
			'taxonomy' => 'people',
			'field' => 'slug',
			'terms' => 'bob'
		)
	)
);
$query = new WP_Query( $args );

複数のカスタム分類の取り扱い:

いくつかのカスタム分類から記事を表示します:

$query = new WP_Query( array( 'people' => 'bob', 'language' => 'english' ) );

'tax_query'を使って、いくつかのカスタム分類から記事を表示します:

$args = array(
	'tax_query' => array(
		'relation' => 'AND',
		array(
			'taxonomy' => 'movie_janner',
			'field' => 'slug',
			'terms' => array( 'action', 'commedy' )
		),
		array(
			'taxonomy' => 'actor',
			'field' => 'id',
			'terms' => array( 103, 115, 206 ),
			'operator' => 'NOT IN'
		)
	)
);
$query = new WP_Query( $args );

Display posts that are in the 'quotes' category OR have the 'quote' format:

$args = array(
	'tax_query' => array(
		'relation' => 'OR',
		array(
			'taxonomy' => 'category',
			'field' => 'slug',
			'terms' => array( 'quotes' )
		),
		array(
			'taxonomy' => 'post_format',
			'field' => 'slug',
			'terms' => array( 'post-format-quote' )
		)
	)
);
$query = new WP_Query( $args );

ネストされたカスタム分類の取扱い:

4.1以降から、より複雑なクエリを作成のために、'tax_query' 句を入れ子にすることができます。

例: Display posts that are in the quotes category OR both have the quote post format AND are in the wisdom category:

$args = array(
	'post_type' => 'post',
	'tax_query' => array(
		'relation' => 'OR',
		array(
			'taxonomy' => 'category',
			'field'    => 'slug',
			'terms'    => array( 'quotes' ),
		),
		array(
                        'relation' => 'AND',
                        array(
			        'taxonomy' => 'post_format',
			        'field'    => 'slug',
			        'terms'    => array( 'post-format-quote' ),
                        ),
                        array(
                                'taxnoomy' => 'category',
                                'field'    => 'slug',
                                'terms'    => array( 'wisdom' ),
                        ),
		),
	),
);
$query = new WP_Query( $args );

投稿&固定ページパラメータ

投稿および固定ページに基づいてコンテンツを表示する。

  • p (int) - 投稿のIDを使用する。
  • name (string) - 投稿のスラッグを使用する。
  • page_id (int) - 固定ページのIDを使用する。
  • pagename (string) - 固定ページのスラッグを使用する。
  • post_parent (int) - 固定ページのIDを使用する。子ページを返す。
  • post__in (array) - use post ids. Specify posts to retrieve.
  • post__not_in (array) - use post ids. Specify post NOT to retrieve.

Show Post/Page by ID

投稿のIDを指定して表示する:

$query = new WP_Query( 'p=7' );

固定ページのIDを指定して表示する:

$query = new WP_Query( 'page_id=7' );

Show Post/Page by Slug

投稿のスラッグを指定して表示する:

$query = new WP_Query( 'name=about-my-life' );

固定ページのスラッグを指定して表示する:

$query = new WP_Query( 'pagename=contact' );

Show Child Posts/Pages

Display child page using the slug of the parent and the child page, separated by a slash (e.g. 'parent_slug/child_slug'):

$query = new WP_Query( 'pagename=contact_us/canada' );

Display child pages using parent page ID:

$query = new WP_Query( 'post_parent=93' );

Multiple Posts/Pages Handling

Display only the specify posts:

$query = new WP_Query( array( 'post__in' => array( 2, 5, 12, 14, 20 ) ) );

Display all posts but NOT the specified ones:

$query = new WP_Query( array( 'post__not_in' => array( 2, 5, 12, 14, 20 ) ) );

Note: you cannot combine 'post__in' and 'post__not_in' in the same query.

タイプ&ステータスパラメータ

ある投稿タイプまたは投稿ステータスに関連付けられた投稿を表示する。

  • post_type (string / array) - 投稿を[[投稿タイプ]によって取得する。デフォルト値は 'post'。'tax_query' がクエリーにセットされている場合、デフォルト値は 'any' になります。
    • 'post' - 投稿。
    • 'page' - 固定ページ。
    • 'revision' - 履歴 (リビジョン) 。
    • 'attachment' - 添付ファイル。 The default WP_Query sets 'post_status'=>'published', but attachments default to 'post_status'=>'inherit' so you'll need to set the status to 'inherit' or 'any'.
    • 'any' - リビジョンと'exclude_from_search'がtrueにセットされたものを除き、すべてのタイプを含める
    • Custom Post Types (e.g. movies)
  • post_status (string / array) - 投稿ステータスPost Statusを指定します。 デフォルト値は'publish'。
    • 'publish' - 公開された投稿もしくは固定ページ
    • 'pending' - レビュー待ちの投稿
    • 'draft' - 下書きの投稿
    • 'auto-draft' - コンテンツのない、新規作成された投稿
    • 'future' - 予約公開設定された投稿
    • 'private' - ログインしていないユーザーから見えない設定
    • 'inherit' - リビジョン。 get_childrenを参照下さい。
    • 'trash' - ゴミ箱に入った投稿。 (Version 2.9で利用可能).
    • 'any' - 投稿タイプで’exclude_from_search’がtrueにセットされているものを除き、すべてのステータスの投稿を取得する。

Show Post by Type

固定ページのみ表示する:

$query = new WP_Query( 'post_type=page' );

Display 'any' post type (retrieves any type except revisions and types with 'exclude_from_search' set to TRUE):

$query = new WP_Query( 'post_type=any' );

Display multiple post types, including custom post types:

$query = new WP_Query( array( 'post_type' => array( 'post', 'page', 'movie', 'book' ) ) );

ステータスによる投稿の表示

Display only drafts:

$query = new WP_Query( 'post_status=draft' );

Display multiple post status:

$query = new WP_Query( array( 'post_status' => array( 'pending', 'draft', 'future' ) ) );

Display all attachments:

$query = new WP_Query( array( 'post_status' => 'any', 'post_type' => 'attachment' ) );

ページ送りパラメータ

  • showposts (int) - number of post to show per page. Deprecated as of Version 2.1 in favor of 'posts_per_page'.
  • posts_per_page (int) - number of post to show per page (available with Version 2.1). Use 'posts_per_page'=>-1 to show all posts. Note if the query is in a feed, wordpress overwrites this parameter with the stored 'posts_per_rss' option. To reimpose the limit, try using the 'post_limits' filter, or filter 'pre_option_posts_per_rss' and return -1
  • posts_per_archive_page (int) - number of posts to show per page - on archive pages only. Over-rides showposts and posts_per_page on pages where is_archive() or is_search() would be true
  • nopaging (bool) - show all posts or use pagination. Default value is 'false', use paging.
  • paged (int) - number of page. Show the posts that would normally show up just on page X when using the "Older Entries" link.

Show x Posts per page

Display 3 posts per page:

$query = new WP_Query( 'posts_per_page=3' );

Show All Post

Display all posts in one page:

$query = new WP_Query( 'posts_per_page=-1' );

Display all posts by disabling pagination:

$query = new WP_Query( 'nopaging=true' );

Show Posts from page x

Display posts from page number 6:

$query = new WP_Query( 'paged=6' );

Show Posts from Current Page

Display posts from current page:

$query = new WP_Query( 'paged=' . get_query_var( 'page' ) );

Pagination Note: You should set get_query_var( 'page' ); if you want your query to work with pagination. Since Wordpress 3.0.2, you do get_query_var( 'page' ) instead of get_query_var( 'paged' ). The pagination parameter 'paged' for WP_Query() remains the same.

オフセットパラメータ

  • offset (int) - number of post to displace or pass over.

Pass over 3 Posts

Display posts from the 4th one:

$query = new WP_Query( 'offset=3' ) );

Show 5 Posts starting from the second one

Display 5 posts per page which follow the most recent (1):

$query = new WP_Query( array( 'posts_per_page' => 5, 'offset' => 1 ) );

Note: Setting offset parameter will ignore the paged parameter.

順序&順序ベースパラメータ

投稿の並びを指定する。

  • order (string) - Designates the ascending or descending order of the 'orderby' parameter. デフォルトは降順 'DESC'です。
    • 'ASC' - 最低から最高に昇順 (1, 2, 3; a, b, c).
    • 'DESC' - 最高から最低に降順 (3, 2, 1; c, b, a).
  • orderby (string) - パラメーターによって投稿をソートする。デフォルト値は 'date'です。
    • 'none' - No order (Version 2.8で使用可能)
    • 'ID' - 投稿IDで並び替える。大文字に注意。
    • 'author' - 著者で並び替える。
    • 'title' - タイトルで並び替える。
    • 'date' - 日付で並び替える。
    • 'modified' - 更新日で並び替える。
    • 'parent' - 投稿/固定ページの親ID順。
    • 'rand' - ランダムで並び替える。
    • 'comment_count' - コメント数で並び替える (Version 2.9で使用可能)
    • 'menu_order' - ページの表示順で並び替える。 固定ページで最も使用される (Order field in the Edit Page Attributes box) and for Attachments (the integer fields in the Insert / Upload Media Gallery dialog), but could be used for any post type with distinct 'menu_order' values (they all default to 0).
    • 'meta_value' - Note that a 'meta_key=keyname' must also be present in the query. Note also that the sorting will be alphabetical which is fine for strings (i.e. words), but can be unexpected for numbers (e.g. 1, 3, 34, 4, 56, 6, etc, rather than 1, 3, 4, 6, 34, 56 as you might naturally expect).
    • 'meta_value_num' - 数値として並び替える。 (Version 2.8で使用可能。). Also note that a 'meta_key=keyname' must also be present in the query. This value allows for numerical sorting as noted above in 'meta_value'.

タイトルで投稿をソート表示、降順

Display posts sorted by post title in a descending order:

$query = new WP_Query( array ( 'orderby' => 'title', 'order' => 'DESC' ) );

ランダムに投稿を表示

Display one random post:

$query = new WP_Query( array ( 'orderby' => 'rand', 'posts_per_page' => '1' ) );

人気の投稿を表示

Display posts ordered by comment count:

$query = new WP_Query( array( 'orderby' => 'comment_count' ) );

値段順にソートした商品を表示

Display posts with 'Product' type ordered by 'Price' custom field:

$query = new WP_Query( array ( 'post_type' => 'product', 'orderby' => 'meta_value', 'meta_key' => 'price' ) );

'orderby'で複数の値

Display pages ordered by 'title' and 'menu_order':

$query = new WP_Query( array( 'post_type' => 'page', 'orderby' => 'title menu_order', 'order' => 'ASC' ) );

Multiple 'orderby' values using an array

Display pages ordered by 'title' and 'menu_order' with different sort orders (ASC/DESC) (available since Version 4.0):

$args = array(
	'orderby' => array( 'title' => 'DESC', 'menu_order' => 'ASC' )
);
$query = new WP_Query( $args );


Mulitiple orderby/order pairs

$args = array(
	'orderby'  => array( 'meta_value_num' => 'DESC', 'title' => 'ASC' ),
	'meta_key' => 'age'
);
$query = new WP_Query( $args );

' 'meta_value' とカスタム投稿タイプで orderby 

Display posts of type 'my_custom_post_type', ordered by 'age', and filtered to show only ages 3 and 4 (using meta_query).

$args = array(
	'post_type'  => 'my_custom_post_type',
	'meta_key'   => 'age',
	'orderby'    => 'meta_value_num',
	'order'      => 'ASC',
	'meta_query' => array(
		array(
			'key'     => 'age',
			'value'   => array( 3, 4 ),
			'compare' => 'IN',
		),
	),
);
$query = new WP_Query( $args );


このページ「関数リファレンス/WP Query」はまだ書きかけで、情報が不足しています。続きを書いて WordPress を手助けしましょう.


Do you know how to sort the query if the meta_value is an array? Write it here :)

先頭固定投稿パラメータ

Show この投稿を先頭に固定表示 /en Sticky Posts or ignore them.

  • caller_get_posts (bool) - ignore sticky posts or not. Deprecated as of Version 3.1 in favor of 'ignore_sticky_posts'.
  • ignore_sticky_posts (bool) - ignore sticky posts or not. Default value is 0, don't ignore. Ignore/exclude sticky posts being included at the beginning of posts returned, but the sticky post will still be returned in the natural order of that list of posts returned.

Show Sticky Posts

Display just the first sticky post:

$sticky = get_option( 'sticky_posts' );
$query = new WP_Query( 'p=' . $sticky[0] );

Display just the first sticky post, if none return the last post published:

$args = array(
	'posts_per_page' => 1,
	'post__in'  => get_option( 'sticky_posts' ),
	'ignore_sticky_posts' => 1
);
$query = new WP_Query( $args );

Display just the first sticky post, if none return nothing:

$sticky = get_option( 'sticky_posts' );
$args = array(
	'posts_per_page' => 1,
	'post__in'  => $sticky,
	'ignore_sticky_posts' => 1
);
$query = new WP_Query( $args );
if ( $sticky[0] ) {
	// insert here your stuff...
}

Don't Show Sticky Posts

Exclude all sticky posts from the query:

$query = new WP_Query( array( 'post__not_in' => get_option( 'sticky_posts' ) ) );

Exclude sticky posts from a category. Return ALL posts within the category, but don't show sticky posts at the top. The 'sticky posts' will still show in their natural position (e.g. by date):

$query = new WP_Query( 'ignore_sticky_posts=1&posts_per_page=3&cat=6' );

Exclude sticky posts from a category. Return posts within the category, but exclude sticky posts completely, and adhere to paging rules:

$paged = get_query_var( 'paged' ) ? get_query_var( 'paged' ) : 1;
$sticky = get_option( 'sticky_posts' );
$args = array(
	'cat' => 3,
	'ignore_sticky_posts' => 1,
	'post__not_in' => $sticky,
	'paged' => $paged
);
$query = new WP_Query( $args );

時間パラメータ

ある期間に関連付けられた投稿を表示する。

  • year (int) - 4ケタの年 (例. 2011).
  • monthnum (int) - 月 (1 から 12).
  • w (int) - 週数 (0 から 53). Uses the MySQL WEEK command Mode=1.
  • day (int) - 日 (1 から 31).
  • hour (int) - 時 (0 から 23).
  • minute (int) - 分 (0 から 60).
  • second (int) - 秒 (0 から 60).

現在の日付の記事を返す:

$today = getdate();
$query = new WP_Query( 'year=' . $today["year"] . '&monthnum=' . $today["mon"] . '&day=' . $today["mday"] );

今週の記事を返す:

$week = date('W');
$year = date('Y');
$query = new WP_Query( 'year=' . $year . '&w=' . $week );

12月20日の投稿を返す:

$query = new WP_Query( 'monthnum=12&day=20' );

Note: The queries above return posts for a specific date period in history, i.e. "Posts from X year, X month, X day". They are unable to fetch posts from a timespan relative to the present, so queries like "Posts from the last 30 days" or "Posts from the last year" are not possible with a basic query, and require use of the posts_where filter to be completed. The examples below use the posts_where filter, and should be modifyable for most time-relative queries.

2009年3月1日から3月15日までの投稿を返す:

// Create a new filtering function that will add our where clause to the query
function filter_where( $where = '' ) {
	// posts for March 1 to March 15, 2010
	$where .= " AND post_date >= '2010-03-01' AND post_date < '2010-03-16'";
	return $where;
}

add_filter( 'posts_where', 'filter_where' );
$query = new WP_Query( $query_string );
remove_filter( 'posts_where', 'filter_where' );

過去30日間からの投稿を返す:

// Create a new filtering function that will add our where clause to the query
function filter_where( $where = '' ) {
	// posts in the last 30 days
	$where .= " AND post_date > '" . date('Y-m-d', strtotime('-30 days')) . "'";
	return $where;
}

add_filter( 'posts_where', 'filter_where' );
$query = new WP_Query( $query_string );
remove_filter( 'posts_where', 'filter_where' );

30から60日経過した投稿を返す

// Create a new filtering function that will add our where clause to the query
function filter_where( $where = '' ) {
	// posts  30 to 60 days old
	$where .= " AND post_date >= '" . date('Y-m-d', strtotime('-60 days')) . "'" . " AND post_date <= '" . date('Y-m-d', strtotime('-30 days')) . "'";
	return $where;
}

add_filter( 'posts_where', 'filter_where' );
$query = new WP_Query( $query_string );
remove_filter( 'posts_where', 'filter_where' );

Starting with 4.1, 'date_query' clauses can be nested in order to construct complex queries. See タクソノミーパラメータ for details on the syntax.


カスタムフィールドパラメータ

あるカスタムフィールドに関連付けられた投稿を表示する。

  • meta_key (string) - カスタムフィールドキー
  • meta_value (string) - カスタブフィールドの値
  • meta_compare (string) -'meta_value'のテスト演算子。 使える値は '!=', '>', '>=', '<', '<='です。デフォルト値は'='です。
  • meta_query (array) - カスタムフィールドのパラメータ (Version 3.1より利用可能)
    • key (string) - カスタムフィールドキー
    • value (string|array) - カスタブフィールドの値 (Note: Array support is limited to a compare value of 'IN', 'NOT IN', 'BETWEEN', or 'NOT BETWEEN')
    • compare (string) - テスト演算子。 使える値は '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'です。デフォルト値は '='です。
    • type (string) - カスタムフィールド投稿タイプ。 使える値は 'NUMERIC', 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED'です。 デフォルト値は'CHAR'です。

簡単なカスタムフィールドクエリ:

カスタムフィールドの値に関係なく、カスタムフィールドのキーが'color'の記事を表示します:

$query = new WP_Query( 'meta_key=color' );

カスタムフィールドのキーに関係なく、カスタムフィールドの値が'blue'の記事を表示します:

$query = new WP_Query( 'meta_value=blue' );

Display Page where the custom field value is 'blue', regardless of the custom field key:

$query = new WP_Query( 'meta_value=blue&post_type=page' );

Display posts where the custom field key is 'color' and the custom field value is 'blue':

$query = new WP_Query( array( 'meta_key' => 'color', 'meta_value' => 'blue' ) );

Display posts where the custom field key is 'color' and the custom field value IS NOT 'blue':

$query = new WP_Query( array( 'meta_key' => 'color', 'meta_value' => 'blue', 'meta_compare' => '!=' ) );

Display 'product'(s) where the custom field key is 'price' and the custom field value that is LESS THAN OR EQUAL TO 22. Note the value 99 will be considered greater than 100 as the data is stored as 'strings', not 'numbers'.

$query = new WP_Query( array( 'meta_key' => 'price', 'meta_value' => '22', 'meta_compare' => '<=', 'post_type' => 'product' ) );

Display posts with a custom field value of zero (0), regardless of the custom field key:

$query = new WP_Query( array ( 'meta_value' => '_wp_zero_value' ) );

Single Custom Field Handling:

Display posts from a single custom field:

$args = array(
	'post_type' => 'product',
	'meta_query' => array(
		array(
			'key' => 'color',
			'value' => 'blue',
			'compare' => 'NOT LIKE'
		)
	)
 );
$query = new WP_Query( $args );

(Note that meta_query expects nested arrays, even if you only have one query.)

Multiple Custom Field Handling:

Display posts from several custom field:

$args = array(
	'post_type' => 'product',
	'meta_query' => array(
		array(
			'key' => 'color',
			'value' => 'blue',
			'compare' => 'NOT LIKE'
		),
		array(
			'key' => 'price',
			'value' => array( 20, 100 ),
			'type' => 'numeric',
			'compare' => 'BETWEEN'
		)
	)
 );
$query = new WP_Query( $args );

Display posts that have meta key 'color' NOT LIKE value 'blue' OR meta key 'price' with values BETWEEN 20 and 100:

 $args = array(
 	'post_type' => 'product',
 	'meta_query' => array(
		'relation' => 'OR',
 		array(
 			'key' => 'color',
 			'value' => 'blue',
 			'compare' => 'NOT LIKE'
 		),
 		array(
 			'key' => 'price',
 			'value' => array( 20, 100 ),
 			'type' => 'numeric',
 			'compare' => 'BETWEEN'
 		)
 	)
  );
 $query = new WP_Query( $args );

Starting with version 4.1, meta_query clauses can be nested in order to construct complex queries. For example, "show me productss where color=orange OR color=red&size=small" translates to the following:

$args = array(
	'post_type'  => 'product',
	'meta_query' => array(
		'relation' => 'OR',
		array(
			'key'     => 'color',
			'value'   => 'orange',
			'compare' => '=',
		),
                array(
                        'relation' => 'AND',
                        array(
                                'key' => 'color',
                                'value' => 'red',
                                'compare' => '=',
                        ),
                        array(
                                'key' => 'size',
                                'value' => 'small',
                                'compare' => '=',
                        ),
		),
	),
);
$query = new WP_Query( $args );


権限パラメータ

ユーザーが適切な権限を持っている場合、公開済み投稿およびプライベート投稿を表示する。

$query = new WP_Query( array( 'post_status' => array( 'publish', 'private' ), 'perm' => 'readable' ) );

フィルター

  • posts_distinct /en - Alters SQL 'DISTINCTROW' clause to the query that returns the post array.
  • posts_groupby /en - Alters SQL 'GROUP BY' clause of the query that returns the post array.
  • posts_join /en - Alters SQL 'JOIN' clause of the query that returns the post array.
  • post_limits /en - Alters SQL 'LIMIT' clause of the query that returns the post array.
  • posts_orderby /en - Alters SQL 'ORDER BY' clause of the query that returns the post array.
  • posts_where /en - Alters SQL 'WHERE' clause of the query that returns the post array.
  • posts_join_paged /en - Alters SQL paging for posts using 'JOIN' clause of the query that returns the post array.
  • posts_where_paged /en - Alters SQL paging for posts using 'WHERE' clause of the query that returns the post array.
  • posts_clauses /en (since WP 3.1) - Alters all the SQL clauses above in one go. It gives you an array of elements that are easy to alter.

Note, that there are more filters than the mentioned. As it is hard to keep the codex up to date, please inspect the get_posts(); function inside the WP_Query class yourself (/wp-includes/query.php).

ソースファイル

WP_Query()wp-includes/query.phpにあります。

外部リソース

日本語

英語

関連

記事

コード・ドキュメンテーション

  • クラス: WP_Query - WP_Query クラスの詳細な全容
  • クラス: WP_Comment_Query - コメント関連のクエリのためのクラス
  • クラス: WP_User_Query - ユーザー関連のクエリのためのクラス
  • オブジェクト: $wpdb - $wpdb オブジェクトの使い方全容
  • 関数: set_query_var()
  • 関数: get_query_var()
  • 関数: query_posts() - 追加のカスタムクエリを作成
  • 関数: get_post() - 項目の ID を取得しデータベース内にあるその投稿のレコードを返す
  • 関数: get_posts() - 投稿の配列を返すことに特化した関数
  • 関数: get_pages() - ページの配列を返すことに特化した関数
  • 関数: have posts() - クエリが投稿を返すか否かを判断する条件関数
  • 関数: the_post() - クエリ後に自動的にループを設定する
  • 関数: rewind_posts() - 現状のループをリセットする
  • 関数: setup_postdata() - ループ内で個別の結果を得るためのクエリデータを設定する
  • 関数: wp_reset_postdata() - 直前のクエリを復元する (通常はループ内の別のループの後に用いられる)
  • 関数: wp_reset_query()
  • 関数: is_main_query() - 変更されるクエリがメインのクエリであることを確認する
  • アクションフック: pre_get_posts - WordPressクエリが実行される前に変更する
  • アクションフック: the_post - post クエリの後で post オブジェクトを変更する
  • フィルターフック: found_posts - WP_Query オブジェクトの found_posts 値を変更する


クラスリファレンス関数リファレンスの各インデックスも参照してください。

最新英語版: WordPress Codex » Function Reference/WP Query最新版との差分