当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(最新版に更新 {{原文|Template Tags/get posts|95879}}<!-- 12:42, 7 December 2010 Nsp-code 版 -->)
(タクソノミーパラメータ: 非推奨の書式を明示。)
 
(7人の利用者による、間の17版が非表示)
1行目: 1行目:
<div id="Description">
 
 
== 説明 ==
 
== 説明 ==
</div>
 
  
テンプレートタグ [[テンプレートタグ/get_posts|<code>get_posts()</code>]] は、マルチループ(複数ループ)を作成するためのシンプルなタグです。
+
<tt>get_posts</tt> の最も適切な使い方は、パラメータに基づいて投稿データの配列を作成することです。最近の投稿あるいはパラメータに一致した投稿を取得します。[[ループ#複数のループ|複数のループ]]を作成するのに <tt>get_posts</tt> を使用する事もできます。ただしこの場合は <tt>new WP_Query</tt> を使用して <tt>[[Class_Reference/WP_Query|WP_Query]]</tt> を直接参照するほうが好ましいでしょう。
  
<div id="Usage">
+
<tt>[[関数リファレンス/get_pages|get_pages]]</tt> とパラメータが似ていますが実装方法はかなり異なっており、適切に使う必要があります。<tt>get_posts</tt> は <tt>[[Class_Reference/WP_Query|WP_Query]]</tt> を使用していますが、<tt>get_pages</tt> はデータベースに直接クエリを投げます。それぞれ実装の差異を反映したパラメータになっています。
== 使い方 ==
+
</div>
+
  
<?php get_posts('引数'); ?>
+
<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>[[プラグイン API/アクションフック一覧/pre get posts|pre_get_posts]]</tt> フックを使用することができます。ページの中で、いくつかのパラメータで指定した投稿データを呼び出したい場合は、<tt>get_posts</tt> が最適でしょう。
 +
 
 +
 
 +
===デフォルトの使い方===
 +
 
 +
<pre>
 +
<?php $args = array(
 +
'posts_per_page'   => 5,
 +
'offset'          => 0,
 +
'category'        => '',
 +
'category_name'    => '',
 +
'orderby'          => 'date',
 +
'order'            => 'DESC',
 +
'include'          => '',
 +
'exclude'          => '',
 +
'meta_key'        => '',
 +
'meta_value'      => '',
 +
'post_type'        => 'post',
 +
'post_mime_type'  => '',
 +
'post_parent'      => '',
 +
'author'   => '',
 +
'post_status'      => 'publish',
 +
'suppress_filters' => true
 +
);
 +
$posts_array = get_posts( $args ); ?>
 +
</pre>
 +
 
 +
注: <tt>'numberposts'</tt> または <tt>'posts_per_page'</tt> のいずれかが利用できます。
 +
 
 +
== パラメータ ==
 +
 
 +
パラメータの使い方の例は、[[関数リファレンス/get_pages|<tt>get_pages()</tt>]] をごらんください。
 +
 
 +
<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 のようにクエリを変更するプラグインを使う場合はややこしく感じるかもしれません。また、<tt>'suppress_filters'</tt> が ''true'' の場合でも、<tt>pre_get_posts</tt> に追加されたフィルターは適用されます。<tt>'posts_*'</tt> と <tt>'comment_feed_*'</tt> に追加されたフィルターのみ、抑制されます。
 +
 
 +
'''注意: ''' 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> に直接渡すからです。
 +
 
 +
'''注意: ''' category_name パラメータは カテゴリ名では、この場合、文字列にする必要があります。
 +
 
 +
 
 +
{{Parameter|'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> の項に記載の数字での並べ替えを行う。
 +
:* <tt>'post__in'</tt> - 'include' パラメータで渡したものと同じ順序に一致。
 +
:'''注:''' [[関数リファレンス/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>
 +
 
 +
{{Parameter|'post_mime_type'|文字列 / 配列|mime types の一覧またはコンマ区切り|オプション}}
 +
 
 +
== 返り値 ==
 +
 
 +
; (配列) : [[クラスリファレンス/WP_Post|WP_Post]] オブジェクトのリスト。
 +
 
 +
<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件のみ表示するよう設定していて、その次から 5件かつカテゴリID 1 の記事へのリンクと抜粋文を表示したいとき、次のようにコードを書きます。
+
フロントページで 1 件だけ表示してから、カテゴリーID が 1 の投稿へのリンクをそれに先行する 5 件分表示したい場合、下記のようにします。
  
 
<pre>
 
<pre>
 
<ul>
 
<ul>
 
<?php
 
<?php
$myposts = get_posts('posts_per_page=5&offset=1&category=1');
+
 
foreach($myposts as $post) :
+
 
setup_postdata($post);
+
$args = array( 'posts_per_page' => 5, 'offset'=> 1, 'category' => 1 );
?>
+
 
    <li><a href="<?php the_permalink(); ?>"><?php the_title(); ?></a></li>
+
$myposts = get_posts( $args );
<?php endforeach; ?>
+
foreach ( $myposts as $post ) : setup_postdata( $post ); ?>
 +
<li>
 +
<a href="<?php the_permalink(); ?>"><?php the_title(); ?></a>
 +
</li>
 +
<?php endforeach;
 +
wp_reset_postdata();?>
 +
 
 
</ul>
 
</ul>
 
</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 endif;
 +
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 endif; ?>
 +
</div><!-- .navigation --></pre>
 +
 +
==== オフセットのリセット ====
  
 
ループの後で、foreach 実行前の記事が必要な場合は、以下のように記述します。
 
ループの後で、foreach 実行前の記事が必要な場合は、以下のように記述します。
  
<nowiki> <ul>
+
<pre>
<?php
+
<ul>
global $post;
+
<?php
$tmp_post = $post;
+
global $post;
$myposts = get_posts('posts_per_page=5&offset=1&category=1');
+
$args = array( 'posts_per_page' => 5, 'offset'=> 1, 'category' => 1 );
foreach($myposts as $post) :
+
$myposts = get_posts( $args );
  setup_postdata($post);
+
foreach ( $myposts as $post ) :  
?>
+
  setup_postdata( $post ); ?>
    <li><a href="<?php the_permalink(); ?>"><?php the_title(); ?></a></li>
+
<li><a href="<?php the_permalink(); ?>"><?php the_title(); ?></a></li>
<?php endforeach; ?>
+
<?php endforeach;
<?php $post = $tmp_post; ?>
+
wp_reset_postdata(); ?>
</ul> </nowiki>
+
</ul>
 +
</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 配列を与えることで解決できます。
  
<nowiki> <?php
+
<pre>
$lastposts = get_posts('posts_per_page=3');
+
<?php
foreach($lastposts as $post) :
+
$args = array( 'posts_per_page' => 3 );
    setup_postdata($post);
+
$lastposts = get_posts( $args );
?>
+
foreach ( $lastposts as $post ) :
<h2><a href="<?php the_permalink(); ?>" id="post-<?php the_ID(); ?>"><?php the_title(); ?></a></h2>
+
  setup_postdata( $post ); ?>
<?php the_content(); ?>
+
<h2><a href="<?php the_permalink(); ?>"><?php the_title(); ?></a></h2>
<?php endforeach; ?>
+
<?php the_content(); ?>
</nowiki>
+
<?php endforeach;
 +
wp_reset_postdata(); ?>
 +
</pre>
  
setup_postdata() を呼び出さずに投稿 ID またはコンテンツにアクセスするには、あるいは([[Database_Description|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 コマンドを使用します。
  
<nowiki> <?php echo $post->ID; ?> </nowiki>
+
<pre>
 +
<?php echo $post->ID; ?>
 +
</pre>
  
<div id="Latest_posts_ordered_by_title">
 
 
=== 最近の投稿をタイトル順に並べる ===
 
=== 最近の投稿をタイトル順に並べる ===
</div>
 
  
 
アルファベット順に昇順で最近の 10 件を表示するには、以下のコードで投稿日、タイトル、抜粋を表示します。
 
アルファベット順に昇順で最近の 10 件を表示するには、以下のコードで投稿日、タイトル、抜粋を表示します。
  
<nowiki>
+
<pre>
<?php
+
<?php
$postslist = get_posts('posts_per_page=10&order=ASC&orderby=title');
+
$args = array( 'posts_per_page' => 10, 'order'=> 'ASC', 'orderby' => 'title' );
foreach ($postslist as $post) :  
+
$postslist = get_posts( $args );
    setup_postdata($post);
+
foreach ( $postslist as $post ) :
?>  
+
  setup_postdata( $post ); ?>  
<div>
+
<div>
<?php the_date(); ?>
+
<?php the_date(); ?>
<br />
+
<br />
<?php the_title(); ?>   
+
<?php the_title(); ?>   
<?php the_excerpt(); ?>
+
<?php the_excerpt(); ?>
</div>
+
</div>
<?php endforeach; ?>
+
<?php
</nowiki>
+
endforeach;  
 +
wp_reset_postdata();
 +
?>
 +
</pre>
  
'''注:''' '' orderby パラメータは [[Version 2.6]] で変更されました。このコードでは新しい orderby フォーマットを使用しています。詳細は[[テンプレートタグ/get_posts#Parameters|Parameters]] を参照してください。
 
 
<div id="Random_posts">
 
 
=== ランダムに表示する ===
 
=== ランダムに表示する ===
</div>
 
  
orderby パラメータに rand を指定して [[Glossary#MySQL|MySQL]] RAND() 関数を使用して最近の 5 件をランダムに表示します。
+
orderby パラメータに rand を指定して [[Glossary#MySQL|MySQL]] <tt>RAND()</tt> 関数を使用して最近の 5 件をランダムに表示します。
  
<nowiki> <ul><li><h2>A random selection of my writing</h2>
+
<pre>
    <ul>
+
<ul>
<?php
+
<?php
$rand_posts = get_posts('posts_per_page=5&orderby=rand');
+
$args = array( 'posts_per_page' => 5, 'orderby' => 'rand' );
foreach( $rand_posts as $post ) :
+
$rand_posts = get_posts( $args );
?>
+
foreach ( $rand_posts as $post ) :  
    <li><a href="<?php the_permalink(); ?>"><?php the_title(); ?></a></li>
+
  setup_postdata( $post ); ?>
<?php endforeach; ?>
+
<li><a href="<?php the_permalink(); ?>"><?php the_title(); ?></a></li>
    </ul>
+
<?php endforeach;
</li></ul> </nowiki>
+
wp_reset_postdata(); ?>
 +
</ul>
 +
</pre>
  
<div id="Show_all_attachment">
+
=== 添付ファイルを全て表示する ===
=== アタッチメントを全て表示する ===
+
</div>
+
  
 
テンプレートの [[The_Loop|Loops]] 外に記述します。
 
テンプレートの [[The_Loop|Loops]] 外に記述します。
  
<?php
+
<pre>
+
<?php
$args = array(
+
$args = array( 'post_type' => 'attachment', 'posts_per_page' => -1, 'post_status' => 'any', 'post_parent' => null );  
'post_type' => 'attachment',
+
$attachments = get_posts( $args );
'posts_per_page' => -1,
+
if ( $attachments ) {
'post_status' => null,
+
foreach ( $attachments as $post ) {
'post_parent' => null, // any parent
+
setup_postdata( $post );
);  
+
the_title();
$attachments = [[テンプレートタグ/get_posts|get_posts]]($args);
+
the_attachment_link( $post->ID, false );
if ($attachments) {
+
the_excerpt();
foreach ($attachments as $post) {
+
}
[[関数リファレンス/setup_postdata|setup_postdata]]($post);
+
wp_reset_postdata();
[[テンプレートタグ/the_title|the_title]]();
+
}
[[テンプレートタグ/the_attachment_link|the_attachment_link]]($post->ID, false);
+
?>
[[テンプレートタグ/the_excerpt|the_excerpt]]();
+
</pre>
}
+
}
+
+
?>
+
  
<div id="Show_attachments_for_the_current_post">
+
=== 現在の記事の添付ファイルを表示する ===
=== 現在の記事のアタッチメントを表示する ===
+
</div>
+
  
[[The_Loop]] 内(<var>$post->ID</var> が利用できるところ)に記述します。
+
[[The_Loop|ループ]]内(<var>$post->ID</var> が利用できるところ)に記述します。
  
<?php
+
<pre>
+
<?php
$args = array(
+
$args = array( 'post_type' => 'attachment', 'posts_per_page' => -1, 'post_status' =>'any', 'post_parent' => $post->ID );  
'post_type' => 'attachment',
+
$attachments = get_posts( $args );
'posts_per_page' => -1,
+
if ( $attachments ) {
'post_status' => null,
+
foreach ( $attachments as $attachment ) {
'post_parent' => $post->ID
+
echo apply_filters( 'the_title' , $attachment->post_title );
);  
+
the_attachment_link( $attachment->ID , false );
$attachments = [[テンプレートタグ/get_posts|get_posts]]($args);
+
}
if ($attachments) {
+
}
foreach ($attachments as $attachment) {
+
?>
echo [[関数リファレンス/apply_filters|apply_filters]]('the_title', $attachment->post_title);
+
</pre>
[[テンプレートタグ/the_attachment_link|the_attachment_link]]($attachment->ID, false);
+
}
+
}
+
+
?>
+
  
<div id="Parameters_WordPress_2.6+">
+
=== スラッグをもとに投稿を取得する ===
== パラメータ(WordPress 2.6以降) ==
+
</div>
+
  
"[[テンプレートタグ/get_posts#Parameters:_WordPress_2.5_And_Older|WordPress 2.5以前]]"のパラメータに加えて、<tt>get_posts()</tt> は、<tt>[[テンプレートタグ/query_posts#Parameters|query_posts()]]</tt> が取るパラメータを取ることができます。これらの関数は内部で同じデータベースクエリを使用します。
+
投稿スラッグをもとに投稿 ID を取得できます。
  
'''注:''' [[Version 2.6]] で orderby オプションがいくつか変更されました。<tt>post_</tt> で始まるフィールドは、この部分が名前から削除されています。例えば、<tt>post_title</tt> は <tt>title</tt> で、<tt>post_date</tt> は <tt>date</tt> です。
+
<pre>
 +
<?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;
 +
}
 +
?>
 +
</pre>
  
'''注: ''' [[Version 3.0]] から、 include および exclude パラメータに、ページ ID 配列を使用することができます。
+
=== タクソノミーパラメータ ===
  
'''注: ''' get_posts はデフォルトで <tt>'suppress_filters'=>true</tt> を使用します。一方、<tt>[[テンプレートタグ/query_posts|query_posts()]]</tt> はデフォルトでフィルターを適用します。WPML のようなクエリを変更するプラグインを使用する場合に混乱するかもしれません。
+
<p class="information">'''注:''' タクソノミー名をキーとする方法(以下の1番目の例)は、バージョン 3.1 以降は'''非推奨'''になりました。代わりに <code>'tax_query'</code> を使用してください(2番目の例)。</p>
  
<div id="Parameters_WordPress_2.5_And_Older">
+
特定のタクソノミーと関連する投稿を表示します。カスタム投稿タイプに対して登録されたタクソノミーを指定した場合、'category' ではなく代わりに '{custom_taxonomy_name}'(カスタムタクソノミー名)を使って下さい。例えば、"genre"(ジャンル)というタクソノミーがあり、"jazz" というジャンルに分類された投稿のみを表示したい時は以下のコードを使います。
== パラメータ(WordPress 2.5以前) ==
+
</div>
+
  
{{Parameter|$numberposts|整数|取得する投稿の数。0 にするとto use the max number of posts per page の最大値。-1 にすると制限無。|オプション|5}}
+
<pre>
 +
<?php
 +
$args = array(
 +
'posts_per_page' => 8,
 +
'orderby' => 'rand',
 +
'post_type' => 'albums',
 +
'genre' => 'jazz',  // 非推奨のため 'tax_query' を使ってください
 +
'post_status' => 'publish'
 +
);
 +
$show_albums = get_posts( $args );
 +
?>
 +
</pre>
  
{{Parameter|$offset|整数|先頭から何件の投稿を除外するか。|オプション|0}}
+
以下の例では、"tax_query" を使い、"genre" カスタムタクソノミーの "jazz" に分類された投稿のみを取得します。
  
{{Parameter|$category|整数|指定したカテゴリID の投稿のみを返す。(-3のように)カテゴリID をマイナスにすると、このカテゴリID以外の投稿を返す。複数のカテゴリを指定する場合は、カテゴリIDをカンマで区切る(配列での指定は不可)。|オプション}}
+
<pre>
 +
$args = array(
 +
'tax_query' => array(
 +
array(
 +
'taxonomy' => 'genre',
 +
'field' => 'slug',
 +
'terms' => 'jazz'
 +
)
 +
)
 +
);
 +
$postslist = get_posts( $args );
 +
</pre>
  
{{Parameter|$category_name|文字列|指定したカテゴリー名またはカテゴリースラッグの投稿のみを返す。|オプション}}
+
他の例については、<tt>WP_Query</tt> ドキュメンテーションの [[関数リファレンス/WP_Query#Taxonomy_Parameters|タクソノミーパラメータのセクション]]をご覧ください。
  
{{Parameter|$tag|文字列|指定したタグスラッグの投稿のみを返す。複数のタグスラッグを指定する場合は、カンマで区切ると、いずれかのタグにマッチした投稿をすべて返す。タグスラッグを空白で区切って指定すると、すべてのタグにマッチした投稿を返す。|オプション}}
+
=== カスタムフィールドパラメータ ===
  
{{Parameter|$orderby|文字列|以下に示す様々な値(空白で区切る)で並べ替える。
+
あるカスタムフィールドと関連する投稿のみを表示します。以下の例では、"meta_query" を使い、"product" 投稿タイプで "featured" というメタキーが "yes" という値を持つ投稿を取得します。:
<ul>
+
<li><tt>'author'</tt> - 著者ID。</li>
+
<li><tt>'category'</tt> - カテゴリID。</li>
+
<li><tt>'content'</tt> - コンテンツ。</li>
+
<li><tt>'date'</tt> - 作成日。</li>
+
<li><tt>'ID'</tt> - 投稿ID。</li>
+
<li><tt>'menu_order'</tt> - メニュー。ページとアタッチメントでのみ有効。</li>
+
<li><tt>'mime_type'</tt> - MIME type。アタッチメントでのみ有効。</li>
+
<li><tt>'modified'</tt> - 最終更新日</li>
+
<li><tt>'name'</tt> - stub。</li>
+
<li><tt>'parent'</tt> - 親ID。</li>
+
<li><tt>'password'</tt> - パスワード。</li>
+
<li><tt>'rand'</tt> - ランダム。</li>
+
<li><tt>'status'</tt> - ステータス。</li>
+
<li><tt>'title'</tt> - タイトル。</li>
+
<li><tt>'type'</tt> - 投稿タイプ。</li>
+
</ul>
+
'''注:'''
+
<ul>
+
<li><tt>ID</tt> と <tt>rand</tt> は [[Version 2.5]]から利用可能。</li>
+
</ul>|オプション|date}}''
+
  
{{Parameter|$order|文字列|<tt>$orderby</tt> でのソート方式。有効な値:<ul><li><tt>'ASC'</tt> - 昇順(低から高)。</li><li><tt>'DESC'</tt> - 降順(高から低)。</li></ul>|オプション|DESC}}
+
<pre>
 
+
$args = array(
{{Parameter|$include|文字列|表示したい投稿のID。カンマまたは空白で区切る。次の例では、6 つの投稿を表示する。<ul><li>'45,63,78,94,128,140'</li></ul>'''注: '''''このパラメータを使用すると posts_per_page, offset, category, exclude, meta_key, meta_value, および post_parent パラメータを上書きします。''|オプション}}
+
'post_type' => 'product',
 +
'meta_query' => array(
 +
array(
 +
'key' => 'featured',
 +
'value' => 'yes',
 +
)
 +
)
 +
);
 +
$postslist = get_posts( $args );
 +
</pre>
  
{{Parameter|$exclude|文字列|表示したくない投稿のID。カンマまたは空白で区切る。( <tt>$include</tt> パラメータを参照)|オプション}}
+
他の例については、<tt>WP_Query</tt> ドキュメンテーションの [[関数リファレンス/WP_Query#Custom_Field_Parameters|カスタムフィールドパラメータのセクション]]をご覧ください。
  
{{Parameter|$meta_key and $meta_value|文字列|メタフィールド(カスタムフィールド)のキーと値を持つ投稿のみ表示する。両方のパラメータ指定が必要(一方だけでは動作しない)。|オプション}}
+
==変更履歴==
  
{{Parameter|$post_type|文字列|表示する投稿のタイプ。利用可能なオプション:<ul><li>post - デフォルト</li><li>page</li><li>attachment</li><li>''any'' - 全て</li></ul>|オプション|post}}
+
* [[Version 1.2|1.2.0]] 以降
  
{{Parameter|$post_status|文字列|指定したステータスの投稿を表示する。複数のステータスを指定する場合はカンマで区切る。利用可能なオプション:<ul><li>publish - デフォルト</li><li>private</li><li>draft</li><li>future</li><li>inherit - <tt>$post_type</tt> がアタッチメントのときのデフォルト</li><li>''(blank)'' - すべてのステータス(WordPress version 2.8 以降では、'any' を使用する。変更された時期は不明。)</ul>|オプション|publish}}
+
==ソースファイル==
  
{{Parameter|$post_parent|整数|このIDの投稿の子のみを表示する。|オプション}}
+
<tt>get_posts()</tt> は {{Trac|wp-includes/post.php}} にあります。
  
{{Parameter|$nopaging|真偽値|ページングを有効/無効にする。ページングを無効にすると <tt>$numberposts</tt> オプションが無視される。|オプション}}
 
 
<div id="Related">
 
 
== 関連 ==
 
== 関連 ==
</div>
 
  
* [http://wordpress.org/extend/plugins/post-types-order/ Change Order for Custom Post Types in WordPress 3.0 and up]
 
 
{{原文|Template Tags/get posts|95879}}<!-- 12:42, 7 December 2010 Nsp-code 版 -->
 
  
 
{{Query Tags}}
 
{{Query Tags}}
242行目: 341行目:
 
{{DEFAULTSORT:Get_posts}}
 
{{DEFAULTSORT:Get_posts}}
 
[[Category:テンプレートタグ]]
 
[[Category:テンプレートタグ]]
 +
 +
[[en:Template_Tags/get_posts]]
 +
[[es:Etiquetas_de_plantilla/get_posts]]
 +
[[zh-cn:模版标签/get_posts}]]
 +
 +
{{原文|Template Tags/get posts|152429}}<!-- 09:01, 27 June 2015‎ Bishoy.A 版 -->

2016年8月2日 (火) 12:05時点における最新版

説明

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 $args = array(
	'posts_per_page'   => 5,
	'offset'           => 0,
	'category'         => '',
	'category_name'    => '',
	'orderby'          => 'date',
	'order'            => 'DESC',
	'include'          => '',
	'exclude'          => '',
	'meta_key'         => '',
	'meta_value'       => '',
	'post_type'        => 'post',
	'post_mime_type'   => '',
	'post_parent'      => '',
	'author'	   => '',
	'post_status'      => 'publish',
	'suppress_filters' => true 
);
$posts_array = get_posts( $args ); ?>

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

パラメータ

パラメータの使い方の例は、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 に直接渡すからです。

注意: category_name パラメータは カテゴリ名では、この場合、文字列にする必要があります。


'orderby'
文字列) (オプション) 取得した投稿をソートする
初期値: 'date'
  • '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' の項に記載の数字での並べ替えを行う。
  • 'post__in' - 'include' パラメータで渡したものと同じ順序に一致。
注: get_pages()'orderly' ではなく、'sort_column' を使用します。また get_pages()'post_' を前置します: 'author, date, modified, parent, title, excerpt, content'
'post_mime_type'
文字列 / 配列) (オプション) mime types の一覧またはコンマ区切り
初期値: なし

返り値

(配列) 
WP_Post オブジェクトのリスト。

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

用例

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

フロントページで 1 件だけ表示してから、カテゴリーID が 1 の投稿へのリンクをそれに先行する 5 件分表示したい場合、下記のようにします。

<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 endif;
if ( !empty( $nextID ) ): ?>
<div class="alignright">
<a href="<?php echo get_permalink( $nextID ); ?>"
 title="<?php echo get_the_title( $nextID ); ?>">Next</a>
</div>
<?php endif; ?>
</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; ?>

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

アルファベット順に昇順で最近の 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;
}
?>

タクソノミーパラメータ

注: タクソノミー名をキーとする方法(以下の1番目の例)は、バージョン 3.1 以降は非推奨になりました。代わりに 'tax_query' を使用してください(2番目の例)。

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

<?php
$args = array(
	 'posts_per_page' => 8,
	 'orderby' => 'rand',
	 'post_type' => 'albums',
	 'genre' => 'jazz',  // 非推奨のため 'tax_query' を使ってください
	 '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 にあります。

関連

記事

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

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


関数リファレンステンプレートタグ目次もご覧ください。
[[zh-cn:模版标签/get_posts}]]

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