wp_delete_post

（1.0.0以降）
wp_delete_post - 投稿情報を削除する

説明

mixed wp_delete_post( [ int $postid = 0 [ , bool $force_delete = false ] ] )
投稿情報とそのコメント、カスタムフィールドなどの関連情報をまとめて削除する。

パラメータ

  • $postid
    投稿情報IDを指定（省略時は0）。
  • $force_delete
    完全に削除する場合はtrue、ゴミ箱に入れる場合はfalseを指定（省略時はfalse）。

返り値

削除操作できた場合はその投稿情報を返す。投稿情報が見つからなかった場合はnull、削除操作できなかった場合はfalseを返す。

注意

投稿情報の削除は、1つはゴミ箱に入れると（ゴミ箱に入れれる投稿情報は、投稿タイプが'post'または'page'のみ）、完全に削除するの2パターンである。

[6.6.0]"delete_post_{$post->post_type}"（delete_post_postやdelete_post_pageなど）および"deleted_post_{$post->post_type}"（deleted_post_postやdeleted_post_pageなど）アクションが追加された。

使用例

  • 投稿IDが10の投稿情報を削除（ゴミ箱）する。
    <?php wp_delete_post( 10 ); ?>
  • 投稿IDが10の投稿情報を完全に削除する。
    <?php wp_delete_post( 10, true ); ?>

フィルター

[4.4.0]削除の前に'pre_delete_post'フィルターを呼び出す。パラメータ$deleteにはnullが、$postには削除対象の投稿オブジェクトが、$force_deleteには本関数が受け取った内容が格納されている。このフィルターの返り値がnull以外の場合は削除されない。 
$check = apply_filters( 'pre_delete_post', $delete, $post, $force_delete );

アクション

[3.2.0]削除の前（'pre_delete_post'フィルターの後）に'before_delete_post'アクションを呼び出す。パラメータ$post_idには本関数が受け取った内容が格納されている。[5.5.0]パラメータ$postが追加され、削除対象の投稿オブジェクトが格納されている。 
do_action( 'before_delete_post', $post_id, $post );
[6.6.0]投稿情報を削除する直前（関連情報は削除済み）、"delete_post_{$post->post_type}"アクションを呼び出す。パラメータ$post_idには本関数が受け取った内容が、$postが追加され、削除対象の投稿オブジェクトが格納されている。 
do_action( "delete_post_{$post->post_type}", $post_id, $post );
[1.2.0]投稿情報を削除する直前（関連情報は削除済み）、'delete_post'アクションを呼び出す。パラメータ$post_idには本関数が受け取った内容が格納されている。[5.5.0]パラメータ$postが追加され、削除対象の投稿オブジェクトが格納されている。 
do_action( 'delete_post', $post_id, $post );
[6.6.0]投稿情報を削除した直後、"deleted_post_{$post->post_type}"アクションを呼び出す。パラメータ$post_idには本関数が受け取った内容が、$postが追加され、削除対象の投稿オブジェクトが格納されている。 
do_action( "deleted_post_{$post->post_type}", $post_id, $post );
[2.2.0]投稿情報を削除した後、'deleted_post'アクションを呼び出す。パラメータ$post_idには本関数が受け取った内容が格納されている。[5.5.0]パラメータ$postが追加され、削除対象の投稿オブジェクトが格納されている。 
do_action( 'deleted_post', $post_id, $post );
[3.2.0]本関数を終了する直前、after_delete_postアクションを実行する。パラメータ$post_idには本関数が受け取った内容が格納されている。[5.5.0]パラメータ$postが追加され、削除対象の投稿オブジェクトが格納されている。 
do_action( 'after_delete_post', $post_id, $post );

ソースファイル

/wp-includes/post.php

最終更新 : 2024年07月22日 12:26

関連

参考

Code Reference: wp_delete_post

お勧め

個人データのエクスポートメール向けに追加された新フィルター（2020年4月2日 更新）

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群（2018年5月27日 更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで（2011年7月14日 更新）

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる！？（2020年2月25日 更新）

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。