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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function_Reference/wp_delete_post 14:20, 1 January 2010 Aesqe)
 
(戻り値)
 
(2人の利用者による、間の3版が非表示)
1行目: 1行目:
== Description ==
+
<div id="Description">
Removes a post, attachment, or page.
+
== 説明 ==
 +
</div>
  
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.
+
投稿、添付ファイル、固定ページを削除するか、ゴミ箱へ移動します。
  
== Usage ==
+
投稿と固定ページの場合は、それに関連づけられている情報(コメント、カスタムフィールド、タクソノミー・タームとの関連付け等)もすべて削除されます。
%%%<?php wp_delete_post( $postid, $force_delete = false ) ?>%%%
+
  
== Parameters ==
+
<div id="Usage">
{{Parameter|$postid|integer|Post ID.|optional|0}}
+
== 使い方 ==
{{Parameter|$force_delete|bool|Whether to bypass trash and force deletion (added in WordPress 2.9).|optional|false}}
+
</div>
  
== Return Values ==
+
<?php wp_delete_post( $postid, $force_delete ); ?>
; (mixed) : False on failure.
+
  
== Examples ==
+
<div id="Parameters">
=== Delete Post ===
+
== パラメータ ==
Deleting WP default post "Hello World" which ID is '1'.
+
</div>
  
  <?php wp_delete_post(1); ?>
+
{{Parameter|$postid|整数|投稿 ID|オプション|0}}
 +
{{Parameter|$force_delete|真偽値|ゴミ箱への移動ではなく、完全に削除するかどうか。[[Version 2.9|バージョン 2.9]] で追加。|オプション|false}}
 +
 
 +
<div id="Return_Values">
 +
== 戻り値 ==
 +
</div>
 +
 
 +
; (mixed) : 削除またはゴミ箱へ移動した投稿のオブジェクト。失敗した場合は <tt>false</tt> を返します。ゴミ箱へ移動された場合、投稿オブジェクトのステータスは新しい状態を、削除された場合は直前の状態を表します。
 +
 
 +
<div id="Examples">
 +
== 用例 ==
 +
</div>
 +
 
 +
<div id="Delete_Post">
 +
=== 投稿の削除 ===
 +
</div>
 +
 
 +
WordPress のデフォルト投稿 "Hello World"(投稿 ID が '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. -->
== Notes ==
 
* Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] on '<tt>delete_post</tt>' before deletion unless post type is '<tt>attachment</tt>'.
 
* Uses: [[Function_Reference/do_action|<tt>do_action()</tt>]] on '<tt>deleted_post</tt>' after deletion unless post type is '<tt>attachment</tt>'.
 
* Uses: [[Function_Reference/wp_delete_attachment|<tt>wp_delete_attachment()</tt>]] if post type is '<tt>attachment</tt>'.
 
* Uses global: (<tt>object</tt>) [[Function_Reference/wpdb_Class|<tt>$wpdb</tt>]]
 
* Uses global: (<tt>object</tt>) <tt>$wp_rewrite</tt>
 
  
== Change Log ==
+
<div id="Notes">
Since: 1.0.0
+
== 参考 ==
 +
</div>
 +
 
 +
* 以下の条件がすべて満たされた場合、[[関数リファレンス/wp_trash_post|<tt>wp_trash_post()</tt>]] が実行されます。wp_delete_post() のフックは実行されません。
 +
** <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>) [[関数リファレンス/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>
 +
 
 +
* [[Version 2.9|バージョン 2.9]] : <tt>$force_delete</tt> パラメータ追加
 +
* [[Version 1.0|バージョン 1.0]] : 新規導入
 +
 
 +
<div id="Source_File">
 +
== ソースファイル ==
 +
</div>
 +
 
 +
<tt>wp_delete_post()</tt> は {{Trac|wp-includes/post.php}} にあります。
 +
 
 +
<div id="Related">
 +
== 関連資料 ==
 +
</div>
 +
 
 +
[[関数リファレンス/wp_trash_post|wp_trash_post()]],
 +
[[関数リファレンス/wp update post|wp_update_post()]],
 +
[[関数リファレンス/wp delete attachment|wp_delete_attachment()]],
 +
[[関数リファレンス/wp insert attachment|wp_insert_attachment()]],
 +
[[関数リファレンス/wp insert post|wp_insert_post()]]
 +
 
 +
{{Tag Footer}}
 +
 
 +
{{原文|Function Reference/wp_delete_post|142080}} <!-- 16:39, 23 March 2014‎ Sam a 版 -->
  
== Source File ==
+
{{DEFAULTSORT:Wp_delete_post}}
<!-- Need links to current source code files -->
+
[[Category:関数]]
<tt>wp_delete_post()</tt> is located in <tt>wp-includes/post.php</tt>.
+
  
== Related ==
 
<!--
 
    To Do:
 
    Need to find related functions.
 
    Need to create groups of functions and create templates to add them to a page quickly.
 
    Some functions may be related to many groups of functions.
 
-->
 
[[Function Reference/wp update post|wp_update_post()]], [[Function Reference/wp delete attachment|wp_delete_attachment()]],
 
[[Function Reference/wp get attachment url|wp_get_attachment_url()]],
 
[[Function Reference/wp insert attachment|wp_insert_attachment()]], [[Function Reference/wp insert post|wp_insert_post()]]
 
{{原文|14:20, 1 January 2010 Aesqe|81567}}<!-- 14:20, 1 January 2010 Aesqe -->
 
[[Category:Functions]]
 
 
[[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最新版との差分