説明
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
関連
お勧め
スマートフォン向けの振り分けを自前で行う(2012年1月23日 更新)
PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。使っていないか確認しないとね!(2017年11月18日 更新)
2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここではプラグインのロード順を制御する(2014年6月9日 更新)
これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。
wp_titleからwp_get_document_titleへ(2018年5月27日 更新)
先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。
初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 更新)
投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。