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

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

「関数リファレンス/wp delete post」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(全体を和訳。)
(戻り値)
 
(2人の利用者による、間の2版が非表示)
3行目: 3行目:
 
</div>
 
</div>
  
記事、添付ファイル、固定ページなどの投稿を削除します。記事やページの場合は、それに関連づけられている情報(コメント、カスタムフィールド、タームなど)もすべて削除されます。
+
投稿、添付ファイル、固定ページを削除するか、ゴミ箱へ移動します。
 +
 
 +
投稿と固定ページの場合は、それに関連づけられている情報(コメント、カスタムフィールド、タクソノミー・タームとの関連付け等)もすべて削除されます。
  
 
<div id="Usage">
 
<div id="Usage">
 
== 使い方 ==
 
== 使い方 ==
 
</div>
 
</div>
+
 
  <?php wp_delete_post( $postid, $force_delete = false ) ?>
+
  <?php wp_delete_post( $postid, $force_delete ); ?>
  
 
<div id="Parameters">
 
<div id="Parameters">
15行目: 17行目:
 
</div>
 
</div>
  
{{Parameter|$postid|整数|投稿 ID。|オプション|0}}
+
{{Parameter|$postid|整数|投稿 ID|オプション|0}}
 
{{Parameter|$force_delete|真偽値|ゴミ箱への移動ではなく、完全に削除するかどうか。[[Version 2.9|バージョン 2.9]] で追加。|オプション|false}}
 
{{Parameter|$force_delete|真偽値|ゴミ箱への移動ではなく、完全に削除するかどうか。[[Version 2.9|バージョン 2.9]] で追加。|オプション|false}}
  
22行目: 24行目:
 
</div>
 
</div>
  
; (mixed) : 削除した投稿のオブジェクト。失敗した場合は <tt>false</tt> を返します。
+
; (mixed) : 削除またはゴミ箱へ移動した投稿のオブジェクト。失敗した場合は <tt>false</tt> を返します。ゴミ箱へ移動された場合、投稿オブジェクトのステータスは新しい状態を、削除された場合は直前の状態を表します。
:* <code>false</code> - 該当する投稿が無かった場合。
+
:* <code>'ARRAY_N'</code> - インデックス配列
+
:* <code>'ARRAY_A'</code> - 連想配列
+
 
+
<div id="Hooks">
+
== フック ==
+
</div>
+
 
+
* アクション:<tt>do_action( 'delete_post', $postid )</tt> 完全に削除する前。
+
* アクション:<tt>do_action( 'delete_comment', $comment_ids )</tt> コメントを完全に削除する前。
+
* アクション:<tt>do_action( 'deleted_comment', $comment_ids )</tt> コメントを完全に削除した後。
+
* アクション:<tt>do_action( 'delete_postmeta', $post_meta_ids )</tt> カスタムフィールドを完全に削除する前。
+
* アクション:<tt>do_action( 'deleted_postmeta', $post_meta_ids )</tt> カスタムフィールドを完全に削除した後。
+
* アクション:<tt>do_action( 'deleted_post', $postid )</tt> 完全に削除した後。
+
  
 
<div id="Examples">
 
<div id="Examples">
 
== 用例 ==
 
== 用例 ==
 
</div>
 
</div>
 +
 +
<div id="Delete_Post">
 
=== 投稿の削除 ===
 
=== 投稿の削除 ===
WordPress のデフォルト投稿 "Hello World"(投稿 ID が '1')を削除する:
+
</div>
 +
 
 +
WordPress のデフォルト投稿 "Hello World"(投稿 ID が '1')を削除する例です。
  
  <?php wp_delete_post(1); ?>
+
  <?php wp_delete_post( 1 ); ?>
 
<!-- Need creative examples. Feel free to link to external examples. -->
 
<!-- Need creative examples. Feel free to link to external examples. -->
  
 
<div id="Notes">
 
<div id="Notes">
== ==
+
== 参考 ==
 
</div>
 
</div>
  
* <tt>$force_delete</tt> が <tt>false</tt> の場合は、[[関数リファレンス/wp_trash_post|<tt>wp_trash_post()</tt>]] が実行されます。フックは実行されません。
+
* 以下の条件がすべて満たされた場合、[[関数リファレンス/wp_trash_post|<tt>wp_trash_post()</tt>]] が実行されます。wp_delete_post() のフックは実行されません。
* 添付ファイル(投稿タイプが '<tt>attachment</tt>')の場合は、[[関数リファレンス/wp_delete_attachment|<tt>wp_delete_attachment()</tt>]] が実行されます。フックは実行されません。
+
** <tt>$force_delete</tt> が ''false''
 +
