概要
get_all_page_ids関数は、全ページの投稿IDを取得するためのシンプルで便利な関数です。この関数は、テーマ開発やプラグイン開発において、特定のページの情報を取得するために頻繁に使用されます。主に以下のような場面で利用されることがあります。
- サイト内のすべてのページをリスト表示したい場合
- ページIDをもとに特定の情報を取得したい場合
- ナビゲーションメニューを構築する際に全ページを参照する場合
- カスタムクエリを実行する際に必要なページIDを取得する場合
- ページのメタ情報を一括で更新したい場合
- 特定の条件でのページ表示を制御する場合
- ページのスラッグをリスト化する場合
- 任意の位置でページリンクを生成したい場合
構文
get_all_page_ids();
パラメータ
この関数にはパラメータはありません。
戻り値
この関数は、全ページの投稿IDの配列を返します。
関連する関数
使用可能なバージョン
get_all_page_ids関数は、WordPress 4.5以降で使用可能です。
コアファイルのパス
get_all_page_ids関数は、WordPressのコアファイル wp-includes/post.php に含まれています。
サンプルコード
サンプルコード 1
$page_ids = get_all_page_ids();
foreach ($page_ids as $page_id) {
// 各ページIDを表示
echo 'ページID: ' . $page_id . '<br>';
}
このサンプルコードは、全ページの投稿IDを取得し、ループを使ってそれぞれのページIDを表示します。
サンプルコード 2
$page_ids = get_all_page_ids();
$pages = get_posts(array(
'post__in' => $page_ids,
'orderby' => 'post__in'
));
このサンプルコードでは、get_all_page_ids関数を使用して全ページの投稿IDを取得し、そのIDをもとにページ情報を取得します。
サンプルコード 3
$page_ids = get_all_page_ids();
if (!empty($page_ids)) {
// ページが存在する場合にのみ処理を実行
foreach ($page_ids as $id) {
$page = get_post($id);
// ページのタイトルを表示
echo 'ページタイトル: ' . $page->post_title . '<br>';
}
}
このサンプルコードは、全ページの投稿IDを取得し、それぞれのページタイトルを表示します。
サンプルコード 4
function list_all_page_titles() {
$page_ids = get_all_page_ids();
foreach ($page_ids as $id) {
$title = get_the_title($id);
echo '<li>' . $title . '</li>';
}
}
このサンプルコードでは、全ページの投稿IDを取得して、ページタイトルをHTMLのリスト形式で表示します。
サンプルコード 5
$page_ids = get_all_page_ids();
$summary = array_map('get_the_excerpt', $page_ids);
print_r($summary);
このサンプルコードは、全ページの投稿IDを取得し、それぞれのページの抜粋を配列に保存して表示します。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| 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 |
非推奨または削除されたバージョン
現在のところ、get_all_page_ids関数が非推奨または削除されたバージョンはありません。