説明
パラメータ
- $args検索条件を指定する文字列または連想配列。主なキーワードは次の通り。
キーワード 意味 numberposts 取得する件数(省略時は-1で、全件を取得) post_type 取得する付加情報のタイプとして'any'、'post'、'pages'、'attachment'などを指定(省略時は'any'で、すべてのタイプ) post_status 取得する付加情報のステータスとして'any'、'inherit' : 'publish'などを指定(省略時は'any'で、すべてのステータス) post_parent 付加情報する投稿情報のIDなどを指定(省略時は0) post_mime_type 付加情報のMIMEタイプとして'image'などを指定 order ASCまたはDESCを指定(省略時はDESCで、降順) orderby 取得時のデータの並び順を決める項目名を指定(省略時はpost_dateで、投稿日時) - $output取得するデータ形式としてOBJECT、ARRAY_A、ARRAY_Nを指定(省略時はOBJECT)
返り値
マッチしたすべてのデータをパラメータ$outputで指定されたデータ形式の配列を返す。$outputでOBJECTを指定した場合は、現在の投稿情報である $postと同じフォーマットとなる。添付ファイル情報の場合は次のような内容になる。
プロパティ名 | データ型 | 意味 |
---|---|---|
ID | int | 投稿ID |
post_author | 投稿者ID | |
post_date | string | 投稿日時 |
post_date_gmt | string | 投稿日時(GMT) |
post_content | string | 説明 |
post_title | string | 投稿タイトル |
post_excerpt | string | キャプション |
post_status | string | 投稿状態('inherit'など) |
comment_status | string | コメント投稿状態('open'など) |
ping_status | string | トラックバック/ピンバック受付状態('open'など) |
post_password | string | パスワード(公開状態がパスワード保護時) |
post_name | string | 投稿名(パーマリンク設定で%postname%使用時) |
to_ping | string | |
pinged | string | |
post_modified | string | 更新日時 |
post_modified_gmt | string | 更新日時(GMT) |
post_content_filtered | string | |
post_parent | int | 親投稿記事の投稿ID |
guid | string | 添付ファイルURL(FQDN) |
menu_order | int | |
post_type | string | 投稿情報タイプ('attachment'など) |
post_mime_type | string | MIMEタイプ('image/jpeg'など) |
comment_count | int | コメント数 |
ancestors | array | |
filter | string | 適用されたフィルター名('raw'など) |
注意
この関数内では get_postsを呼び出しており、パラメータ$argsで指定できるパラメータは共通しているが、省略時の値は異なる(特に'post_status'は'any'なので要注意)。
パラメータpost_parentを省略すると親の投稿情報IDは0になるため、トップレベルにある通常の投稿情報が検索対象となる。現在の投稿情報の付加情報を取得する場合は、post_parentで現在の投稿情報IDを指定しなければならない。
なお画像ファイルの代替テキストは、取得したデータの投稿IDを使い、 get_post_meta関数で取得する。
使用例
- 投稿情報IDが10の投稿情報の添付ファイル情報を取得する。<?php $attachments = get_children( 'post_parent=10&post_type=attachment' ); ?>
フィルター
実行するフィルターはありません。アクション
実行するアクションはありません。ソースファイル
/wp-includes/post.php最終更新 : 2018年08月24日 14:26
関連
お勧め
テーブルブロックを定形に整える(2021年12月27日 更新)
ブロックエディターについて調べていると、「段落ブロックをもう少しカスタマイズした」で使ったRichTextShortcutとは別にショートカットキーを使うためのKeyboardShortcutsが見つかった。今回はこのKeyboardShortcutsを使ってテーブルブロックを定形に整える仕組みを考えてみた。
各種リンクを取得する関数一覧(2014年6月12日 更新)
サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。
スクリプトファイルのバージョンパラメータを変更する(2018年5月27日 更新)
Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。
4.2の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2018年5月27日 更新)
ダッシュボードの「アクティビティ」ウィジェットは「投稿(post)」の状況を表示し、固定ページ(page)やカスタム投稿タイプの投稿記事の状況については標準では表示されない。このことに対して以前『3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する』を紹介したのだが、4.2では新しいフィルターが追加され、カスタマイズが少し容易になった。
投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)
WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。