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

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

「関数リファレンス/get children」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/get children 08:41, 28 December 2009 GeertDD)
 
(全体を和訳)
1行目: 1行目:
get_children() retrieves attachments, revisions, or sub-Pages, possibly by post parent. It works similarly to [[Function Reference/get posts|get_posts()]].
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
== Synopsis ==
+
[[関数リファレンス/get children|get_children()]] は指定した投稿の添付ファイルページやサブページやリビジョンを取得します。投稿の一覧を取得する機能は [[テンプレートタグ/get posts|get_posts()]] とほぼ同じです。
  
<tt>array|false <var>$children</var> =& get_children( mixed <var>$args</var> = "", constant <var>$output</var> = OBJECT);</tt>
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
  
== Return values ==
+
<?php $children = &get_children( $args, $output); ?>
  
Returns an associative array of posts (of variable type set by <tt>$output</tt> parameter) with post IDs as array keys, or <tt>false</tt> if no posts are found.
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
  
As of [[Version 2.9]] the return value will be an empty array instead of <tt>false</tt> when no children found.
 
  
== Examples ==
 
  
If you just want to get or display attachments, it's probably a little easier to use <code>[[Template_Tags/get_posts#Show_attachments_for_the_current_post|get_posts()]]</code> instead.
+
[[テンプレートタグ/get posts|get_posts()]] も見てください。
 +
 
 +
{{Parameter|$args|配列|パラメータ|オプション}}
 +
デフォルトは以下の通り
 +
<pre>$defaults = array(
 +
    'post_parent' => 0,
 +
    'post_type'  => 'any',
 +
    'numberposts' => -1,
 +
    'post_status' => 'any',
 +
);</pre>
 +
 
 +
