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

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

「テンプレートタグ/get posts」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(英語版のサンプルコードが更新されたので追随)
({{原文|Template Tags/get posts|137043}}<!-- 10:40, 14 October 2013 Viky081 版 -->)
1行目: 1行目:
<div id="Description">
+
{{Languages|
 +
{{en|Template_Tags/get_posts}}
 +
{{ja|テンプレートタグ/get_posts}}
 +
{{zh-cn|模版标签/get_posts}}
 +
}}
 
== 説明 ==
 
== 説明 ==
</div>
 
  
テンプレートタグ [[テンプレートタグ/get_posts|<code>get_posts()</code>]] は、複数の[[The_Loop|ループ]]を作成するためのシンプルなタグです。これを使って、最新の投稿や条件に一致する投稿を取得することができます。
+
<tt>get_posts</tt> の最も好ましい使い方は、パラメータに基づいて投稿データを作成することです。最新の投稿あるいはパラメータに合致した投稿を取得します。複数のループを作成するのに <tt>get_posts</tt> を使用する事もできます。ただしこの場合は <tt>new WP_Query</tt> を使用して <tt>[[Class_Reference/WP_Query|WP_Query]]</tt> を直接参照するほうが好ましいでしょう。
  
[[関数リファレンス/get_pages|get_pages]]/[[:en:Function_Reference/get_pages|en]] とパラメータが似ていますが、名前が異なっていたり微妙に違った値を取るものもいくつかありますのでご注意ください。
+
<tt>[[関数リファレンス/get_pages|get_pages]]</tt> とパラメータが似ていますが、実装方法が異なっています。適切に使う必要があります。名前が異なっていたり微妙に違った値を取るものもいくつかありますのでご注意ください。<tt>get_posts</tt> は <tt>[[Class_Reference/WP_Query|WP_Query]]</tt> を使用していますが、<tt>get_pages</tt> はデータベースに直接クエリを投げます。実装の差異を反映したパラメータになっています。
 +
 
 +
<tt>[[関数リファレンス/query_posts|query_posts]]</tt> も <tt>[[Class_Reference/WP_Query|WP_Query]]</tt> を使用していますが、グローバル変数 <tt>$wp_query</tt> を書き換えてメインループを直接変更しているので、使う場合は注意してください。一方、<tt>get_posts</tt> は新しい <tt>WP_Query</tt> オブジェクトを参照するため、メインループに影響を与えません。
 +
 
 +
メインクエリが実行される前に変更したい場合は、<tt>[[Plugin_API/Action_Reference/pre_get_posts|pre_get_posts]]</tt> フックを使用することができます。ページの中で、いくつかのパラメータで指定した投稿データを呼び出したい場合は、<tt>get_posts</tt> が最適でしょう。
  
<div id="Usage">
 
 
== 使い方 ==
 
== 使い方 ==
</div>
 
  
<?php $posts_array = get_posts( $args ); ?>
+
%%% <?php $posts_array = get_posts( $args ); ?> %%%
  
<div id="Default_Usage">
+
===デフォルトの使い方===
== デフォルトの使い方 ==
+
</div>
+
  
 
<pre>
 
<pre>
 
<?php $args = array(
 
<?php $args = array(
'numberposts'     => 5,
+
'posts_per_page'   => 5,
'offset'         => 0,
+
'offset'           => 0,
'category'       => ,
+
'category'         => '',
'orderby'         => 'post_date',
+
'orderby'         => 'post_date',
'order'           => 'DESC',
+
'order'           => 'DESC',
'include'         => ,
+
'include'         => '',
'exclude'         => ,
+
'exclude'         => '',
'meta_key'       => ,
+
'meta_key'         => '',
'meta_value'     => ,
+
'meta_value'       => '',
'post_type'       => 'post',
+
'post_type'       => 'post',
'post_mime_type' => ,
+
'post_mime_type'   => '',
'post_parent'     => ,
+
'post_parent'     => '',
'post_status'     => 'publish' );
+
'post_status'     => 'publish',
?>
+
'suppress_filters' => true ); ?>
 
</pre>
 
</pre>
 +
注: <tt>'numberposts'</tt> または <tt>'posts_per_page'</tt> のいずれかが利用できます。
  
