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年05月27日 10:51



お勧め

同じ名前のメタ情報をまとめて削除する(2014年3月21日 更新)

WordPressには、投稿情報、コメント情報、ユーザ情報のそれぞれを拡張できるメタ情報の仕組みが用意されている。投稿情報のメタ情報は「カスタムフィールド」として投稿画面に用意されているので投稿者自身が随時操作できるほか、テーマやプラグインからの操作も容易である。今回の中身はそんなメタ情報の一括削除の話だ。

the_date関数で投稿日を確実に表示する(2011年12月20日 更新)

投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

新「WordPress Events and News」ウィジェットが興味深い(2018年5月27日 更新)

4.8のベータ版ですぐに新機能とわかるのが管理者ダッシュボードの新「WordPress Events and News」ウィジェット。ユーザーが指定した地域近隣で開催されるイベント情報を表示してくれるウィジェットで、この中のフォームがちょっと興味深かった。なおこの記事はWordPress 4.8 beta-2をもとにしており、以降のバージョンで変更される可能性があることをあらかじめ断っておく。

query_posts(WP_Queryクラス)で'tax_query'を使いこなす(2011年9月14日 更新)

2日にわたって投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」「query_posts(WP_Queryクラス)で投稿タグを絞り込む」の続き。今日はカテゴリーや投稿タグ以外ののタクソノミーによる絞り込み、複数のタクソノミーの絞り込みの組み合わせについてまとめてみる。

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。