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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。