wp_delete_post

Posted on by Eternal-tears
Sponsored Link

投稿、添付ファイル、またはページを削除します。

投稿とページを削除する時、関係されている全てのものも削除されています。これは、投稿に関連するコメント、投稿メタフィールド、そしてタームも含みます。

Sponsored Link

Removes a post, attachment, or page.

When the post and page goes, everything that is tied to it is deleted also. This includes comments, post meta fields, and terms associated with the post.

wp_delete_postのファンクションタグ使用方法

<?php wp_delete_post( $postid, $force_delete ); ?>

wp_delete_postのパラメーター

$postid

(integer) (optional) 投稿ID。
デフォルト: 0

(integer) (optional) Post ID.
Default: 0

$force_delete

(bool) (optional) ゴミ箱と強制削除を無視するかどうか（WordPress 2.9に追加されました）。
デフォルト：false

(bool) (optional) Whether to bypass trash and force deletion (added in WordPress 2.9).
Default: false

戻り値

(mixed)
失敗する場合はFalse、成功する場合はwpdbオブジェクトをランダムします。

(mixed)
False on failure and a random wpdb object on success.

例

投稿を削除する方法

IDが’1’であるWPのデフォルト投稿”Hello World”を削除します。

Deleting WP default post “Hello World” which ID is ‘1’.

<?php wp_delete_post(1); ?>

注釈

  • $force_deleteがfalseの場合wp_delete_post() は自動的にwp_trash_post()を取り消します。$postidのpost_typeは、ページまたは投稿です。$postidは既にない場合は、ゴミ箱機能が有効になっているからです（それがデフォルトです）
  • 用途：投稿タイプが’添付ファイル’でない限り、削除の前に’delete_post’上にdo_action() 。
  • 用途：投稿タイプが’添付ファイル’でない限り、削除の後に’delete_post’上にdo_action() 。
  • 用途：投稿タイプが添付ファイルノ場合、wp_delete_attachment()です。
  • グローバル$wpdbを使用：(object) wpdb
  • グローバル$wpdbを使用： (object) WP_Rewrite
  • wp_delete_post() automatically reverts to wp_trash_post() if $force_delete is false, the post_type of $postid is page or post, $postid is not already in the trash and if that trash feature enabled (which it it is by default).
  • Uses: do_action() on ‘delete_post’ before deletion unless post type is ‘attachment’.
  • Uses: do_action() on ‘deleted_post’ after deletion unless post type is attachment.
  • Uses: wp_delete_attachment() if post type is attachment.
  • Uses global $wpdb: (object) wpdb
  • Uses global $wp_rewrite: (object) WP_Rewrite

変更ログ

Since: 1.0.0

ソースファイル

wp_delete_post()は、wp-includes/post.php内に位置しています。

wp_delete_post() is located in wp-includes/post.php.

Sponsored Link