概要
get_page関数は、特定のページ情報を取得するために使用されるWordPressの関数です。この関数は、投稿タイプが「ページ」であるWordPressの投稿情報を取得する際によく使われます。具体的には、次のような機能を実装する際によく利用されます。
- 特定のページの内容を表示する
- モーダルウィンドウやポップアップでページを表示する
- ページのカスタムフィールド情報を取得する
- テンプレート内で用いるためのページ情報を取得する
- ウィジェットやショートコードで特定のページを表示する
- リダイレクト時に遷移先のページ情報を取得する
- サイトマップ生成のためにページリストを取得する
- 特定のページのメタデータを取得する
構文
get_page( int|WP_Post $page, string $output = OBJECT, string $filter = 'raw' );
パラメータ
- $page (int|WP_Post): 対象のページIDまたはWP_Postオブジェクト。
- $output (string): 出力形式（’OBJECT’, ‘ARRAY_A’, ‘ARRAY_N’）。デフォルトは’OBJECT’。
- $filter (string): 取得した内容のフィルタリング（’raw’, ‘edit’, ‘db’）。デフォルトは’raw’。
戻り値
- 指定されたページの情報を含むWP_Postオブジェクト（または指定された形式の配列）を返します。
関連する関数
使用可能なバージョン
get_page関数はWordPress 1.5.0以降で利用可能です。
コアファイルのパス
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 | 〇 |
非推奨または削除されたバージョン
- 現在、
get_page関数は特定のバージョンで非推奨または削除された情報はありません。
サンプルコード
サンプルコード 1: ページ情報の取得
$page_id = 42;
$page = get_page($page_id);
echo $page->post_title;
このコードは、IDが42のページのタイトルを取得して表示します。
サンプルコード 2: ページ内容の表示
$page = get_page(42);
echo apply_filters('the_content', $page->post_content);
このコードは、IDが42のページの内容をフィルタリングして表示します。
サンプルコード 3: ページを配列形式で取得
$page = get_page(42, ARRAY_A);
print_r($page);
このコードは、IDが42のページの情報を配列形式で取得して表示します。
サンプルコード 4: ページメタデータを取得
$page = get_page(42);
$meta = get_post_meta($page->ID, 'custom_meta_key', true);
echo $meta;
このコードは、IDが42のページに関連するカスタムメタデータを取得して表示します。
サンプルコード 5: 特定のページのカスタムフィールドを表示
$page = get_page('about-us');
$custom_field = get_post_meta($page->ID, 'custom_field_key', true);
echo $custom_field;
このコードは、「about-us」というスラッグのページからカスタムフィールドの値を取得して表示します。