wp_list_pages

パラメータ

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

  キーワード	意味
  depth	表示する階層レベルを指定（省略時は0）
  show_date	更新日時を表示する場合は'modified'を指定（省略時は''）
  date_format	日付の表示書式（省略時は一般設定の日付の書式を適用）
  title_li	タイトルを指定（省略時は'固定ページ'）
  link_before	固定ページのリンクの前に入るテキスト（省略時は''）
  link_after	固定ページのリンクの後に追加するテキスト（省略時は''）
  echo	一覧を表示する場合は1、そのHTMLテキストを取得する場合は0を指定（省略時は1）
  walker	一覧のHTMLを生成する関数を指定（省略時は''）
  child_of	子孫のページを取得するための親固定ページのID（省略時は0）
  sort_order	並び順として'ASC'か'DESC'を指定（省略時は'ASC'）。
  sort_column	ソート対象として'ID'、'post_title'、'menu_order'などのカラム名か'rand'、'comment_count'を指定（省略時は'menu_order, post_title'）
  exclude	除外する固定ページのID（省略時はarray()）
  include	取得する固定ページのID（省略時はarray()）
  authors	投稿者ID。複数指定する場合は空白文字かカンマで区切る（省略時は'menu_order, post_title'）

返り値

パラメータ$argsで'echo'が0の場合、指定された条件にマッチする固定ページ一覧のHTMLテキストを返す。'echo'が1の場合は何も返さない。

注意

内部では get_pages関数を呼び出すため、パラメータのいくつかは共通している。
'depth'を指定することで表示する階層レベルを指定でき、0の場合はすべてを表示する。
なお表示される順番は、デフォルトでは'menu_order, post_title'となっており、「タイトル」よりも「ページ属性」の「順序」が優先される。
また「固定ページ」というタイトルを表示したくない場合は、'title_li'に''を指定する。

使用例

• すべての固定ページの一覧を表示する。
  <?php wp_list_pages(); ?>
• すべての固定ページの一覧を取得する。
  <?php $pages = wp_list_pages( array( 'echo'=>0 ) ); ?>

フィルター

固定ページ一覧を表示（または返す）直前にwp_list_pagesフィルターが実行される。$outputには、固定ページ一覧のテキストが、$rには展開されたパラメータが格納される。

アクション

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

ソースファイル

/wp-includes/post-template.php