説明
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
関連
お勧め
投稿一覧ページに「更新日時」カラムを追加してみた(2019年8月27日 更新)
サイトの特性によるが、「投稿」には繰り返し更新するものがある。そんなサイトでは投稿一覧ページに「更新日時」があった方が便利。というわけで、今回は投稿一覧にソートに対応した「更新日時」カラムを追加する方法を紹介する。
連番のユーザーIDを回避できないか考えた(2019年6月4日 更新)
WordPressのユーザーIDは最初の管理者が1、次に追加したユーザーが2といった感じの連番になる。連番のIDはサイトによっては好ましくないケースがあり、連番を回避する方法がないか検討した。
Twenty Seventeenのフォントサイズを変更してみた(2021年12月15日 更新)
先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。
4.2.3でちょっと変わったショートコード(2018年5月27日 更新)
4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。
「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 更新)
投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。