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

使用例

  • 投稿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

関連

お勧めコンテンツ

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 登録)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

管理画面の'アイキャッチ画像'を'写真'に変える(2013年1月23日 登録)

クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。

プラグインのロード順を制御する(2014年6月9日 登録)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

カスタムフィールド関連関数のおさらい(2012年6月22日 登録)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

日本語が含まれていないコメントを無効化する(2012年1月31日 登録)

日本のユーザーを対象にサービス(情報)展開しているサイトの場合、英文のみのコメントはあまりうれしくない。ましてやスパムコメントの対応は時間の無駄でしかない。そんなわけで、日本語を含んでいないコメントを無効化することにした。

最終更新日時 : 2014-10-08 17:21