概要
set_post_thumbnail 関数は、WordPress における投稿やページにサムネイル画像を設定するために使用されます。この関数は、特に以下のような機能を実装する際によく使われます。
- 記事のビジュアルを強化。
- サムネイルを利用した関連記事表示。
- 自動的に投稿一覧に画像を表示。
- カスタムテーマやプラグインでの画像管理。
- メディアライブラリから画像を選択する機能。
- 特定の条件に基づいて画像をプログラム的に設定。
- 投稿タイプに応じた異なるサムネイルデザイン。
- SEO対策としての画像利用。
構文
set_post_thumbnail( $post_id, $thumbnail_id, $meta_array );
パラメータ
$post_id(int): サムネイルを設定したい投稿の ID。$thumbnail_id(int): 設定するサムネイル画像の ID。$meta_array(array): サムネイルに関するメタ情報（オプション）。
戻り値
- 成功した場合はサムネイルの ID、失敗した場合は
falseが返されます。
使用可能なバージョン
set_post_thumbnail関数は 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 = 42; // 投稿のID
$thumbnail_id = 123; // 添付メディアのID
set_post_thumbnail( $post_id, $thumbnail_id );
このサンプルコードは、特定の投稿（ここではID 42）にサムネイル画像（ID 123）を設定します。
サンプル2: 新しい投稿にサムネイルを追加する
function my_custom_post_thumbnail() {
$post_id = wp_insert_post( array(
'post_title' => '新しい投稿',
'post_content'=> 'コンテンツ',
'post_status' => 'publish',
'post_type' => 'post',
));
$thumbnail_id = 456; // 新しいサムネイルのID
set_post_thumbnail( $post_id, $thumbnail_id );
}
add_action( 'init', 'my_custom_post_thumbnail' );
このコードは、init アクションのタイミングで新しい投稿を作成し、その投稿にサムネイルを設定します。
サンプル3: 投稿のサムネイルを削除する
$post_id = 42; // 投稿のID
delete_post_thumbnail( $post_id );
このコードは、特定の投稿からサムネイル画像を削除します。
サンプル4: サムネイル画像が設定されている場合に表示する
if ( has_post_thumbnail( $post->ID ) ) {
the_post_thumbnail();
}
この例では、投稿にサムネイル画像が設定されている場合にその画像を表示します。
サンプル5: 投稿ごとに異なるサムネイルサイズを指定して表示する
if ( has_post_thumbnail( $post->ID ) ) {
the_post_thumbnail( 'medium' ); // 'medium'サイズを表示
}
このコードは、投稿のサムネイルを「medium」サイズで表示するサンプルです。