[[テンプレートタグ/タグパラメータの渡し方#Tags_with_query-string-style_parameters | クエリ形式の文字列または配列]] に以下のパラメータを指定します。<tt>post_parent</tt> に投稿 ID を指定すると、その投稿を親に持つ投稿を取得します。ID などの指定が無い場合は、親を持たない投稿を取得します。
 +
 
 +
{{Parameter|$args['numberposts']|整数|取得する投稿の数|オプション|-1}}
 +
:* <code>'-1'</code> - すべての投稿
 +
 
 +
{{Parameter|$args['post_parent']|整数|親投稿の ID|オプション|0}}
 +
:* <code>'0'</code> - 親を持たない投稿
 +
 
 +
{{Parameter|$args['post_type']|文字列|投稿タイプ|オプション|'any'}}
 +
:* <code>'attachment'</code> - 添付ファイル
 +
:* <code>'page'</code> - 固定ページ
 +
:* <code>'revision'</code> - 投稿リビジョン
 +
:* <code>'any'</code> - すべての投稿タイプ
 +
 
 +
{{Parameter|$args['post_status']|文字列|投稿ステータス|オプション|'any'}}
 +
:* <code>'publish'</code> - 公開
 +
:* <code>'draft'</code> - 下書き
 +
:* <code>'inherit'</code> - 継承
 +
:* <code>'any'</code> - すべての投稿ステータス
 +
 
 +
{{Parameter|$args['post_mime_type']|文字列|MIMEタイプ|オプション}}
 +
:* <code>'image'</code> - 画像
 +
:* <code>'video'</code> - 動画
 +
:* <code>'videp/mp4'</code> - 動画(mp4)
 +
 
 +
{{Parameter|$output|定数|戻り値の型|オプション|OBJECT}}
 +
:* <code>'ARRAY_A'</code> - 連想配列
 +
:* <code>'ARRAY_N'</code> - インデックス配列
 +
:* <code>'OBJECT'</code> - 投稿オブジェクト
 +
 
 +
<div id="Return_Values">
 +
== 戻り値 ==
 +
</div>
 +
 
 +
; <tt>連想配列/インデックス配列/投稿オブジェクト</tt> : <tt>$output</tt> で指定した型で投稿の一覧を返します。投稿が無かった場合、[[Version 2.9|バージョン 2.9以降]] は空の配列、それ以前は <var>false</var> を返します。
 +
 
 +
<div id="Examples">
 +
== 用例 ==
 +
</div>
 +
 
 +
添付ファイルを表示する場合、<code>[[テンプレートタグ/get posts#Show_attachments_for_the_current_post|get_posts()]]</code> を使うより簡単です:
  
 
<pre>$images =& get_children( 'post_type=attachment&post_mime_type=image' );
 
<pre>$images =& get_children( 'post_type=attachment&post_mime_type=image' );
20行目: 75行目:
  
 
if ( empty($images) ) {
 
if ( empty($images) ) {
// no attachments here
+
// 添付ファイルが無かった
 
} else {
 
} else {
 
foreach ( $images as $attachment_id => $attachment ) {
 
foreach ( $images as $attachment_id => $attachment ) {
27行目: 82行目:
 
}
 
}
  
//  If you don't need to handle an empty result:
+
//  添付ファイルが無い場合のコードを書かない方法:
  
 
foreach ( (array) $videos as $attachment_id => $attachment ) {
 
foreach ( (array) $videos as $attachment_id => $attachment ) {
33行目: 88行目:
 
}</pre>
 
}</pre>
  
== Default parameters (Version 2.7) ==
+
<div id="Change_Log">
 
+
== 変更履歴 ==
<pre>$defaults = array(
+
</div>
    'post_parent' => 0,
+
    'post_type'  => 'any',
+
    'numberposts' => -1,
+
    'post_status' => 'any',
+
);</pre>
+
 
+
== Parameters ==
+
 
+
See [[Template Tags/get posts|get_posts()]] for a full list of parameters.
+
  
As of [[Version 2.6]], you must pass a non-empty <tt>post_type</tt> parameter (either <tt>attachment</tt> or <tt>page</tt>).
+
* [[Version 2.0|2.0]] : 新規導入
  
; $args
+
<div id="Source_File">
: (mixed) Passing [[Template_Tags/How_to_Pass_Tag_Parameters#Tags_with_query-string-style_parameters | a query-style string or array]] sets several parameters (below). Passing an integer post ID or a post object will retrieve children of that post; passing an empty value will retrieve children of the current post or Page.
+
== ソースファイル ==
; $args['numberposts']
+
</div>
: (integer) Number of child posts to retrieve. Optional; default: -1 (unlimited)
+
; $args['post_parent']
+
: (integer) Pass the ID of a post or Page to get its children. Pass <tt>null</tt> to get any child regardless of parent. Optional; default: <tt>0</tt> (any parent?)
+
; $args['post_type']
+
: (string) Any value from post_type column of the posts table, such as <tt>attachment</tt>, <tt>page</tt>, or <tt>revision</tt>; or the keyword <tt>any</tt>. Default: <tt>any</tt>
+
; $args['post_status']
+
: (string) Any value from the <tt>post_status</tt> column of the wp_posts table, such as <tt>publish</tt>, <tt>draft</tt>, or <tt>inherit</tt>; or the keyword <tt>any</tt>. Default: <tt>any</tt>
+
; $args['post_mime_type']
+
: (string) A full or partial mime-type, e.g. <tt>image</tt>, <tt>video</tt>, <tt>video/mp4</tt>, which is matched against a post's <tt>post_mime_type</tt> field
+
; $output
+
: (constant) Variable type of the array items returned by the function: one of <tt>OBJECT</tt>, <tt>ARRAY_A</tt>, <tt>ARRAY_N</tt>. Optional; default: <tt>OBJECT</tt>
+
  
== Related ==
+
<tt>get_children()</tt> は {{Trac|wp-includes/post.php}} に含まれています。
  
get_children() calls [[Template Tags/get posts|get_posts()]], which calls [[Function Reference/WP Query#Methods|$WP_Query->get_posts()]].
+
<div id="Related">
 +
== 関連資料 ==
 +
</div>
  
[[Template Tags/wp get attachment link|wp_get_attachment_link()]]
+
<tt>get_children()</tt> は [[テンプレートタグ/get posts|get_posts()]] を呼んでいます。[[テンプレートタグ/get posts|get_posts()]] は [[関数リファレンス/WP Query#Methods|$WP_Query->get_posts()]] を呼んでいます。
  
{{Tag Footer}}
+
{{Tag General Tags}}
 +
{{Query String Tag Footer}}
 +
{{DEFAULTSORT:Get_children}}
 
{{原文|Function Reference/get children|81501}}<!-- 08:41, 28 December 2009 GeertDD -->
 
{{原文|Function Reference/get children|81501}}<!-- 08:41, 28 December 2009 GeertDD -->
[[Category:Functions]]
+
[[Category:関数]]
[[Category:Attachments]]
+
 
[[en:Function Reference/get children]]
 
[[en:Function Reference/get children]]

2010年4月26日 (月) 23:12時点における版

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最新版との差分