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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。