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



お勧め

Gutenbergエディターのフォントを変える(2018年10月16日 更新)

Gutenbergエディターを試していてしっくりこないのが、編集時とそれを投稿した際の見た目の違い。GutenbergエディターとテーマTwenty Seventeenとではまったく異なるタイプのフォントが適用されていることが大きな理由である。

WordCamp Tokyo 2013(2013年9月14日 更新)

本日開催された「WordCamp Tokyo 2013」に行ってきました。昨年と同様、会場は大田区産業プラザで、PHPカンファレンスと共催でしたね。

4.2.3でちょっと変わったショートコード(2018年5月27日 更新)

4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。

get_postsとquery_postsを使い分け(2018年5月27日 更新)

get_posts query_postsは、どちらも複数の投稿情報を取得することができる便利な関数である。パラメータとして指定できる内容も共通しているものが多く、query_postsがより詳細なパラメータを指定でき、高機能になっている。

Login rebuilder 2.4.0の新機能を紹介(2018年5月27日 更新)

昨日、約半年ぶりにLogin rebuilderをアップデートし、著者ページ(author page)の閲覧を制限できる機能を追加した。この機能は、著者ページの閲覧によってユーザーIDが類推されることを防ぐことが目的としている。