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パターンである。

使用例

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

フィルター

実行するフィルターはありません。

アクション

投稿情報を削除する直前(関連情報は削除済み)、delete_postアクションを実行する。
do_action( 'delete_post', $postid );
投稿情報を削除した直後、deleted_postアクションを実行する。
do_action( 'deleted_post', $postid );
本関数を終了する直前、after_delete_postアクションを実行する。
do_action( 'after_delete_post', $postid );

ソースファイル

/wp-includes/post.php

最終更新 : 2018年08月29日 17:16



お勧め

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。