get_children

（2.0.0以降）
get_children - 投稿情報の付加投稿情報を取得する

説明

mixed get_children( [ mixed $args = '' [ , string $output = OBJECT ] ] )
投稿情報に付加されている投稿情報（子供の投稿情報）を検索し、マッチしたすべてのデータを取得する。

パラメータ

  • $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'などを指定
    orderASCまたはDESCを指定（省略時はDESCで、降順）
    orderby取得時のデータの並び順を決める項目名を指定（省略時はpost_dateで、投稿日時）
  • $output
    取得するデータ形式としてOBJECT、ARRAY_A、ARRAY_Nを指定（省略時はOBJECT）

返り値

マッチしたすべてのデータをパラメータ$outputで指定されたデータ形式の配列を返す。$outputでOBJECTを指定した場合は、現在の投稿情報である $postと同じフォーマットとなる。添付ファイル情報の場合は次のような内容になる。

プロパティ名データ型意味
IDint投稿ID
post_authorintstring投稿者ID
post_datestring投稿日時
post_date_gmtstring投稿日時（GMT）
post_contentstring説明
post_titlestring投稿タイトル
post_excerptstringキャプション
post_statusstring投稿状態（'inherit'など）
comment_statusstringコメント投稿状態（'open'など）
ping_statusstringトラックバック/ピンバック受付状態（'open'など）
post_passwordstringパスワード（公開状態がパスワード保護時）
post_namestring投稿名（パーマリンク設定で%postname%使用時）
to_pingstring
pingedstring
post_modifiedstring更新日時
post_modified_gmtstring更新日時（GMT）
post_content_filteredstring
post_parentint親投稿記事の投稿ID
guidstring添付ファイルURL（FQDN）
menu_orderint
post_typestring投稿情報タイプ（'attachment'など）
post_mime_typestringMIMEタイプ（'image/jpeg'など）
comment_countintコメント数
ancestorsarray
filterstring適用されたフィルター名（'raw'など）

注意

この関数内では get_postsを呼び出しており、パラメータ$argsで指定できるパラメータは共通しているが、省略時の値は異なる（特に'post_status'は'any'なので要注意）。
パラメータpost_parentを省略すると親の投稿情報IDは0になるため、トップレベルにある通常の投稿情報が検索対象となる。現在の投稿情報の付加情報を取得する場合は、post_parentで現在の投稿情報IDを指定しなければならない。

なお画像ファイルの代替テキストは、取得したデータの投稿IDを使い、 get_post_meta関数で取得する。

$alt_text = get_post_meta( $attachments[0]->ID, '_wp_attachment_image_alt', true );

使用例

  • 投稿情報IDが10の投稿情報の添付ファイル情報を取得する。
    <?php $attachments = get_children( 'post_parent=10&post_type=attachment' ); ?>

フィルター

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

アクション

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

ソースファイル

/wp-includes/post.php

最終更新 : 2018年08月24日 14:26

関連

参考

Code Reference: get_children

お勧め

初期化に関連するアクションのおさらい（2013年11月27日 更新）

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

任意の名前でエラーログファイルを指定する（2019年2月15日 更新）

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

wp_titleからwp_get_document_titleへ（2018年5月27日 更新）

先週、WordPress 4.4 beta1（以降4.4 beta1）が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

4.4では投稿ページも専用テンプレートが適用できる（2018年5月27日 更新）

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

32ピクセルのサイトアイコンを別の画像ファイルに変更する（2018年5月27日 更新）

「サイトアイコン」は4.3の新機能の1つ。管理画面で適当な画像ファイルを指定するだけでサイトアイコンが適用されます。そんなサイトアイコンで、既存の favicon.ico を併用する方法を紹介します。