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

最終更新 : 2018年05月27日 10:50



お勧め

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

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

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

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

Somewhere search box:プラグイン作ってみました(2021年4月26日 更新)

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

5.3.1: サイト管理者のメールアドレス確認に関するアップデート(2020年4月2日 更新)

セキュリティ&メンテナンスアップデートの5.3.1がリリースされ、その中に以前投稿した「5.3の新機能:サイト管理者のメールアドレスを定期的に確認する」に関連したアップデートがあったので紹介する。