WP_Queryで使えるコード一覧チートシート

6463 Views
WordPress
WP_Queryで使えるコード一覧チートシート

おそらく5年程前にたまたま見つけてそれを保存して以来ずっと使わせていただいているWP_Queryで使えるコード表。

どのサイトからコピーさせてもらったかは覚えていませんが、これからWordPressで四苦八苦する方の助けに少しでもなれば良いと思い私のサイトでも公開させていただきます。

SNSでシェア♪

スポンサーリンク

WP_Queryチートシート

<?php
//指定可能な条件一覧
$args = array( 
	//著者パラメーター - 特定の著者に関連付けられた投稿を表示する。
	'author'         => '1,2,3',						//(int) - 著者ID [マイナス(-)を使用することで特定の著者を省くことができる 例: 'author' => '-1,-2,-3,']
	'author_name'    => 'luetkemj',						//(string) - 'user_nicename'を指定する(名前ではない)。
	'author__in'     => array(2, 6),					//(array) - 著者ID(バージョン3.7以降)。
	'author__not_in' => array(2, 6),					//(array) - 著者ID(バージョン3.7以降)。


	//カテゴリーパラメーター - 特定のカテゴリーに関連付けられた投稿を表示する。
	'cat'              => 5,							//(int) - use category id.
	'category_name'    => 'staff, news',				//(string) - 指定したカテゴリーのいずれかに属する投稿を表示する。カテゴリースラッグで指定する。
	'category_name'    => 'staff+news',					//(string) - 指定したカテゴリーの「全て」を持つ投稿を表示する。カテゴリースラッグで指定する。
	'category__and'    => array(2, 6),					//(array) - カテゴリーIDを指定する。
	'category__in'     => array(2, 6),					//(array) - カテゴリーIDを指定する。
	'category__not_in' => array(2, 6),					//(array) - カテゴリーIDを指定する。


	//タグパラメーター - 特定のタグに関連付けられた投稿を表示する。
	'tag'           => 'cooking',						//(string) - タグスラッグを指定する。
	'tag_id'        => 5,								//(int) - タグIDを指定する。
	'tag__and'      => array(2, 6),						//(array) - タグIDを指定する。
	'tag__in'       => array(2, 6),						//(array) - タグIDを指定する。
	'tag__not_in'   => array(2, 6),						//(array) - タグIDを指定する。
	'tag_slug__and' => array( 'red', 'blue'),			//(array) - タグスラッグを指定する。
	'tag_slug__in'  => array( 'red', 'blue'),			//(array) - タグスラッグを指定する。


	//タクソノミーパラメーター - 特定のタクソノミーに関連付けられた投稿を表示する。
	//重要: tax_queryはタクソノミークエリー引数の配列(入れ子の配列)をとる
	//この設定はリレーションパラメーターによって複数のタクソノミークエリーを指定している。配列の先頭でタクソノミークエリー間の関連を指定している。
	'tax_query' => array(					 			//(array) - タクソノミーパラメーターを指定する(バージョン3.1以降で有効)。
		'relation' => 'AND',							//(string) - それぞれのタクソノミーを指定するのに'AND'か'OR'が使用できる。
		array(
			'taxonomy' => 'color',						//(string) - タクソノミー。
			'field' => 'slug',							//(string) - IDかスラッグのどちらでタクソノミー項を選択するか
			'terms' => array( 'red', 'blue' ),			//(int/string/array) - タクソノミー項
			'include_children' => true,					//(bool) - 階層構造を持ったタクソノミーの場合に、子タクソノミー項を含めるかどうか。デフォルトはtrue
			'operator' => 'IN'							//(string) - テスト用の演算子。'IN' 'NOT IN' 'AND'のいずれかが使用できる
		),
		array(
			'taxonomy' => 'actor',
			'field' => 'id',
			'terms' => array( 103, 115, 206 ),
			'include_children' => false,
			'operator' => 'NOT IN'
		)
	),


	//投稿&固定ページパラメーター - 投稿または固定ページのパタメーターをもとにコンテンツを表示する。
	'p'                   => 1,							//(int) - 投稿のIDを指定する。
	'name'                => 'hello-world',				//(string) - 投稿のスラッグを指定する。
	'page_id'             => 1,							//(int) - 固定ページのIDを使用する。
	'pagename'            => 'sample-page',				//(string) - ページのスラッグを指定する。
	'pagename'            => 'contact_us/canada',		//(string) - 子ページを表示するには、スラッシュで区切られた親と子のスラッグを指定する。
	'post_parent'         => 1,							//(int) - ページIDを指定して子ページを表示する。(階層構造の投稿タイプでのみ有効)
	'post_parent__in'     => array(1,2,3)				//(array) - 投稿のIDの配列を使用する。投稿が持つべき親を配列で指定する。注意:3.6以降
	'post_parent__not_in' => array(1,2,3),				//(array) - 投稿のIDの配列を使用する。投稿が持つべきでない親を配列で指定する。
	'post__in'            => array(1,2,3),				//(array) - 投稿のIDで表示に含めるものを指定する。注意:先頭固定投稿をしている場合、意図するかどうかに関わらずそれらの投稿も条件に合致する投稿の前に追加される。先頭固定投稿を隠すには、ignore_sticky_postsを使う
	'post__not_in'        => array(1,2,3),				//(array) - 投稿のIDで表示に含めないものを指定する。
	//注意: 'post__in'と'post__not_in'を同じクエリーで同時に使うことはできない


	//パスワードパラメーター
	'has_password' => true,								//(bool) - バージョン3.9以降で利用可能
														//trueでパスワード付きの投稿
														//falseでパスワードが付いていない投稿 
														//nullでパスワードの有無にかかわらず全ての投稿
	'post_password' => 'multi-pass',					//(string) - 特定のパスワードが付いた投稿(バージョン3.9以降で利用可能)


	//タイプ&ステータスパラメーター - 特定のタイプやステータスに関連付けられた投稿を表示する。
	'post_type' => array(	//(string / array) - 投稿タイプを指定する。デフォルト値は'post'で、投稿が表示される。
		'post',											// - 投稿。
		'page',											// - 固定ページ
		'revision',										// - リビジョン。
		'attachment',									// - 添付ファイル。デフォルトのWP_Queryでは'post_status'=>'published'となっているが、添付ファイルは'post_status'=>'inherit'なので、'inherit'または'any'を指定する必要がある。
		'my-post-type'									// - カスタム投稿タイプ (例: movies)
	),
	//注意:'any'キーワードは投稿タイプ、投稿ステータスの両方のクエリーで利用可能だが、配列の中に含めることはできない。 
	'post_type' => 'any',								// - リビジョンと'exclude_from_search'がtrueにセットされたものを除いて、すべてのタイプを含める。


	//タイプ&ステータスパラメーター - 特定のタイプやステータスに関連付けられた投稿を表示する。
	'post_status' => array(								//(string / array) - 投稿ステータスを指定する。デフォルトのは'publish'。		 
		'publish',										// - 公開された投稿または固定ページ。
		'pending',										// - レビュー待ちの投稿。
		'draft',										// - 下書きの投稿。
		'auto-draft'									// - コンテンツのない、新しく作成された投稿。
		'future',										// - 予約公開設定された投稿。
		'private',										// - ログインしていないユーザーには見えない投稿。
		'inherit',										// - リビジョン。get_childrenを参照。
		'trash',										// - ゴミ箱に入った投稿(バージョン2.9以降で有効)。
	),
	//注意:'any'キーワードは投稿タイプ、投稿ステータスの両方のクエリーで利用可能だが、配列の中に含めることはできない。 
	'post_status' => 'any',	// - 投稿タイプで'exclude_from_search'がtrueにセットされているものを除いて、すべてのステータスの投稿を取得する。


	//ページ送りパラメーター
	'posts_per_page'         => 10,						//(int) - 1ページあたりに表示する投稿数(バージョン2.1以降で有効)。'posts_per_page'=1を指定するとすべての投稿を表示する。フィード中のクエリーの場合、WordPressは'posts_per_rss'の値でこのオプションを上書きするので注意する。'post_limits'フィルターで最設定するか、'pre_option_posts_per_rss'フィルターで-1を返す。
	'posts_per_archive_page' => 10,						//(int) - 1ページあたりに表示する投稿数 - アーカイブページのみ。showpostsとposts_per_pageを、is_archive()かis_search()が有効の時に上書きする。
	'nopaging'               => false,					//(bool) - すべての投稿を表示するか、ページ送りを使用するか。デフォルト値は'false'で、ページ送りを使用する。
	'paged'                  => get_query_var('page'),	//(int) - ページ数。通常'Older Entries'リンクで送ったページの数にしたがってそのページで表示される投稿が決まる。
	//注意: クエリーでページ送りを有効にするには、get_query_var('page')を指定するべきだ。WordPress3.0.2以降ではget_query_var( 'paged' )からget_query_var( 'page' )に変更になった。ページ送りパラメータの'paged'はWP_Query()は互換性のために残されている。


	'nopaging'       => false,							// (boolean) - 全ての投稿を表示するか、ページネーションを使用するか。デフォルト値は'false'で、ページ送りを使用する。
	'posts_per_page' => 10,								// (int) - 1ページあたりに表示する投稿数(バージョン2.1以降で利用可能、showpostsパラメーターと置き換え)。'posts_per_page'=>-1を使うと全ての投稿を表示('offset'パラメーターは値が-1の時は無視される)。このパラメーターが使われたあとページネーションが無効の場合、'paged'パラメーターを設定する。
														//注意:フィード中のクエリーでは、wordpressは保存された'posts_per_rss'オプション値でこのパラメーターを上書きする。新たに制限を設定したい場合は、'post_limits'フィルターを使うか、'pre_option_posts_per_rss'フィルターを使い-1を返す
	'posts_per_archive_page' => 10,						// (int) - 1ページあたりに表示する投稿数 - アーカイブページのみ。is_archive()またはis_search()がtrueの際に、posts_per_pageとshowpostsを上書きする。
	'offset'                 => 3,						// (int) - ずらして除外する投稿数。
														// 警告:offsetパラメーターを設定すると、pagedパラメーターを上書き、または無視し、ページネーションを壊す。詳細はこちらを参照: http://codex.wordpress.org/Making_Custom_Queries_using_Offset_and_Pagination
														// 'offset'パラメーターは'posts_per_page'=>-1(全ての投稿を表示)の際に無視される。
	'paged'                  => get_query_var('paged'),	//(int) - ページ数。「過去の投稿」リンクで辿って何ページ目に表示されるべき投稿を表示するかを指定できる。
														//注意:このpaging関連はトリッキーである。いくつかの参考リンク:
														// http://codex.wordpress.org/Function_Reference/next_posts_link#Usage_when_querying_the_loop_with_WP_Query
														// http://codex.wordpress.org/Pagination#Troubleshooting_Broken_Pagination
	'page'                   => get_query_var('page'),	// (int) - 固定フロントページの場合のページ数。固定フロントページで何ページ目に表示されるべき投稿を表示するかを指定できる。
														//注意:'page'クエリー変数は、本文内で<!--nextpage-->クイックタグを含むページ分割された投稿や固定ページの場合のページ数を保持する。
	'ignore_sticky_posts' => false,						// (boolean) - 先頭固定表示投稿を無視するかどうか(バージョン3.1から利用可能、caller_get_postsパラメーターと置き換え)。デフォルト値は0 - 先頭固定表示投稿を無視しない。注意:返された投稿の最初に含まれている先頭固定表示の投稿を無視/除外するが、先頭固定表示投稿は依然返された投稿のリストの自然な並び順で返される。


	//オーダー&オーダーバイパラメーター - 投稿の並びを指定する。
	'order'   => 'DESC',								//(string) - 'orderby'パラメーターで昇順・降順のどちらで並び替えるかを指定する。デフォルト値は'DESC'。
														//使えるオプション値:
														//'ASC' - 最低から最高に昇順 values (1, 2, 3; a, b, c).
														//'DESC' - 最高から最低に降順 values (3, 2, 1; c, b, a).
	'orderby' => 'date',								//(string) - どのパラメータ値で投稿を並び替えるかの指定。デフォルト値は'date'。 ひとつまたはそれ以上のオプションを渡すことが可能。例:'orderby' => 'menu_order title'
														//使えるオプション値:
														//'none' - 並び替えない(バージョン2.8以降で有効)。
														//'ID' - 投稿IDで並び替える。Note the captialization.
														//'author' - 著者で並び替える。
														//'title' - タイトルで並び替える。
														//'name' - Order by post name (post slug).
														//'date' - 日付で並び替える。
														//'modified' - 更新日で並び替える。
														//'parent' - 親ページのIDで並び替える。
														//'rand' - ランダム順。
														//'comment_count' - コメント数で並び替える(バージョン2.9以降で有効)。
														//'menu_order' - ページの表示順で並び替える。よく使われるのは固定ページ(編集画面で順序欄がある)または添付ファイル(メディアの挿入/アップロード画面のギャラリーページに順序欄がある)だが、どの投稿タイプでも'menu_order'の値を指定することはできる(デフォルト値は0)。
														//'meta_value' - 'meta_key=keyname'がクエリーに存在しなければならないので注意。アルファベット順でソートされるため文字列ではうまくいくが、数値では期待した順序にならないので注意(例: 1, 3, 4, 6, 34, 56とは並ばず、1, 3, 34, 4, 56, 6とソートされる)。
														//'meta_value_num' - 数値として並び替える(バージョン2.8以降で有効)。こちらも'meta_key=keyname'がクエリーに存在しなければならないので注意。
														//'title menu_order' - 表示順とタイトルで同時に並び替える。詳細はこちらを参照: http://wordpress.stackexchange.com/questions/2969/order-by-menu-order-and-title
														//'post__in' - post__inで配列で指定された投稿IDの並び順を維持する(バージョン3.5以降で利用可能)


	//日付パラメーター - 特定の時間や日付の期間に基づいて投稿を表示する。
	'year'     => 2015,									//(int) - 4桁の年 (例 2015)。
	'monthnum' => 4,									//(int) - 月を数字で指定(1から12)。
	'w'        =>  25,									//(int) - 年内の週(0から53)。MySQLのWEEKコマンドを使う。このモードは'start_of_week'オプションに依存する。
	'day'      => 17,									//(int) - 月内の日(1から31)。
	'hour'     => 13,									//(int) - 時間(0から23)。
	'minute'   => 19,									//(int) - 分(0から60)。
	'second'   => 30,									//(int) - 秒(0から60)。
	'm'        => 201504,								//(int) - YearMonth (For e.g.: 201307).

	'date_query' => array(								//(array) - 日付パラメーター(バージョン3.7以降で利用可能)。
														//これは超強力。Codexでより分かりやすいコードサンプルをチェックせよ。 http://codex.wordpress.org/Class_Reference/WP_Query#Date_Parameters
		array(
			'year'   => 2015,							//(int) - 4桁の年 (例 2011)。
			'month'  => 4								//(int) - 月を数字で指定(1から12)。
			'week'   => 31								//(int) - 年内の週(0から53)。
			'day'    => 5								//(int) - 月内の日(1から31)。
			'hour'   => 2								//(int) - 時間(0から23)。
			'minute' => 3								//(int) - 分(0から59)。
			'second' => 36								//(int) - 秒(0から59)。
			'after'	 => 'January 1st, 2013',			//(string/array) - 指定した日付以降の投稿を取得する。strtotime()と互換性のある文字列、または'year'、'month'、'day'の配列
			'before'	=> array(						//(string/array) - 指定した日付以前の投稿を取得する。strtotime()と互換性のある文字列、または'year'、'month'、'day'の配列
				'year'  => 2013,						//(string) 4桁の年。デフォルトは空
				'month' => 2,							//(string) 年内の月。数字の1から12。デフォルトは12
				'day'   => 28,							//(string) 月内の日。数字の1から31。デフォルトは月内の末日
			),
			'inclusive' => true,						//(boolean) - afterまたはbeforeパラメーターで指定された値を含むかどうか。
			'compare'   =>  '=',						//(string) - 使用可能な値は '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN', 'EXISTS' (WP3.5以降), and 'NOT EXISTS' (同じくWP3.5以降). Default value is '='
			'column'    => 'post_date',					//(string) - 照会するカラム。デフォルト: 'post_date'.
			'relation'  => 'AND',						//(string) - OR または AND、サブ配列をどう比較するか。デフォルト:AND
		),
	),


	//カスタムフィールドパラメーター - 特定のカスタムフィールドに関連付けられた投稿を表示する。
	'meta_key'       => 'key',							//(string) - カスタムフィールドのキー。
	'meta_value'     => 'value',						//(string) - カスタムフィールドの値。
	'meta_value_num' => 10,								//(number) - カスタムフィールドの値。
	'meta_compare'   => '=',							//(string) - 'meta_value'をテストする演算子。使える値は'!='、'>'、'>='、'<'、'='で、デフォルト値は'='。
	'meta_query'     => array(							//(array) - カスタムフィールドパラメーター(バージョン3.1以降で有効)。
		'relation' => 'AND',							//(string) - 使用可能な値は'AND'または'OR'。meta_query内の配列が2つ以上ある場合に、それぞれを比較する論理関係。1つのmeta_query配列では使用しないこと。
		array(
			'key'     => 'color',						//(string) - カスタムフィールドのキー。
			'value'   => 'blue',						//(string/array) - カスタムフィールドの値(注意: compareの値が'IN'、'NOT IN'、'BETWEEN'、'NOT BETWEEN'の際のみ配列をサポート)。WP3.9以前を使用している場合はこのページを確認すること: http://codex.wordpress.org/Class_Reference/WP_Query#Custom_Field_Parameters
			'type'    => 'CHAR',						//(string) - カスタムフィールドタイプ。使える値は'NUMERIC'(数値)、'BINARY'(バイナリ)、'CHAR'(文字列)、'DATE'(日付)、'DATETIME'(日時)、'DECIMAL'(少数)、'SIGNED'(符号付き整数)、'TIME'(時間)、'UNSIGNED'(符号なし整数)。デフォルト値は'CHAR'。 The 'type' DATE works with the 'compare' value BETWEEN only if the date is stored at the format YYYYMMDD and tested with this format.
														//注意:'type'のDATEは'compare'の値がBETWEENで、日付はYYYYMMDDの書式で比較されるためその書式で保存されている場合のみ使用可能。
			'compare' => '='							//(string) - テストする演算子。使える値は'='、'!='、'>'、'>='、'<'、'<='、'LIKE'、'NOT LIKE'、'IN'、'NOT IN'、'BETWEEN'、'NOT BETWEEN', 'EXISTS' (WP3.5以降), and 'NOT EXISTS' (同じくWP3.5以降)。デフォルト値は'='。
		),
		array(
			'key'     => 'price',
			'value'   => array( 1,200 ),
			'compare' => 'NOT LIKE'
		)
	), 


	//権限パラメーター - 公開された投稿、または非公開の投稿。ユーザーが持つ権限に従う。
	'perm' => 'readable'								//(string) 使用可能な値は'readable'または'editable'


	//キャッシュパラメーター
	//注意 キャッシュは良いもの。これらをfalseにすることは通常推奨されない。
	'cache_results'          => true,					//(bool) デフォルトはtrue - 投稿の情報のキャッシュ。
	'update_post_term_cache' => true,					//(bool) デフォルトはtrue - 投稿のメタ情報のキャッシュ。
	'update_post_meta_cache' => true,					//(bool) デフォルトはtrue - 投稿のターム情報のキャッシュ。
	'no_found_rows'          => false,					//(bool) デフォルトはfalse。WordPressはSQL_CALC_FOUND_ROWSを多くのクエリーでページネーションのために使用する。ページネーションを必要としない場合でも同様である。このパラメーターをtrueに設定することでWordPressに累計の行数を数える必要がないことを伝えDB負荷を下げることができる。このパラメーターがtrueに設定された場合はページネーションは動作しない。詳細はこちらを参照: http://flavio.tordini.org/speed-up-wordpress-get_posts-and-query_posts-functions


	//検索パラメーター
	's'        => $s,									//(string) - 検索からクエリーストリング値を渡す。
	'exact'    => true,									//(bool) - タイトル/投稿の全体と合致するかどうかのフラグ - デフォルト値はfalse。
	'sentence' => true,									//(bool) - フレーズ検索を行なうかどうかのフラグ - デフォルト値はfalse。


	//投稿フィールドパラメーター
	'fields' => 'ids'									//(string) - どのフィールドを返すか。デフォルトでは全てのフィールドが返される。
														//使用可能な値: 
														//'ids'		- 投稿のIDの配列を返す。 
														//'id=>parent' - 連想配列を返す。 [ parent => ID, … ]
														//その他が渡されると全てのフィールドを返す(デフォルト) - 投稿オブジェクトの配列。  
);

$query = new WP_Query($args);

//ループ
if ($query->have_posts()) {
	while ($query->have_posts()) {
		$query->the_post();
		//何かする
	}
}

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

 

 

SNSでシェア♪

スポンサーリンク

関連記事