wp_list_pages

（1.5.0以降）
wp_list_pages - 固定ページを一覧表示する

説明

string wp_list_pages( [ mixed $args = '' ] )
固定ページを一覧表示する。

パラメータ

  • $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には展開されたパラメータが格納される。
$output = apply_filters('wp_list_pages', $output, $r);

アクション

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

ソースファイル

/wp-includes/post-template.php

最終更新 : 2015年04月28日 10:17

関連

参考

Code Reference: wp_list_pages

お勧め

固定ページのURLの拡張子をhtmlに変更する（2013年3月9日 更新）

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（2011年12月8日 更新）

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

固定ページを投稿ページ用テンプレートファイル（single.php）で表示する（2013年7月31日 更新）

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

HTML entities button：プラグイン作ってみました（2017年12月17日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

Login rebuilder 2.4.0の新機能を紹介（2018年5月27日 更新）

昨日、約半年ぶりにLogin rebuilderをアップデートし、著者ページ（author page）の閲覧を制限できる機能を追加した。この機能は、著者ページの閲覧によってユーザーIDが類推されることを防ぐことが目的としている。