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

お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日 更新）

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる（2019年12月12日 更新）

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア（2018年5月27日 更新）

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている（基本的にはiOSの）絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。（2024年11月13日 更新）

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア（Clear Unknown Formatting）」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群（2018年5月27日 更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。