wp_list_pages() の使い方|説明・引数・注意点

説明

wp_list_pages() は、固定ページの一覧を、HTMLのリストとして出力する関数です。

基本構文

wp_list_pages( array|string $args = '' ): string|void

引数

  • $args:title_li、sort_column、depth、exclude、echo など

戻り値

echo が false のときのみ文字列。

使い方(サンプル)

wp_list_pages( array( 'title_li' => '', 'depth' => 1 ) );

注意点

  • li 要素のみを出力するため、外側の ul が必要です。

実務での使いどころ

  • 固定ページの一覧を、リスト(<li>)として、そのまま出力するとき。
  • サイトマップや、サイドバーの、ページ一覧を作るとき。

よくあるミスと対処

  • <ul> で囲んでいない。この関数は、<li> だけを出力する。
  • 見出し(title_li)が、既定で出力される。見出しが不要なら、'title_li' => '' を指定する。
  • 除外したいページを、exclude で指定していない。

NG例

wp_list_pages(); // ul がなく、見出しも出る

OK例

echo '<ul>';
wp_list_pages( array(
	'title_li' => '',
	'exclude'  => '2,3',
) );
echo '</ul>';

使い分け早見表

関数 出力するもの
wp_list_pages() 固定ページの、リスト
wp_dropdown_pages() 固定ページの、プルダウン
get_pages() 固定ページを、配列で取得する

関連項目

get_pages()、wp_nav_menu()

公式リファレンス:wp_list_pages() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました