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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function_Reference/wp_delete_post 14:20, 1 January 2010 Aesqe)
 
(全体を和訳。)
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 ==
+
<div id="Usage">
%%%<?php wp_delete_post( $postid, $force_delete = false ) ?>%%%
+
== 使い方 ==
 +
</div>
 +
 +
<?php wp_delete_post( $postid, $force_delete = false ) ?>
  
== Parameters ==
+
<div id="Parameters">
{{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 ==
+
{{Parameter|$postid|整数|投稿 ID。|オプション|0}}
; (mixed) : False on failure.
+
{{Parameter|$force_delete|真偽値|ゴミ箱への移動ではなく、完全に削除するかどうか。[[Version 2.9|バージョン 2.9]] で追加。|オプション|false}}
  
== Examples ==
+
<div id="Return_Values">
=== Delete Post ===
+
== 戻り値 ==
Deleting WP default post "Hello World" which ID is '1'.
+
</div>
 +
 
 +
; (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>
 +
=== 投稿の削除 ===
 +
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. -->
== 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>
 +
 
 +
* <tt>$force_delete</tt> が <tt>false</tt> の場合は、[[関数リファレンス/wp_trash_post|<tt>wp_trash_post()</tt>]] が実行されます。フックは実行されません。
 +
* 添付ファイル(投稿タイプが '<tt>attachment</tt>')の場合は、[[関数リファレンス/wp_delete_attachment|<tt>wp_delete_attachment()</tt>]] が実行されます。フックは実行されません。
 +
* グローバル変数を使用: (<tt>object</tt>) [[関数リファレンス/wpdb_Class|<tt>$wpdb</tt>]]
 +
* グローバル変数を使用: (<tt>object</tt>) <tt>$wp_rewrite</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}} に含まれています。
  
== Source File ==
+
<div id="Related">
<!-- Need links to current source code files -->
+
== 関連資料 ==
<tt>wp_delete_post()</tt> is located in <tt>wp-includes/post.php</tt>.
+
</div>
  
== Related ==
+
[[関数リファレンス/wp update post|wp_update_post()]], [[関数リファレンス/wp delete attachment|wp_delete_attachment()]],
<!--
+
[[関数リファレンス/wp get attachment url|wp_get_attachment_url()]],
    To Do:
+
[[関数リファレンス/wp insert attachment|wp_insert_attachment()]], [[関数リファレンス/wp insert post|wp_insert_post()]]
    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 -->
 
{{原文|14:20, 1 January 2010 Aesqe|81567}}<!-- 14:20, 1 January 2010 Aesqe -->
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[en:Function_Reference/wp_delete_post]]
 
[[en:Function_Reference/wp_delete_post]]
 
[[tr:wp_delete_post]]
 
[[tr:wp_delete_post]]

2010年5月2日 (日) 20:50時点における版

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

使い方

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