get_pages()


WordPressのget_pages()関数は、サイト内のページを取得するために使用されます。この関数は、指定された条件に基づいてページのリストを配列として返します。

構文

get_pages( array $args = array() );

引数の説明:

  • $args(array) — ページを取得するための条件を指定する配列。以下のキーを使用できます:
    • 'sort_order'(string) — ページの並び順（昇順または降順）。デフォルトは’ASC’。
    • 'sort_column'(string) — ページを並べ替える基準となる列（例：’post_title’, ‘post_date’）。デフォルトは’post_title’。
    • 'exclude'(string|array) — 除外するページのID。
    • 'include'(string|array) — 含めるページのID。
    • 'child_of'(int) — 指定した親ページの子ページのみを取得します。
    • 'parent'(int) — 指定した親ページの直接の子ページを取得します。
    • 'hierarchical'(bool) — 階層構造を維持するかどうか。デフォルトはtrue。
    • 'number'(int) — 取得するページの数。

例1: すべてのページを取得する

この例では、サイト内のすべてのページを取得します。

<?php $pages = get_pages(); foreach ($pages as $page) { echo $page->post_title . '<br>'; } ?>

例2: 特定の親ページの子ページを取得する

この例では、IDが5の親ページの子ページを取得します。

<?php $pages = get_pages(array('child_of' => 5)); foreach ($pages as $page) { echo $page->post_title . '<br>'; } ?>

例3: ページを日付順に並べ替える

この例では、ページを投稿日付順に並べ替えます。

<?php $pages = get_pages(array('sort_column' => 'post_date', 'sort_order' => 'desc')); foreach ($pages as $page) { echo $page->post_title . '<br>'; } ?>

例4: 特定のページを除外する

この例では、IDが2と3のページを除外します。

<?php $pages = get_pages(array('exclude' => array(2, 3))); foreach ($pages as $page) { echo $page->post_title . '<br>'; } ?>

例5: 特定のページのみを取得する

この例では、IDが4と5のページのみを取得します。

<?php $pages = get_pages(array('include' => array(4, 5))); foreach ($pages as $page) { echo $page->post_title . '<br>'; } ?>

例6: ページの階層構造を維持しない

この例では、ページの階層構造を無視して取得します。

<?php $pages = get_pages(array('hierarchical' => false)); foreach ($pages as $page) { echo $page->post_title . '<br>'; } ?>

例7: ページ数を制限する

この例では、最大5ページまで取得します。

<?php $pages = get_pages(array('number' => 5)); foreach ($pages as $page) { echo $page->post_title . '<br>'; } ?>

例8: ページをタイトル順に並べ替える

この例では、ページをタイトル順に並べ替えます。

<?php $pages = get_pages(array('sort_column' => 'post_title', 'sort_order' => 'asc')); foreach ($pages as $page) { echo $page->post_title . '<br>'; } ?>

注意点

  • get_pages()は、データベースにクエリを実行するため、大量のページがある場合にパフォーマンスに影響を与える可能性があります。
  • 取得するページの条件を慎重に指定しないと、意図しない結果が返されることがあります。

関連機能：