• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/wp delete post

提供: WordPress Codex 日本語版
移動先: 案内検索

投稿、添付ファイル、固定ページを削除するか、ゴミ箱へ移動します。

投稿と固定ページの場合は、それに関連づけられている情報(コメント、カスタムフィールド、タクソノミー・タームとの関連付け等)もすべて削除されます。

使い方

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

パラメータ

$postid
整数) (オプション) 投稿 ID
初期値: 0
$force_delete
真偽値) (オプション) ゴミ箱への移動ではなく、完全に削除するかどうか。バージョン 2.9 で追加。
初期値: false

戻り値

(mixed) 
削除またはゴミ箱へ移動した投稿のオブジェクト。失敗した場合は false を返します。ゴミ箱へ移動された場合、投稿オブジェクトのステータスは新しい状態を、削除された場合は直前の状態を表します。

用例

投稿の削除

WordPress のデフォルト投稿 "Hello World"(投稿 ID が '1')を削除する例です。

<?php wp_delete_post( 1 ); ?>

参考

  • 以下の条件がすべて満たされた場合、wp_trash_post() が実行されます。wp_delete_post() のフックは実行されません。
    • $force_deletefalse
    • $postid の投稿の post_typepage またはor post
    • $postid の投稿がまだゴミ箱にない
    • ゴミ箱機能が有効(デフォルトで有効になっています)
  • 添付ファイル(投稿タイプが 'attachment')の場合は、wp_delete_attachment() が実行されます。wp_delete_post() のフックは実行されません。
  • 投稿タイプが 'attachment' でなければ、削除する前に 'before_delete_post' と 'delete_post' アクションフックを呼び出します。さらに削除後は 'deleted_post' と 'after_delete_post' アクションフックを呼び出します。
  • グローバル変数を使用: (object) $wpdb
  • グローバル変数を使用: (object) $wp_rewrite

他に下記のフックが呼び出される場合があります。

  • アクション:do_action( 'delete_comment', $comment_ids ) コメントを完全に削除する前。
  • アクション:do_action( 'deleted_comment', $comment_ids ) コメントを完全に削除した後。
  • アクション:do_action( 'delete_postmeta', $post_meta_ids ) カスタムフィールドを完全に削除する前。
  • アクション:do_action( 'deleted_postmeta', $post_meta_ids ) カスタムフィールドを完全に削除した後。

変更履歴

ソースファイル

wp_delete_post()wp-includes/post.php にあります。

wp_trash_post(), wp_update_post(), wp_delete_attachment(), wp_insert_attachment(), wp_insert_post()


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/wp_delete_post最新版との差分