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

関連

参考

Code Reference: get_children

お勧めコンテンツ

Login rebuilderのログ表示機能を紹介（2015年7月9日 登録）

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

Widgets on dashboard：プラグイン作ってみました（2014年5月6日 登録）

サイトバーなどのページ構成パーツとしてウィジェットを利用し、ある程度頻繁に更新している場合、毎回ウィジェットページを表示するのはちょっとだけ面倒かも。そんなわけで、シンプルにダッシュボードで直接編集できればいいかなと思い、調べてみました。

WordPressの鼓動（2013年10月1日 登録）

WordPressでは、Ajaxを利用する方法の1つとしてadd_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。

日本語が含まれていないコメントを無効化する（2012年1月31日 登録）

日本のユーザーを対象にサービス（情報）展開しているサイトの場合、英文のみのコメントはあまりうれしくない。ましてやスパムコメントの対応は時間の無駄でしかない。そんなわけで、日本語を含んでいないコメントを無効化することにした。

投稿ページにキーワード検索ウィジェットを追加する（2012年6月2日 登録）

「投稿の編集」ページで記事を編集していると、関連する投稿記事を検索したくなることがある。そんな時、「投稿一覧」ページに戻って「キーワード検索」を行えばいいのだが、そのひと手間がちょっとだけ煩わしい。

最終更新日時 : 2014-04-28 00:13