wp_list_pages()


WordPressのwp_list_pages()関数は、ウェブサイトのページをリスト形式で表示するために使用されます。この関数は、ページの階層構造を維持しながら、カスタマイズ可能なリストを生成します。

構文

wp_list_pages( string|array $args = '' );

引数の説明:

  • $args(string|array) — ページリストの表示方法を制御するための引数。配列またはクエリ文字列形式で指定できます。
  • depth(int) — 表示するページの階層の深さを指定します。デフォルトは0(すべてのページを表示)。
  • show_date(string) — 日付を表示するかどうかを指定します。’modified’を指定すると最終更新日が表示されます。
  • date_format(string) — 日付のフォーマットを指定します。PHPの日付フォーマットを使用します。
  • child_of(int) — 指定したページIDの子ページのみを表示します。
  • exclude(string) — 表示しないページIDをカンマ区切りで指定します。
  • title_li(string) — リストのタイトルを指定します。空にするとタイトルは表示されません。
  • echo(bool) — 結果を直接表示するか(true)、返すか(false)を指定します。

例1: 基本的なページリストの表示

この例では、すべてのページをリスト形式で表示します。

<?php wp_list_pages(); ?>

例2: 特定のページの子ページを表示

この例では、IDが5のページの子ページのみを表示します。

<?php wp_list_pages('child_of=5'); ?>

例3: ページリストに日付を表示

この例では、ページリストに最終更新日を表示します。

<?php wp_list_pages('show_date=modified'); ?>

例4: 特定のページを除外

この例では、IDが2と3のページを除外して表示します。

<?php wp_list_pages('exclude=2,3'); ?>

例5: リストのタイトルをカスタマイズ

この例では、リストのタイトルを「マイページ」に設定します。

<?php wp_list_pages('title_li=マイページ'); ?>

例6: 階層の深さを制限

この例では、ページの階層を2レベルまで表示します。

<?php wp_list_pages('depth=2'); ?>

例7: 結果を返す

この例では、リストを直接表示せずに変数に格納します。

<?php $pages_list = wp_list_pages('echo=0'); ?>

例8: カスタム日付フォーマット

この例では、日付を「Y年m月d日」形式で表示します。

<?php wp_list_pages('show_date=modified&date_format=Y年m月d日'); ?>

注意点

  • wp_list_pages()は、静的ページに対してのみ機能します。投稿には適用されません。
  • 引数を誤って指定すると、意図しない結果が表示されることがあります。必ず公式ドキュメントを参照してください。

関連機能: