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

お勧め

5.7の新機能：AJAXでパスワードを取得（2021年2月17日 更新）

日本時間の今朝「WordPress 5.7 Beta 3（以降Beta 3）」が予定通り公開されました。今回は、ソースコードを眺めていた時に気になったパスワードを取得できるAJAXについて確認した。

5.4.1でパーマリンクの仕様が一部変更された件（2020年5月12日 更新）

先月末にリリースされたバージョン5.4.1のアップデートにより、一部のサイトで投稿ページが従来通りに表示されなくなる不具合が発生し、サポートサイトにレポートが上がりました。この件について、ちょっとモヤモヤしたので自分なりに考えてみました。

使っていないか確認しないとね！（2022年6月7日 更新）

2003年に誕生したWordPress。その歴史の中には、廃止予定（deprecated）となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.25.9.0現在、廃止予定となっている関数をまとめて紹介する。

HTML編集モードに定型文ボタンを追加する（2011年6月1日 更新）

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

テーブルの1列目をth要素にしてみる（2021年12月21日 更新）

標準の「テーブル」ブロックでは、tbody要素内のセルはすべてtd要素になっている。テーブルの1列目についてはth要素を使いたいケースがあり、「トグル」コントロールを使って切り替え可能にできないか調べてみた。