関数リファレンス/get page children

説明

固定ページのリストと親ページの ID を指定して、そのリストから子ページを取得します。

固定ページのリストから、まず指定された ID の固定ページを親とする子ページを探します。そして子ページそれぞれを親として，その子ページを探します。これを繰り返してすべての子ページを探します。参考：子ページを取得するのに SQL クエリは実行しません。

使い方

<?php get_page_children( $page_id, $pages ) ?>

パラメータ

$page_id

（整数） （必須） 固定ページ ID

初期値： なし

$pages

（配列） （必須） 固定ページオブジェクトのリスト。

初期値： なし

戻り値

(配列) 

固定ページオブジェクトのリスト。

参考： $page_id で指定された固定ページは含みません。$page_id を親とする子ページが見つからなければ空の配列を返します。

用例

<?php
// 必要なオブジェクトを用意する
$my_wp_query = new WP_Query();
$all_wp_pages = $my_wp_query->query( array(
    'post_type' => 'page',
    'nopaging'  => 'true'
) );

// 親とする固定ページをオブジェクトとして取得
$portfolio =  get_page_by_title( 'Portfolio' );

// すべての固定ページから Portfolio の子ページを探す
$portfolio_children = get_page_children( $portfolio->ID, $all_wp_pages );

// WP から取得した結果をブラウザへ表示する
echo '<pre>' . print_r( $portfolio_children, true ) . '</pre>';
?>

参考

この関数はそれ自体を再帰的に呼び出します。

変更履歴

バージョン 1.5.1 から導入されました。

ソースファイル

&get_page_children() は wp-includes/post.php にあります。

関連資料

固定ページ: 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()

関数リファレンス、テンプレートタグ目次もご覧ください。

最新英語版： WordPress Codex » Function Reference/get_page_children （最新版との差分）