説明
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 ); ?>
フィルター
[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'アクションを呼び出す。パラメータ$postidには本関数が受け取った内容が格納されている。[5.5.0]パラメータ$postが追加され、削除対象の投稿オブジェクトが格納されている。do_action( 'before_delete_post', $postid, $post );do_action( 'delete_post', $postid, $post );do_action( 'deleted_post', $postid, $post );do_action( 'after_delete_post', $postid, $post );ソースファイル
/wp-includes/post.php最終更新 : 2020年08月21日 15:05
関連
お勧め
ブロックエディターの色設定を変えてみる（2019年12月11日 更新）
バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。
「姓」の後に「名」を（2013年11月6日 更新）
WordPressのユーザー情報設定ページでは、「名（First name）」の後に「姓（Last name）」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。
ホームディレクトリから過去のファイルを削除する（2013年1月27日 更新）
WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。Login rebuilder 2.6.5の新機能紹介（2021年3月8日 更新）
今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。
投稿情報を連想配列で参照する（2018年5月27日 更新）
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。