** <tt>$postid</tt> の投稿の <tt>post_type</tt> が ''page'' またはor ''post''
 +
** <tt>$postid</tt> の投稿がまだゴミ箱にない
 +
** [[wp-config.php の編集#Empty_Trash|ゴミ箱機能]]が有効(デフォルトで有効になっています)
 +
* 添付ファイル(投稿タイプが '<tt>attachment</tt>')の場合は、[[関数リファレンス/wp_delete_attachment|<tt>wp_delete_attachment()</tt>]] が実行されます。wp_delete_post() のフックは実行されません。
 +
* 投稿タイプが '<tt>attachment</tt>' でなければ、削除する前に '<tt>before_delete_post</tt>' と '<tt>delete_post</tt>' アクションフックを呼び出します。さらに削除後は '<tt>deleted_post</tt>' と '<tt>after_delete_post</tt>' アクションフックを呼び出します。
 
* グローバル変数を使用: (<tt>object</tt>) [[関数リファレンス/wpdb_Class|<tt>$wpdb</tt>]]
 
* グローバル変数を使用: (<tt>object</tt>) [[関数リファレンス/wpdb_Class|<tt>$wpdb</tt>]]
* グローバル変数を使用: (<tt>object</tt>) <tt>$wp_rewrite</tt>
+
* グローバル変数を使用: (<tt>object</tt>) [[関数リファレンス/WP Rewrite|<tt>$wp_rewrite</tt>]]
 +
 
 +
他に下記のフックが呼び出される場合があります。
 +
 
 +
* アクション:<tt>do_action( 'delete_comment', $comment_ids )</tt> コメントを完全に削除する前。
 +
* アクション:<tt>do_action( 'deleted_comment', $comment_ids )</tt> コメントを完全に削除した後。
 +
* アクション:<tt>do_action( 'delete_postmeta', $post_meta_ids )</tt> カスタムフィールドを完全に削除する前。
 +
* アクション:<tt>do_action( 'deleted_postmeta', $post_meta_ids )</tt> カスタムフィールドを完全に削除した後。
  
 
<div id="Change_Log">
 
<div id="Change_Log">
67行目: 71行目:
 
</div>
 
</div>
  
<tt>wp_delete_post()</tt> は {{Trac|wp-includes/post.php}} に含まれています。
+
<tt>wp_delete_post()</tt> は {{Trac|wp-includes/post.php}} にあります。
  
 
<div id="Related">
 
<div id="Related">
73行目: 77行目:
 
</div>
 
</div>
  
[[関数リファレンス/wp update post|wp_update_post()]], [[関数リファレンス/wp delete attachment|wp_delete_attachment()]],
+
[[関数リファレンス/wp_trash_post|wp_trash_post()]],
[[関数リファレンス/wp get attachment url|wp_get_attachment_url()]],
+
[[関数リファレンス/wp update post|wp_update_post()]],
[[関数リファレンス/wp insert attachment|wp_insert_attachment()]], [[関数リファレンス/wp insert post|wp_insert_post()]]
+
[[関数リファレンス/wp delete attachment|wp_delete_attachment()]],
{{原文|14:20, 1 January 2010 Aesqe|81567}}<!-- 14:20, 1 January 2010 Aesqe -->
+
[[関数リファレンス/wp insert attachment|wp_insert_attachment()]],
[[Category:Functions]]
+
[[関数リファレンス/wp insert post|wp_insert_post()]]
 +
 
 +
{{Tag Footer}}
 +
 
 +
{{原文|Function Reference/wp_delete_post|142080}} <!-- 16:39, 23 March 2014‎ Sam a 版 -->
 +
 
 +
{{DEFAULTSORT:Wp_delete_post}}
 +
[[Category:関数]]
 +
 
 
[[en:Function_Reference/wp_delete_post]]
 
[[en:Function_Reference/wp_delete_post]]
 +
[[ru:Справочник по функциям/wp_delete_post]]
 
[[tr:wp_delete_post]]
 
[[tr:wp_delete_post]]

2015年4月14日 (火) 18:38時点における最新版

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

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

使い方

<?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最新版との差分