<div id="Parameters">
 
 
== パラメータ ==
 
== パラメータ ==
</div>
+
この関数で使えるパラメータについては、[[Class_Reference/WP_Query|<tt>WP_Query</tt>]] をごらんください。
  
<tt>get_posts()</tt> は [[関数リファレンス/WP_Query|<tt>WP_Query</tt>]] クラスを利用して投稿を取得します。この関数で使えるパラメータについては、<tt>WP_Query</tt> ドキュメンテーションの [[関数リファレンス/WP_Query#Parameters|パラメータセクション]]をご覧ください。
+
パラメータの使い方の例は、[[関数リファレンス/get_pages|<tt>get_pages()</tt>]] をごらんください。
  
'''注意事項'''<br />
+
<tt>get_posts()</tt> は [[Class_Reference/WP_Query|<tt>WP_Query</tt>]] クラスを利用して投稿を取得します。この関数で使えるパラメータについては、<tt>WP_Query</tt> ドキュメンテーションの[[Class_Reference/WP_Query#Parameters|the parameters section]] をごらんください。
* get_posts は <tt>'suppress_filters' => true</tt> をデフォルトとします。一方、<tt>[[テンプレートタグ/query_posts|query_posts()]]</tt> ではデフォルトでフィルタを適用としますので、WPML のようにクエリを変更するプラグインを使う場合にはややこしく感じるかもしれません。
+
 
* 'category' パラメータではカテゴリー名ではなくカテゴリー ID を指定する必要があります。
+
'''注意: ''' get_posts は <tt>'suppress_filters' => true</tt> をデフォルトとします。一方、<tt>[[関数リファレンス/query_posts|query_posts()]]</tt> はデフォルトでフィルタを適用するので、WPML のようにクエリを変更するプラグインを使う場合はややこしく感じるかもしれません。また、<tt>'suppress_filters'</tt> が ''true'' の場合でも、<tt>pre_get_posts</tt> に追加されたフィルターは適用されます。<tt>'posts_*'</tt> と <tt>'comment_feed_*'</tt> に追加されたフィルターのみ、抑制されます。
* 'category' パラメータはコンマ区切りの複数カテゴリー ID でもかまいません。これは、<tt>[http://core.trac.wordpress.org/browser/tags/3.3.1/wp-includes/post.php#L1369 get_posts()]</tt> 関数が 'category' パラメータを 'cat' として WP_Query に直接渡すからです。
+
 
 +
'''注意: ''' category パラメータではカテゴリー名ではなくカテゴリー ID を指定する必要があります。
 +
 
 +
'''注意: ''' category パラメータはコンマ区切りの複数カテゴリー ID でもかまいません。これは、<tt>[http://core.trac.wordpress.org/browser/tags/3.3.1/wp-includes/post.php#L1369 get_posts()]</tt> 関数が 'category' パラメータを 'cat' として <tt>WP_Query</tt> に直接渡すからです。
 +
 
 +
{{パラメータ|'orderby'|文字列|取得した投稿をソートする|オプション|'date'}}
 +
 
 +
:* <tt>'none'</tt> - 順序無し (Version 2.8 で利用可能)
 +
:* <tt>'ID'</tt> - 投稿 ID。パラメータ名は大文字
 +
:* <tt>'author'</tt> - 作成者
 +
:* <tt>'title'</tt> - タイトル
 +
:* <tt>'date'</tt> - 日付
 +
:* <tt>'modified'</tt> - 更新日
 +
:* <tt>'parent'</tt> - 親ページの ID
 +
;* <tt>'rand'</tt> - ランダム
 +
:* <tt>'comment_count'</tt> - コメント数 (Version 2.9 で利用可能)
 +
:* <tt>'menu_order'</tt> - ページ順序。固定ページ (ページ属性で指定する) やアタッチメント (メディア投稿ダイアログの数値) で使われるが、<tt>'menu_order'</tt> 値 (デフォルトは 0) を持つ任意の投稿タイプで使用可能。
 +
:* <tt>'meta_value'</tt> - クエリに <tt>'meta_key=keyname'</tt> がある場合のみ有効。並べ替えはアルファベット順なので語句の場合は良いが、数字の場合は予想外の結果 (たとえば 1, 3, 4, 6, 34, 56 を期待するかもしれないが、1, 3, 34, 4, 56, 6 のようになる) になることがある。
 +
:* <tt>'meta_value_num'</tt> - メタフィールドの値。(Version 2.8 で利用可能)。クエリに <tt>'meta_key=keyname'</tt> がある場合のみ有効。<tt>'meta_value'</tt> の項に記載の数字での並べ替えを行う。
 +
:'''注:''' [[関数リファレンス/get_pages|<tt>get_pages()</tt>]] は <tt>'orderly'</tt> ではなく、<tt>'sort_column'</tt> を使用します。また [[関数リファレンス/get_pages|<tt>get_pages()</tt>]] は <tt>'post_'</tt> を前置します: <tt>'author, date, modified, parent, title, excerpt, content'</tt>
 +
 
 +
{{パラメータ|'post_mime_type'|文字列 / 配列|mime types の一覧またはコンマ区切り|オプション}}
  
<div id="Return_Value">
 
 
== 返り値 ==
 
== 返り値 ==
</div>
 
  
; (array) : 投稿オブジェクトのリスト。[[関数リファレンス/get_post#Return|get_post()]] の返り値をご覧ください。
+
; (array) : 投稿オブジェクトのリスト。<tt>[[関数リファレンス/get_post#Return|get_post()]]</tt> の返り値をご覧ください。
 +
 
 +
<tt>[[関数リファレンス/get_pages|get_pages()]]</tt> と異なり、<tt>get_posts()</tt> は適切なコンテキスト(管理者の場合、など)では ''private'' ページを返します。 (参考: Andreas Kirsch, [http://blog.blackhc.net/2009/01/wordpress-hacking-ii/ WordPress Hacking II], January 24, 2009-- accessed 2012-11-09.)
  
<div id="Examples">
 
 
== 用例 ==
 
== 用例 ==
</div>
 
  
<div id="Posts_list_with_offset">
+
=== オフセットのあるリストの生成 ===
=== リストの生成 ===
+
</div>
+
  
サイトのフロントページに最新の記事を1件のみ表示するよう設定しており、それに続けてカテゴリID が1の記事へのリンクと抜粋文を5件分表示したいとき、以下のように書きます。
+
フロントページで 1 件だけ表示し、カテゴリーID が 1 の投稿を表示したい場合、下記のようにします。
  
 
<pre>
 
<pre>
80行目: 100行目:
 
</pre>
 
</pre>
  
'''注:''' 2件以上の記事がないカテゴリで上記のクエリを使うと何も表示されません。
+
'''注:''' ''2件以上の記事がないカテゴリで上記のクエリを使うと何も表示されません。''
  
<div id="Reset_after_Postlists_with_offset">
+
=== 前後の投稿へのリンクがある投稿 ===
=== オフセットのリセット ===
+
 
 +
前後の投稿へのリンクがある投稿を作成することができます。
 +
下記のようにします。
 +
 
 +
<pre><?php
 +
$postlist = get_posts('sort_column=menu_order&amp;sort_order=asc');
 +
$posts = array();
 +
foreach ($postlist as $post) {
 +
  $posts[] += $post->ID;
 +
}
 +
 
 +
$current = array_search(get_the_ID(), $posts);
 +
$prevID = $posts[$current-1];
 +
$nextID = $posts[$current+1];
 +
?>
 +
 
 +
<div class="navigation">
 +
<?php if (!empty($prevID)) { ?>
 +
<div class="alignleft">
 +
<a href="<?php echo get_permalink($prevID); ?>"
 +
  title="<?php echo get_the_title($prevID); ?>">Previous</a>
 +
</div>
 +
<?php }
 +
if (!empty($nextID)) { ?>
 +
<div class="alignright">
 +
<a href="<?php echo get_permalink($nextID); ?>"
 +
title="<?php echo get_the_title($nextID); ?>">Next</a>
 
</div>
 
</div>
 +
<?php } ?>
 +
</div><!-- .navigation --></pre>
 +
 +
==== オフセットのリセット ====
  
 
ループの後で、foreach 実行前の記事が必要な場合は、以下のように記述します。
 
ループの後で、foreach 実行前の記事が必要な場合は、以下のように記述します。
102行目: 152行目:
 
</pre>
 
</pre>
  
<div id="Access_all_post_data">
 
 
=== 全記事データにアクセスする ===
 
=== 全記事データにアクセスする ===
</div>
 
  
get_posts では、デフォルトの状態では利用できない記事データが一部あります。[[テンプレートタグ/the_content|the_content()]] のコンテンツや ID などです。内部関数 setup_postdata() に、引数として $post 配列を与えることで解決できます。
+
get_posts では、デフォルトの状態では利用できない記事データが一部あります。<tt>[[関数リファレンス/the_content|the_content()]]</tt> のコンテンツや ID などです。内部関数 <tt>setup_postdata()</tt> に、引数として $post 配列を与えることで解決できます。
  
 
<pre>
 
<pre>
120行目: 168行目:
 
</pre>
 
</pre>
  
setup_postdata() を呼び出さずに投稿 ID またはコンテンツにアクセスしたり、([[データベース概要#.E3.83.86.E3.83.BC.E3.83.96.E3.83.AB.EF.BC.9A_wp_posts|the posts table]] に蓄積されている)任意の投稿データにアクセスするには、<tt>$post->''COLUMN''</tt> を使用できます。ここで <tt>''COLUMN''</tt> はデータのテーブルカラム名です。したがって、<tt>$post->ID</tt> は ID、 <tt>$post->post_content</tt> はコンテンツ、といった具合です。データを表示/出力するには、以下のように [[Glossary#PHP|PHP]] echo コマンドを使用します。
+
<tt>setup_postdata()</tt> を呼び出さずに投稿 ID またはコンテンツにアクセスしたり、([[Database_Description#Table:_wp_posts|the posts table]] に蓄積されている)任意の投稿データにアクセスするには、<tt>$post->COLUMN</tt> を使用できます。ここで <tt>COLUMN</tt> はデータのテーブルカラム名です。したがって、<tt>$post->ID</tt> は ID、 <tt>$post->post_content</tt> はコンテンツ、といった具合です。データを表示/出力するには、以下のように PHP echo コマンドを使用します。
  
 
<pre>
 
<pre>
<?php echo $post->ID; ?>
+
<?php echo $post->ID; ?>
</pre>
+
</pre>
  
<div id="Latest_posts_ordered_by_title">
 
 
=== 最近の投稿をタイトル順に並べる ===
 
=== 最近の投稿をタイトル順に並べる ===
</div>
 
  
アルファベット順に昇順で最近の 10 件を表示するには、以下のコードで投稿日、タイトル、抜粋を表示します。
+
Tアルファベット順に昇順で最近の 10 件を表示するには、以下のコードで投稿日、タイトル、抜粋を表示します。
  
 
<pre>
 
<pre>
150行目: 196行目:
 
</pre>
 
</pre>
  
<div id="Random_posts">
 
 
=== ランダムに表示する ===
 
=== ランダムに表示する ===
</div>
 
  
orderby パラメータに rand を指定して [[Glossary#MySQL|MySQL]] RAND() 関数を使用して最近の 5 件をランダムに表示します。
+
orderby パラメータに rand を指定して [[Glossary#MySQL|MySQL]] <tt>RAND()</tt> 関数を使用して最近の 5 件をランダムに表示します。
  
 
<pre>
 
<pre>
169行目: 213行目:
 
</pre>
 
</pre>
  
<div id="Show_all_attachment">
 
 
=== 添付ファイルを全て表示する ===
 
=== 添付ファイルを全て表示する ===
</div>
 
  
 
テンプレートの [[The_Loop|Loops]] 外に記述します。
 
テンプレートの [[The_Loop|Loops]] 外に記述します。
191行目: 233行目:
 
</pre>
 
</pre>
  
<div id="Show_attachments_for_the_current_post">
 
 
=== 現在の記事の添付ファイルを表示する ===
 
=== 現在の記事の添付ファイルを表示する ===
</div>
 
  
 
[[The_Loop|ループ]]内(<var>$post->ID</var> が利用できるところ)に記述します。
 
[[The_Loop|ループ]]内(<var>$post->ID</var> が利用できるところ)に記述します。
210行目: 250行目:
 
</pre>
 
</pre>
  
<div id="Get_a_post_by_its_slug">
 
 
=== スラッグをもとに投稿を取得する ===
 
=== スラッグをもとに投稿を取得する ===
</div>
 
  
投稿スラッグをもとに投稿 ID を取得できます。caller_get_posts 変数は、このカスタムクエリから先頭固定投稿を除外します。
+
投稿スラッグをもとに投稿 ID を取得できます。
  
 
<pre>
 
<pre>
 
<?php
 
<?php
$the_slug = 'my_slug';
+
$the_slug = 'my-slug';
 
$args=array(
 
$args=array(
  'name' => $the_slug,
+
'name' => $the_slug,
  'post_type' => 'post',
+
'post_type' => 'post',
  'post_status' => 'publish',
+
'post_status' => 'publish',
  'showposts' => 1
+
'posts_per_page' => 1
 
);
 
);
$my_posts = get_posts($args);
+
$my_posts = get_posts( $args );
 
if( $my_posts ) {
 
if( $my_posts ) {
echo 'ID on the first post found '.$my_posts[0]->ID;
+
echo 'ID on the first post found ' . $my_posts[0]->ID;
 
}
 
}
 
?>
 
?>
 
</pre>
 
</pre>
  
<div id="Taxonomy_Parameters">
 
 
=== タクソノミーパラメータ ===
 
=== タクソノミーパラメータ ===
</div>
 
  
 
特定のタクソノミーと関連する投稿を表示します。カスタム投稿タイプに対して登録されたタクソノミーを指定した場合、'category' ではなく代わりに '{custom_taxonomy_name}'(カスタムタクソノミー名)を使って下さい。例えば、"genre"(ジャンル)というタクソノミーがあり、"jazz" というジャンルに分類された投稿のみを表示したい時は以下のコードを使います。
 
特定のタクソノミーと関連する投稿を表示します。カスタム投稿タイプに対して登録されたタクソノミーを指定した場合、'category' ではなく代わりに '{custom_taxonomy_name}'(カスタムタクソノミー名)を使って下さい。例えば、"genre"(ジャンル)というタクソノミーがあり、"jazz" というジャンルに分類された投稿のみを表示したい時は以下のコードを使います。
241行目: 277行目:
 
<?php
 
<?php
 
$args = array(
 
$args = array(
  'numberposts' => 8,
+
'posts_per_page' => 8,
  'orderby' => 'rand',
+
'orderby' => 'rand',
  'post_type' => 'albums',
+
'post_type' => 'albums',
  'genre' => 'jazz',
+
'genre' => 'jazz',
  'post_status' => 'publish'
+
'post_status' => 'publish'
 
);
 
);
$show_albums = get_posts ( $args );
+
$show_albums = get_posts( $args );
 
?>
 
?>
 
</pre>
 
</pre>
268行目: 304行目:
 
他の例については、<tt>WP_Query</tt> ドキュメンテーションの [[関数リファレンス/WP_Query#Taxonomy_Parameters|タクソノミーパラメータのセクション]]をご覧ください。
 
他の例については、<tt>WP_Query</tt> ドキュメンテーションの [[関数リファレンス/WP_Query#Taxonomy_Parameters|タクソノミーパラメータのセクション]]をご覧ください。
  
<div id=Custom_Field_Parameters">
 
 
=== カスタムフィールドパラメータ ===
 
=== カスタムフィールドパラメータ ===
</div>
 
  
あるカスタムフィールドと関連する投稿のみを表示します。以下の例では、"meta_query" を使い、"product" 投稿タイプで "featured" というメタキーが "yes" という値を持つ投稿を取得します。
+
あるカスタムフィールドと関連する投稿のみを表示します。以下の例では、"meta_query" を使い、"product" 投稿タイプで "featured" というメタキーが "yes" という値を持つ投稿を取得します。:
  
 
<pre>
 
<pre>
289行目: 323行目:
 
他の例については、<tt>WP_Query</tt> ドキュメンテーションの [[関数リファレンス/WP_Query#Custom_Field_Parameters|カスタムフィールドパラメータのセクション]]をご覧ください。
 
他の例については、<tt>WP_Query</tt> ドキュメンテーションの [[関数リファレンス/WP_Query#Custom_Field_Parameters|カスタムフィールドパラメータのセクション]]をご覧ください。
  
<div id=Change_Log">
 
 
==変更履歴==
 
==変更履歴==
</div>
 
  
 
* [[Version 1.2|1.2.0]] 以降
 
* [[Version 1.2|1.2.0]] 以降
  
<div id=Source_File">
 
 
==ソースファイル==
 
==ソースファイル==
</div>
 
  
 
<tt>get_posts()</tt> は {{Trac|wp-includes/post.php}} にあります。
 
<tt>get_posts()</tt> は {{Trac|wp-includes/post.php}} にあります。
  
<div id="Related">
 
 
== 関連 ==
 
== 関連 ==
</div>
 
  
{{原文|Template Tags/get posts|115443}}<!-- 2012-04-03T09:54:48 Donutz 版 -->
+
{{原文|Template Tags/get posts|137043}}<!-- 10:40, 14 October 2013 Viky081 版 -->
  
 
{{Query Tags}}
 
{{Query Tags}}

2013年10月18日 (金) 14:17時点における版

[http://wpdocs.sourceforge.jp{{localurl: テンプレート:en テンプレート:ja テンプレート:zh-cn }} 日本語] •

説明

get_posts の最も好ましい使い方は、パラメータに基づいて投稿データを作成することです。最新の投稿あるいはパラメータに合致した投稿を取得します。複数のループを作成するのに get_posts を使用する事もできます。ただしこの場合は new WP_Query を使用して WP_Query を直接参照するほうが好ましいでしょう。

get_pages とパラメータが似ていますが、実装方法が異なっています。適切に使う必要があります。名前が異なっていたり微妙に違った値を取るものもいくつかありますのでご注意ください。get_postsWP_Query を使用していますが、get_pages はデータベースに直接クエリを投げます。実装の差異を反映したパラメータになっています。

query_postsWP_Query を使用していますが、グローバル変数 $wp_query を書き換えてメインループを直接変更しているので、使う場合は注意してください。一方、get_posts は新しい WP_Query オブジェクトを参照するため、メインループに影響を与えません。

メインクエリが実行される前に変更したい場合は、pre_get_posts フックを使用することができます。ページの中で、いくつかのパラメータで指定した投稿データを呼び出したい場合は、get_posts が最適でしょう。

使い方

%%% <?php $posts_array = get_posts( $args ); ?> %%%

デフォルトの使い方

<?php $args = array(
	'posts_per_page'   => 5,
	'offset'           => 0,
	'category'         => '',
	'orderby'          => 'post_date',
	'order'            => 'DESC',
	'include'          => '',
	'exclude'          => '',
	'meta_key'         => '',
	'meta_value'       => '',
	'post_type'        => 'post',
	'post_mime_type'   => '',
	'post_parent'      => '',
	'post_status'      => 'publish',
	'suppress_filters' => true ); ?>

注: 'numberposts' または 'posts_per_page' のいずれかが利用できます。

パラメータ

この関数で使えるパラメータについては、WP_Query をごらんください。

パラメータの使い方の例は、get_pages() をごらんください。

get_posts()WP_Query クラスを利用して投稿を取得します。この関数で使えるパラメータについては、WP_Query ドキュメンテーションのthe parameters section をごらんください。

注意: get_posts は 'suppress_filters' => true をデフォルトとします。一方、query_posts() はデフォルトでフィルタを適用するので、WPML のようにクエリを変更するプラグインを使う場合はややこしく感じるかもしれません。また、'suppress_filters'true の場合でも、pre_get_posts に追加されたフィルターは適用されます。'posts_*''comment_feed_*' に追加されたフィルターのみ、抑制されます。

注意: category パラメータではカテゴリー名ではなくカテゴリー ID を指定する必要があります。

注意: category パラメータはコンマ区切りの複数カテゴリー ID でもかまいません。これは、get_posts() 関数が 'category' パラメータを 'cat' として WP_Query に直接渡すからです。

テンプレート:パラメータ

  • 'none' - 順序無し (Version 2.8 で利用可能)
  • 'ID' - 投稿 ID。パラメータ名は大文字
  • 'author' - 作成者
  • 'title' - タイトル
  • 'date' - 日付
  • 'modified' - 更新日
  • 'parent' - 親ページの ID
  • 'rand' - ランダム
  • 'comment_count' - コメント数 (Version 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' - メタフィールドの値。(Version 2.8 で利用可能)。クエリに 'meta_key=keyname' がある場合のみ有効。'meta_value' の項に記載の数字での並べ替えを行う。
注: get_pages()'orderly' ではなく、'sort_column' を使用します。また get_pages()'post_' を前置します: 'author, date, modified, parent, title, excerpt, content'

テンプレート:パラメータ

返り値

(array) 
投稿オブジェクトのリスト。get_post() の返り値をご覧ください。

get_pages() と異なり、get_posts() は適切なコンテキスト(管理者の場合、など)では private ページを返します。 (参考: Andreas Kirsch, WordPress Hacking II, January 24, 2009-- accessed 2012-11-09.)

用例

オフセットのあるリストの生成

フロントページで 1 件だけ表示し、カテゴリーID が 1 の投稿を表示したい場合、下記のようにします。

<ul>
<?php


$args = array( 'posts_per_page' => 5, 'offset'=> 1, 'category' => 1 );

$myposts = get_posts( $args );
foreach ( $myposts as $post ) : setup_postdata( $post ); ?>
	<li>
		<a href="<?php the_permalink(); ?>"><?php the_title(); ?></a>
	</li>
<?php endforeach; 
wp_reset_postdata();?>

</ul>

注: 2件以上の記事がないカテゴリで上記のクエリを使うと何も表示されません。

前後の投稿へのリンクがある投稿

前後の投稿へのリンクがある投稿を作成することができます。 下記のようにします。

<?php
$postlist = get_posts('sort_column=menu_order&sort_order=asc');
$posts = array();
foreach ($postlist as $post) {
   $posts[] += $post->ID;
}

$current = array_search(get_the_ID(), $posts);
$prevID = $posts[$current-1];
$nextID = $posts[$current+1];
?>

<div class="navigation">
<?php if (!empty($prevID)) { ?>
<div class="alignleft">
<a href="<?php echo get_permalink($prevID); ?>"
  title="<?php echo get_the_title($prevID); ?>">Previous</a>
</div>
<?php }
if (!empty($nextID)) { ?>
<div class="alignright">
<a href="<?php echo get_permalink($nextID); ?>" 
 title="<?php echo get_the_title($nextID); ?>">Next</a>
</div>
<?php } ?>
</div><!-- .navigation -->

オフセットのリセット

ループの後で、foreach 実行前の記事が必要な場合は、以下のように記述します。

<ul>
<?php
global $post;
$args = array( 'posts_per_page' => 5, 'offset'=> 1, 'category' => 1 );
$myposts = get_posts( $args );
foreach ( $myposts as $post ) : 
  setup_postdata( $post ); ?>
	<li><a href="<?php the_permalink(); ?>"><?php the_title(); ?></a></li>
<?php endforeach;
wp_reset_postdata(); ?>
</ul>

全記事データにアクセスする

get_posts では、デフォルトの状態では利用できない記事データが一部あります。the_content() のコンテンツや ID などです。内部関数 setup_postdata() に、引数として $post 配列を与えることで解決できます。

<?php
$args = array( 'posts_per_page' => 3 );
$lastposts = get_posts( $args );
foreach ( $lastposts as $post ) :
  setup_postdata( $post ); ?>
	<h2><a href="<?php the_permalink(); ?>"><?php the_title(); ?></a></h2>
	<?php the_content(); ?>
<?php endforeach; 
wp_reset_postdata(); ?>

setup_postdata() を呼び出さずに投稿 ID またはコンテンツにアクセスしたり、(the posts table に蓄積されている)任意の投稿データにアクセスするには、$post->COLUMN を使用できます。ここで COLUMN はデータのテーブルカラム名です。したがって、$post->ID は ID、 $post->post_content はコンテンツ、といった具合です。データを表示/出力するには、以下のように PHP echo コマンドを使用します。

<?php echo $post->ID; ?>

最近の投稿をタイトル順に並べる

Tアルファベット順に昇順で最近の 10 件を表示するには、以下のコードで投稿日、タイトル、抜粋を表示します。

<?php
$args = array( 'posts_per_page' => 10, 'order'=> 'ASC', 'orderby' => 'title' );
$postslist = get_posts( $args );
foreach ( $postslist as $post ) :
  setup_postdata( $post ); ?> 
	<div>
		<?php the_date(); ?>
		<br />
		<?php the_title(); ?>   
		<?php the_excerpt(); ?>
	</div>
<?php
endforeach; 
wp_reset_postdata();
?>

ランダムに表示する

orderby パラメータに rand を指定して MySQL RAND() 関数を使用して最近の 5 件をランダムに表示します。

<ul>
<?php
$args = array( 'posts_per_page' => 5, 'orderby' => 'rand' );
$rand_posts = get_posts( $args );
foreach ( $rand_posts as $post ) : 
  setup_postdata( $post ); ?>
	<li><a href="<?php the_permalink(); ?>"><?php the_title(); ?></a></li>
<?php endforeach; 
wp_reset_postdata(); ?>
</ul>

添付ファイルを全て表示する

テンプレートの Loops 外に記述します。

<?php
$args = array( 'post_type' => 'attachment', 'posts_per_page' => -1, 'post_status' => 'any', 'post_parent' => null ); 
$attachments = get_posts( $args );
if ( $attachments ) {
	foreach ( $attachments as $post ) {
		setup_postdata( $post );
		the_title();
		the_attachment_link( $post->ID, false );
		the_excerpt();
	}
	wp_reset_postdata();
}
?>

現在の記事の添付ファイルを表示する

ループ内($post->ID が利用できるところ)に記述します。

<?php
$args = array( 'post_type' => 'attachment', 'posts_per_page' => -1, 'post_status' =>'any', 'post_parent' => $post->ID ); 
$attachments = get_posts( $args );
if ( $attachments ) {
	foreach ( $attachments as $attachment ) {
		echo apply_filters( 'the_title' , $attachment->post_title );
		the_attachment_link( $attachment->ID , false );
	}
}
?>

スラッグをもとに投稿を取得する

投稿スラッグをもとに投稿 ID を取得できます。

<?php
$the_slug = 'my-slug';
$args=array(
	'name' => $the_slug,
	'post_type' => 'post',
	'post_status' => 'publish',
	'posts_per_page' => 1
);
$my_posts = get_posts( $args );
if( $my_posts ) {
	echo 'ID on the first post found ' . $my_posts[0]->ID;
}
?>

タクソノミーパラメータ

特定のタクソノミーと関連する投稿を表示します。カスタム投稿タイプに対して登録されたタクソノミーを指定した場合、'category' ではなく代わりに '{custom_taxonomy_name}'(カスタムタクソノミー名)を使って下さい。例えば、"genre"(ジャンル)というタクソノミーがあり、"jazz" というジャンルに分類された投稿のみを表示したい時は以下のコードを使います。

<?php
$args = array(
	 'posts_per_page' => 8,
	 'orderby' => 'rand',
	 'post_type' => 'albums',
	 'genre' => 'jazz',
	 'post_status' => 'publish'
);
$show_albums = get_posts( $args );
?>

以下の例では、"tax_query" を使い、"genre" カスタムタクソノミーの "jazz" に分類された投稿のみを取得します。

$args = array(
	'tax_query' => array(
		array(
			'taxonomy' => 'genre',
			'field' => 'slug',
			'terms' => 'jazz'
		)
	)
);
$postslist = get_posts( $args );

他の例については、WP_Query ドキュメンテーションの タクソノミーパラメータのセクションをご覧ください。

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

あるカスタムフィールドと関連する投稿のみを表示します。以下の例では、"meta_query" を使い、"product" 投稿タイプで "featured" というメタキーが "yes" という値を持つ投稿を取得します。:

$args = array(
	'post_type' => 'product',
	'meta_query' => array(
		array(
			'key' => 'featured',
			'value' => 'yes',
		)
	)
 );
$postslist = get_posts( $args );

他の例については、WP_Query ドキュメンテーションの カスタムフィールドパラメータのセクションをご覧ください。

変更履歴

ソースファイル

get_posts()wp-includes/post.php にあります。

関連

最新英語版: WordPress Codex » Template Tags/get posts最新版との差分

記事

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

  • クラス: 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 値を変更する


関数リファレンステンプレートタグ目次もご覧ください。