get_posts

(1.2.0以降)
get_posts - 条件にマッチする投稿情報を取得する

説明

array get_posts( [ mixed $args = null ] )
条件を指定して検索し、マッチしたすべてのデータを取得する。

パラメータ

  • $args
    検索条件を指定する連想配列。主なキーワードは次の通り。
    キーワード意味
    numberposts取得件数(省略時は5)
    offset取得開始位置(省略時は0:先頭)
    category何れかのカテゴリーに属する投稿情報はカテゴリーIDを、何れのカテゴリーにも属さない投稿情報は-を付けたカテゴリーIDを指定(複数指定する場合は,で区切る)
    orderbyソート対象を示すauthor、date、category、title、modified、ID、menu_order、randなど(省略時は'post_date':投稿日時)
    orderソート順を示すASCかDESC(省略時はDESC)
    include取得したい投稿情報ID(複数指定する場合は,で区切る)
    exclude取得したくない投稿情報ID(複数指定する場合は,で区切る)
    meta_keyカスタムフィールドの名前
    meta_valueカスタムフィールドの値
    post_type'post'、'page'、'attachment'、'any'などの投稿情報タイプ(省略時は'post':投稿ページ)
    suppress_filters最終的な検索条件に対してフィルター処理を行わない場合はtrue、フィルター処理を行う場合はfalseを指定(省略時はtrue)
    post_status投稿ステータスを示す'auto-draft'、'draft'、'inherit'、'private'、'publish'、'any'など(省略時は、post_typeが'attachment'ならば'inherit'、以外は'publish')
    post_parent親の投稿ID(省略時は0)

返り値

マッチしたすべてのデータが格納された配列を返す。

注意

同じように条件を指定できる関数にはquery_posts関数がある。query_posts関数との違いは、get_posts関数は単に情報を取得するだけでグローバル変数には影響を与えないが、query_posts関数はグローバル変数の$wp_queryを使用し、$postなどの関連する情報も更新される。また、指定できる条件はget_posts関数の方が少ない。公開されているパラメータはquery_posts関数よりも少ないが、内部的には同じである。
パラメータnumberpostsに-1を指定した場合は条件にマッチした全件を取得できる。
パラメータpost_parentは、添付ファイルなどの子投稿情報を取得する場合に使用できる。
パラメータpost_typeに'attachment'と他のタイプを同時に指定しpost_statusを省略した場合は、post_statusは'publish'になるため、投稿記事の子になっているメディア情報は取得できないので要注意。
なお、パラメータは内部的に次のように変換される。
パラメータ名変換後のパラメータ名
numberpostsposts_per_page
categorycat
includepost__in
excludepost__not_in

使用例

  • 10件の投稿情報を取得する。
    <?php $found_posts = get_posts( 'numberposts=10' ); ?>
  • 投稿IDが102と125の投稿情報を取得する。
    <?php $found_posts = get_posts( array( 'include'=>array( 102, 125 ) ) ); ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/post.php

関連

お勧めコンテンツ

ツイート引用が簡単になる仕組み(2012年6月8日 登録)

WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。

Paste JSON text:プラグイン作ってみました(2012年1月19日 登録)

動作検証用のサーバーと本番サーバーで投稿データの同期作業(コピー&ペースト)を支援するプラグインです。動作検証用のサーバーで投稿記事をJSONテキストに変換してクリップボードにコピー。本番サーバーの新規投稿ページでクリップボードにコピーしたJSONテキストをペーストして、投稿記事のコピー&ペーストを実現します。複数サーバー間で投稿記事の同期を行っている方は、お試しあれ。

コメントの「ウェブサイト」止めました(2014年4月14日 登録)

とあるサイトのスパムコメントが多く、その都度のスパム指定するのが面倒である。これまでいくつか対策を行ってきたが、そういった対応にもいい加減うんざりしてきたので、試験的に「ウェブサイト」を無効化しようと思った。

4.2.3でちょっと変わったショートコード(2015年7月25日 登録)

4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。

カレンダーウィジェットをAjaxで切り替える(2011年8月22日 登録)

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

最終更新日時 : 2014-06-01 23:22