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

関連

  • get_pages - 固定ページを取得する
  • wp_dropdown_pages - ドロップダウン形式の固定ページリストを表示または取得する

お勧めコンテンツ

ログインページを変える(2012年11月18日 登録)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

dashiconsの一覧表(2017年6月26日 登録)

管理画面のメニューなどで使用されるアイコンはバージョン3.8で追加されたdashiconsは実態はWebフォントであり、cssのクラス名で容易に利用できる。これまでプラグインを作る際に個別に調べたりしていたのだが、全体をパッと見たかったので整理してみた。

プラグインで注意が必要な関数(2013年11月27日 登録)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

4.2.3でちょっと変わったショートコード(2015年7月25日 登録)

4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。

管理者ページに文言を表示する(2012年4月19日 登録)

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

最終更新日時 : 2015-04-28 10:17