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

お勧め

ショートコードを使ってテーマ内の画像URLを簡単に指定する（2018年5月27日 更新）

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

リクエスト応答を終了する前に何かを処理する（2013年9月26日 更新）

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

投稿情報を連想配列で参照する（2018年5月27日 更新）

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

段落ブロックに日付・時刻の入力支援を実装した（2023年1月25日 更新）

ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。

ブロックエディターのタグ入力にタグクラウド機能を追加した（2019年1月10日 更新）

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。