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

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

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

提供: WordPress Codex 日本語版
< 関数リファレンス
2010年5月2日 (日) 20:53時点におけるKz (トーク | 投稿記録)による版 (全体を和訳。)

移動先: 案内検索

記事、添付ファイル、固定ページなどの投稿を削除します。記事やページの場合は、それに関連づけられている情報(コメント、カスタムフィールド、タームなど)もすべて削除されます。

使い方

<?php wp_delete_post( $postid, $force_delete = false ) ?>

パラメータ

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

戻り値

(mixed) 
削除した投稿のオブジェクト。失敗した場合は false を返します。
  • false - 該当する投稿が無かった場合。
  • 'ARRAY_N' - インデックス配列
  • 'ARRAY_A' - 連想配列

フック

  • アクション:do_action( 'delete_post', $postid ) 完全に削除する前。
  • アクション: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 ) カスタムフィールドを完全に削除した後。
  • アクション:do_action( 'deleted_post', $postid ) 完全に削除した後。

用例

投稿の削除

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

<?php wp_delete_post(1); ?>

  • $force_deletefalse の場合は、wp_trash_post() が実行されます。フックは実行されません。
  • 添付ファイル(投稿タイプが 'attachment')の場合は、wp_delete_attachment() が実行されます。フックは実行されません。
  • グローバル変数を使用: (object) $wpdb
  • グローバル変数を使用: (object) $wp_rewrite

変更履歴

ソースファイル

wp_delete_post()wp-includes/post.php に含まれています。

wp_update_post(), wp_delete_attachment(), wp_get_attachment_url(), wp_insert_attachment(), wp_insert_post()

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

最新英語版: WordPress Codex » 14:20, 1 January 2010 Aesqe最新版との差分