説明
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などの関連する情報も更新される。また、パラメータnumberpostsに-1を指定した場合は条件にマッチした全件を取得できる。
パラメータpost_parentは、添付ファイルなどの子投稿情報を取得する場合に使用できる。
パラメータpost_typeに'attachment'と他のタイプを同時に指定しpost_statusを省略した場合は、post_statusは'publish'になるため、投稿記事の子になっているメディア情報は取得できないので要注意。
なお、パラメータは内部的に次のように変換される。
| パラメータ名 | 変換後のパラメータ名 |
|---|---|
| numberposts | posts_per_page |
| category | cat |
| include | post__in |
| exclude | post__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
関連
お勧め
Emojin：プラグイン作ってみました（2015年3月21日 更新）
ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）
先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。
HTML entities button：プラグイン作ってみました（2021年4月28日 更新）
以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）
WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。
query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）
先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。