説明
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
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo:プラグイン作ってみました(2019年9月19日 更新)
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。