説明
パラメータ
- $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
関連
お勧め
任意の名前でエラーログファイルを指定する(2019年2月15日 更新)
来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。
Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
Slightly troublesome permalink:プラグイン作ってみました(2021年4月20日 更新)
カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)
WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。テキストエディタの文字を変更する(2018年5月27日 更新)
テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。