get_pages:WordPress私的マニュアル

(1.5.0以降)
get_pages - 固定ページを取得する

array get_pages( [ mixed $args = '' ] )

固定ページを取得する。

$args

検索条件を文字列または連想配列で指定（省略時は''）。主なキーワードは次の通り。

キーワード	意味
child_of	子孫のページを取得するための親固定ページのID（省略時は0）
sort_order	並び順として'ASC'か'DESC'を指定（省略時は'ASC'）。
sort_column	ソート対象として'ID'、'post_title'、'menu_order'などのカラム名か'rand'、'comment_count'を指定（省略時は'post_title'）
hierarchical	下階層を取得する場合は1、しない場合は0を指定（省略時は1）
exclude	除外する固定ページのID（省略時はarray()）
include	取得する固定ページのID（省略時はarray()）
meta_key	カスタムフィールドの名前（省略時は''）
meta_value	カスタムフィールドの値（省略時は''）
authors	投稿者ID。複数指定する場合は空白文字かカンマで区切る（省略時は''）
parent	親の固定ページのID（省略時は-1）
exclude_tree	除外する親固定ページのID（省略時は''）
number	取得件数（省略時は''）
offset	取得位置を示すオフセット（省略時は0）
post_type	投稿情報タイプ（省略時は'page'）
post_status	投稿ステータスを示す'auto-draft'、'draft'、'inherit'、'private'、'publish'、'any'など（省略時は'publish'）

パラメータ$argsで指定された条件にマッチする固定ページ情報を配列で返す。マッチする固定ページがない場合は空の配列となる。固定ページ情報の内容は投稿情報と同じ（詳しくは$postを参照）。

投稿ページを取得するget_posts関数の固定ページ版的な位置づけの関数で、検索条件のパラメータは多少異なっている。 includeパラメータを指定した場合は、以下のパラメータは強制的に書き換えられる。

またchild_ofとparentキーワードの違いは、取得する階層にある。child_ofキーワードを指定した場合はそれ以下すべてが対象になるが、parentはその直下のみが対象になる。

公開されているすべての固定ページを取得する。
<?php $pages = get_pages(); ?>
文字列で条件を指定して固定ページを取得する。
<?php $pages = get_pages( 'number=10' ); ?>
連想配列で条件を指定して固定ページを取得する。
<?php $pages = get_pages( array( 'number'=>10, 'offset'=>10) ); ?>

取得した固定ページ情報を返す直前にget_pagesフィルターが実行される。$pagesには、取得した固定ページ情報の配列が、$rには展開された検索パラメータが格納される。

$pages = apply_filters( 'get_pages', $pages, $r );

実行するアクションはありません。

/wp-includes/post.php