概要
wp_list_pages関数は、WordPressの固定ページを一覧表示するための関数です。この関数は、テーマのサイドバーやヘッダー、フッターなどに固定ページのリストを表示したい場合に便利です。一般的に、サイトのナビゲーションやトピックの構造を示すためによく使用されます。以下に、この関数が使われる一般的な機能を挙げます。
- サイトのナビゲーションメニューの作成
- 固定ページの階層構造を表示
- 指定した親ページの下にあるページをリストアップ
- 特定のページを除外したリスト作成
- ページのタイトルやID、スラッグをリンクとして表示
- リストのスタイルをカスタマイズ
- ページリストを特定の条件でフィルタリング
- カスタムページテンプレートとの統合
構文
wp_list_pages( $args );
パラメータ
$argsは配列で、以下のようなパラメータを取ることができます。
sort_column: ページのソート基準（例：menu_order、post_title）sort_order: ソート順（ASCまたはDESC）depth: 階層の深さ（整数）exclude: 除外するページIDのカンマ区切りリストinclude: 含めるページIDのカンマ区切りリストtitle_li: リストの見出し（通常は空文字列）echo: 出力方法（trueまたはfalse）
戻り値
この関数は、成功した場合にページのリストを文字列として返します。
関連する関数
使用可能なバージョン
wp_list_pages関数は、WordPressの全バージョンで使用可能です。
コアファイルのパス
この関数はwp-includes/post.phpファイルに含まれています。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
以下にwp_list_pages関数のサンプルコードを5点示します。それぞれのサンプルコードの目的を簡単に説明します。
サンプルコード1: 固定ページのリストをデフォルト表示
<?php
wp_list_pages();
?>
このコードは、デフォルトの設定で固定ページのリストを表示します。
サンプルコード2: 特定の親ページの下にあるページリスト表示
<?php
wp_list_pages(array(
'child_of' => 42, // 親ページのID
'title_li' => '', // タイトルを非表示
));
?>
このコードは、IDが42のページを親として、その子ページのみを表示します。
サンプルコード3: ページをタイトル順に表示
<?php
wp_list_pages(array(
'sort_column' => 'post_title',
'sort_order' => 'ASC'
));
?>
このコードは、ページをタイトルのアルファベット順に昇順で表示します。
サンプルコード4: 特定のページを除外
<?php
wp_list_pages(array(
'exclude' => '5,10', // 除外するページのID
));
?>
このコードは、IDが5と10のページをリストから除外して表示します。
サンプルコード5: 階層を2階層まで表示
<?php
wp_list_pages(array(
'depth' => 2
));
?>
このコードは、固定ページのリストを2階層まで表示し、階層を持つページの場合に親子関係を示します。
これらのサンプルコードはすべて著作権フリーのものであり、独自に作成されたものです。ただし、具体的な引用元はありません。