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

説明

条件を指定して検索し、マッチしたすべてのデータを取得する。

パラメータ

• $args
  検索条件を指定する連想配列。主なキーワードは次の通り。

  キーワード	意味
  numberposts	取得件数（省略時は5）
  offset	取得開始位置（省略時は0：先頭）
  category	何れかのカテゴリーに属する投稿情報はカテゴリーIDを、何れのカテゴリーにも属さない投稿情報は-を付けたカテゴリーIDを指定（複数指定する場合は,で区切る）
  orderby	ソート対象を示すauthor、date、category、title、modified、ID、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は、添付ファイルなどの子投稿情報を取得する場合に使用できる。
なお、パラメータは内部的に次のように変換される。

使用例

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

フィルター

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

アクション

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

ソースファイル

/wp-includes/post.php

関連

• get_children - 投稿情報の付加投稿情報を取得する
• query_posts - 条件を指定して投稿情報をロードする

参考

• [WordPress]カスタムタクソノミーの取得関数いろいろ | RuputerFan
• 最近の修正 | 864649

お勧めコンテンツ