説明
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年12月11日 更新)
バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。
「姓」の後に「名」を(2013年11月6日 更新)
WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。
ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)
WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)
今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。
投稿情報を連想配列で参照する(2018年5月27日 更新)
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。