概要
get_post_field関数は、WordPressにおいて特定の投稿の情報の要素を取得するための関数です。この関数は、投稿オブジェクトから特定のフィールドの値を取得する際に頻繁に使用されます。以下に、この関数がよく使われる機能の例を示します。
- 投稿のタイトルを取得する
- 投稿のコンテンツを取得する
- カスタムフィールド（メタデータ）の値を取得する
- 投稿エクス抜出しのスラッグを取得する
- 投稿の日付を取得する
- 投稿の著者IDを取得する
- 投稿のステータス（公開、下書きなど）を取得する
- 投稿の分類（カテゴリー、タグ）を取得する
構文
get_post_field( $field, $post = 0, $output = 'raw', $filter = 'raw' );
パラメータ
$field(string) – 取得したいフィールドの識別子。例: ‘post_title’, ‘post_content’, ‘post_excerpt’など。$post(int|WP_Post) – 投稿のIDまたはWP_Postオブジェクト。指定しない場合は現在の投稿が選択されます。$output(string) – 出力形式。デフォルトは’raw’。’edit’を指定するとエディタ用の保存可能な形式で取得できます。$filter(string) – フィルターを適用するかどうか。デフォルトは’raw’。
戻り値
取得したフィールドの値（文字列）を返します。指定されたフィールドが存在しない場合はnullを返します。
関連する関数
使用可能なバージョン
この関数は、WordPress 2.9.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 |
サンプルコード
サンプル1: 投稿タイトルを取得する
このコードは、指定した投稿のタイトルを取得し、表示しています。
$post_id = 1; // 投稿IDを指定
$title = get_post_field('post_title', $post_id);
echo $title;
サンプル2: 投稿のコンテンツを取得する
このコードは、指定した投稿のコンテンツを取得しています。
$post_id = 2; // 投稿IDを指定
$content = get_post_field('post_content', $post_id);
echo $content;
サンプル3: カスタムフィールドの値を取得する
このコードは、特定のカスタムフィールドの値を取得するサンプルです。
$post_id = 3; // 投稿IDを指定
$custom_field_value = get_post_field('my_custom_field', $post_id);
echo $custom_field_value;
サンプル4: 投稿の日付を取得する
このサンプルコードは、投稿の公開日を取得して表示します。
$post_id = 4; // 投稿IDを指定
$date = get_post_field('post_date', $post_id);
echo $date;
サンプル5: 投稿のカテゴリーを取得する
このコードは、投稿に関連付けられたカテゴリーを取得し、表示しています。
$post_id = 5; // 投稿IDを指定
$category = get_post_field('post_category', $post_id);
echo implode(', ', $category);
各サンプルコードは著作権フリーのものです。また、サンプルコードに関連する詳細な情報やコードリファレンスは、WordPressの公式ドキュメントで確認できます。