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

お勧めコンテンツ

適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす（2011年10月18日 登録）

/wp-includes/template-loader.phpではリクエストされたページに応じて現在のテーマにあるテンプレートファイルの中から適切なものを選びに振り分けている。ここでは、さまざまなテンプレートファイルの種類と、テンプレートファイルが省略された場合の内部の動作についてまとめてみる。

リクエスト応答を終了する前に何かを処理する（2013年9月26日 登録）

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

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

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

3.6リリース直前チェック（2013年7月26日 登録）

$wpdbは、WordPressのデータベースにアクセスする際に使用できる便利なオブジェクト。独自テーブルの利用やデータ検索の最適化など、標準提供される関数では実現できないことを手助けしてくれる。そんな$wpdbのescapeメソッドが3.6で非推奨（deprecated）になる。

index.htmlでアーカイブページを表示させる（2011年10月14日 登録）

静的なサイトでは、各ディレクトリにindex.htmlファイルを置き、そのディレクトリの内容を紹介することが多い。WordPressで構築したサイトも同様にできないかと考え、試行錯誤してみた（こんなことを考えてるのは自分だけだろうか！？）。

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