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



お勧め

Posts filter multiselect:プラグイン作ってみました(2022年4月8日 更新)

先週の金曜日、知り合いの方から「投稿一覧ページで絞り込みを行う際、複数選択できないか」といった問い合わせがあり、その時には「標準では無理ですね」と返答しました。このこと自体は事実なのですが、要するに「複数選択可能なドロップダウンメニュー」が実現できれば対応するのはそれほど難しくないような気がしました。この週末、そんなノリでちょっとコーディングしてできたのがこのプラグインです。

全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)

query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

古めのリビジョンを削除した時のメモ(2022年5月16日 更新)

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

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

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