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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。