ワードプレスのget_post関数の使用方法・解説

概要

get_post 関数は、特定の投稿情報を取得するために使用される WordPress の関数です。この関数は、特定の ID に基づいて投稿の詳細を取得し、投稿のデータを配列として返します。以下に、この関数がよく使われる場面を示します。

1. 投稿情報を設計する際
2. 特定の投稿の詳細を表示する時
3. カスタム投稿タイプやページの情報を取得する時
4. ウィジェットやカスタムテンプレート内での投稿データの表示
5. 投稿のメタデータにアクセスする際
6. 投稿リストを作成する際
7. ショートコードを実装する際のデータ取得
8. REST API 経由で投稿データを取得する時

構文

get_post( $post_id, $output, $filter );

パラメータ

• $post_id (int | string) — 取得したい投稿のID。
• $output (string) — 返される出力の形式。’OBJECT’（デフォルト）、’ARRAY_A’、’ARRAY_N’。
• $filter (string) — 投稿のフィルタリングオプション。’raw’、’edit’ など。

戻り値

指定した投稿の情報を含むオブジェクトまたは配列を返します。投稿が存在しない場合は null を返します。

関連する関数

• get_posts
• get_post_meta
• wp_insert_post
• wp_update_post

使用可能なバージョン

get_post 関数は WordPress のすべてのバージョンで使用可能です。

コアファイルのパス

get_post 関数は、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 = get_post(42);
echo $post->post_title;

このコードは、IDが42の投稿を取得し、そのタイトルを表示します。

サンプル 2

$post_data = get_post(5, ARRAY_A);
print_r($post_data);

このコードは、IDが5の投稿を連想配列形式で取得し、その内容を表示します。

サンプル 3

$post = get_post('my-custom-post');
if ($post) {
    echo $post->post_content;
}

このコードは、スラッグ（’my-custom-post’）を使用して投稿を取得し、存在する場合はその内容を表示します。

サンプル 4

$post_id = 10;
if ($post = get_post($post_id, 'OBJECT', 'raw')) {
    echo '投稿日: ' . $post->post_date;
}

このコードは、指定したIDの投稿の投稿日を表示します。

サンプル 5

$draft_posts = get_posts(array('post_status' => 'draft'));
foreach ($draft_posts as $draft) {
    echo $draft->post_title . '<br>';
}

このコードは、全ての下書き投稿を取得し、そのタイトルを表示します。

引用元：
– https://developer.wordpress.org/reference/functions/get_post/