• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/get children

提供: WordPress Codex 日本語版
< 関数リファレンス
2010年4月26日 (月) 23:12時点におけるKz (トーク | 投稿記録)による版 (全体を和訳)

移動先: 案内検索

get_children() は指定した投稿の添付ファイルページやサブページやリビジョンを取得します。投稿の一覧を取得する機能は get_posts() とほぼ同じです。

使い方

<?php $children = &get_children( $args, $output); ?>

パラメータ


get_posts() も見てください。

$args
配列) (オプション) パラメータ
初期値: なし

デフォルトは以下の通り

$defaults = array( 
    'post_parent' => 0,
    'post_type'   => 'any', 
    'numberposts' => -1,
    'post_status' => 'any',
);

クエリ形式の文字列または配列 に以下のパラメータを指定します。post_parent に投稿 ID を指定すると、その投稿を親に持つ投稿を取得します。ID などの指定が無い場合は、親を持たない投稿を取得します。

$args['numberposts']
整数) (オプション) 取得する投稿の数
初期値: -1
  • '-1' - すべての投稿
$args['post_parent']
整数) (オプション) 親投稿の ID
初期値: 0
  • '0' - 親を持たない投稿
$args['post_type']
文字列) (オプション) 投稿タイプ
初期値: 'any'
  • 'attachment' - 添付ファイル
  • 'page' - 固定ページ
  • 'revision' - 投稿リビジョン
  • 'any' - すべての投稿タイプ
$args['post_status']
文字列) (オプション) 投稿ステータス
初期値: 'any'
  • 'publish' - 公開
  • 'draft' - 下書き
  • 'inherit' - 継承
  • 'any' - すべての投稿ステータス
$args['post_mime_type']
文字列) (オプション) MIMEタイプ
初期値: なし
  • 'image' - 画像
  • 'video' - 動画
  • 'videp/mp4' - 動画(mp4)
$output
定数) (オプション) 戻り値の型
初期値: OBJECT
  • 'ARRAY_A' - 連想配列
  • 'ARRAY_N' - インデックス配列
  • 'OBJECT' - 投稿オブジェクト

戻り値

連想配列/インデックス配列/投稿オブジェクト 
$output で指定した型で投稿の一覧を返します。投稿が無かった場合、バージョン 2.9以降 は空の配列、それ以前は false を返します。

用例

添付ファイルを表示する場合、get_posts() を使うより簡単です:

$images =& get_children( 'post_type=attachment&post_mime_type=image' );

$videos =& get_children( 'post_type=attachment&post_mime_type=video/mp4' );

if ( empty($images) ) {
	// 添付ファイルが無かった
} else {
	foreach ( $images as $attachment_id => $attachment ) {
		echo wp_get_attachment_image( $attachment_id, 'full' );
	}
}

//  添付ファイルが無い場合のコードを書かない方法:

foreach ( (array) $videos as $attachment_id => $attachment ) {
	echo wp_get_attachment_link( $attachment_id );
}

変更履歴

  • 2.0 : 新規導入

ソースファイル

get_children()wp-includes/post.php に含まれています。

get_children()get_posts() を呼んでいます。get_posts()$WP_Query->get_posts() を呼んでいます。


記事

コードドキュメンテーション

  • クラス: WP_Query - WP_Query クエリの詳細概要
  • オブジェクト: $wpdb - $wpdb オブジェクトの使い方概要
  • 関数: get_query_var()
  • 関数: query_posts() - 追加カスタムクエリの作成
  • 関数: get_post() - 項目の ID を使ってその投稿のレコードをデータベースから取得する
  • 関数: get_posts() - 項目の配列を返す特別な関数。
  • 関数: get_pages() - ページの配列を返す特別な関数。
  • 関数: have posts() - クエリが記事を返すかどうか判断する条件分岐。
  • 関数: the_post() - クエリの後に自動的にループを設定するのに使われる。
  • 関数: rewind_posts() - 現在のループをクリアする。
  • 関数: setup_postdata() - ループ内で単一クエリ結果のデータを設定する。
  • 関数: wp_reset_postdata() - 以前のクエリを復元する(通常、ループ内のもう一つのループで使われる)。
  • 関数: wp_reset_query()
  • 関数: is_main_query() - 変更するのがメインクエリであるよう保証する。
  • アクションフック: pre_get_posts - 実行される前に WordPress クエリを変更する。
  • アクションフック: the_post - 投稿オブジェクトをクエリの後に変更する。
  • フィルターフック: found_posts - found_posts WP_Query オブジェクトの値を変更する


関連

固定ページ: get_all_page_ids(), get_ancestors(), get_page_link(), get_page_by_path(), get_page_by_title(), get_page_children(), get_page_hierarchy(), get_page_uri() /en, get_pages(), is_page(), page_uri_index() /en, wp_list_pages(), wp_page_menu()


リスト・ドロップダウン関数: wp_list_authors(), wp_list_categories(), wp_list_pages(), wp_list_bookmarks(), wp_list_comments(), wp_get_archives(), wp_page_menu(), wp_dropdown_pages(), wp_dropdown_categories(), wp_dropdown_users()


テンプレートタグへのクエリ文字列型パラメータの渡し方関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/get children最新版との差分