概要
delete_post_thumbnail関数は、指定した投稿からサムネイル画像を削除するために使用される関数です。この関数は、ユーザーが投稿のメディアを管理する際に特によく使われます。具体的には、以下のような状況で使用されることが多いです。
- 投稿のサムネイル画像を削除する
- ユーザーが誤ってアップロードした画像を削除する
- 新しいサムネイル画像に差し替える際に既存のものを削除する
- 投稿が非公開になった際にサムネイルも削除する
- ギャラリーやブロックエディターでの画像管理において
- カスタム投稿タイプの管理時にサムネイルを適切に削除する
- プラグイン開発時にメディアの整理を行う
- テーマのカスタマイゼーションで不要なサムネイルを削除する
構文
delete_post_thumbnail( $post_id );
パラメータ
- $post_id (int) (必須): サムネイルを削除したい投稿のID。
戻り値
- (bool): 成功した場合は
trueを返し、失敗した場合はfalseを返します。
関連する関数
使用可能なバージョン
delete_post_thumbnail関数は、WordPress 3.1以降で使用可能です。
コアファイルのパス
wp-includes/post-thumbnail-template.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 |
この関数はアクションのどこでも特に使用されている例は確認できませんでした。
サンプルコード
以下に、delete_post_thumbnail関数のサンプルコードを5点示します。
サンプル1: 投稿からサムネイルを削除する基本的な例
$post_id = 123; // 投稿IDを指定
delete_post_thumbnail( $post_id );
このコードは、指定した投稿IDからサムネイル画像を削除します。
サンプル2: 投稿が存在するか確認してからサムネイルを削除
$post_id = 123; // 投稿IDを指定
if ( get_post( $post_id ) ) {
delete_post_thumbnail( $post_id );
}
このコードは、指定した投稿が存在する場合のみサムネイルを削除します。
サンプル3: 特定の条件に基づいてサムネイルを削除する
$post_id = 123; // 投稿IDを指定
$post = get_post( $post_id );
if ( $post->post_status == 'draft' ) { // 投稿が下書き状態の場合
delete_post_thumbnail( $post_id );
}
このコードは、投稿が下書き状態であるときにのみサムネイルを削除します。
サンプル4: 投稿タイプが特定のものであればサムネイルを削除
$post_id = 123; // 投稿IDを指定
$post = get_post( $post_id );
if ( 'my_custom_post_type' === get_post_type( $post ) ) {
delete_post_thumbnail( $post_id );
}
このコードは、特定のカスタム投稿タイプの場合にのみサムネイルを削除します。
サンプル5: 複数の投稿からサムネイルを削除する例
$post_ids = array( 123, 456, 789 ); // 投稿IDの配列
foreach ( $post_ids as $id ) {
delete_post_thumbnail( $id );
}
このコードは、配列に格納された複数の投稿IDからサムネイルを削除します。