説明
パラメータ
- $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 );
do_action( "delete_post_{$post->post_type}", $post_id, $post );
do_action( 'delete_post', $post_id, $post );
do_action( "deleted_post_{$post->post_type}", $post_id, $post );
do_action( 'deleted_post', $post_id, $post );
do_action( 'after_delete_post', $post_id, $post );
ソースファイル
/wp-includes/post.php最終更新 : 2024年07月22日 12:26
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo:プラグイン作ってみました(2019年9月19日 更新)
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。