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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/wp_delete_attachment 17:13, 11 December 2013‎ TheMikeD 版を流し込み。)
 
(「フック」セクションを「参考」セクションに改名。メディアのゴミ箱機能に関する説明を追記。)
 
(同じ利用者による、間の1版が非表示)
1行目: 1行目:
==Description==
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
This function deletes an attachment and all of its derivatives.
+
添付ファイルを削除するか、ゴミ箱へ移動します。関連づけられている情報(コメント、カスタムフィールド、タクソノミー・タームとの関連付け等)があれば、それらも削除されます。
  
==Usage==
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
  
 
  <?php wp_delete_attachment( $attachmentid, $force_delete ); ?>
 
  <?php wp_delete_attachment( $attachmentid, $force_delete ); ?>
  
==Parameters==
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
  
{{Parameter|$attachmentid|integer|The ID of the attachment you would like to delete.}}
+
{{Parameter|$attachmentid|整数|削除したい添付ファイルの ID}}
{{Parameter|$force_delete|bool|Whether to bypass trash and force deletion (added in WordPress 2.9).|optional|false}}
+
{{Parameter|$force_delete|真偽値|ゴミ箱への移動ではなく、完全に削除するかどうか。[[Version 2.9|バージョン 2.9]] で追加。|オプション|false}}
  
==Return Values==
+
<div id="Return_Values">
 +
== 戻り値 ==
 +
</div>
  
Returns <tt>false</tt> on failure, post data on success. This should be checked using the identity operator ( === ) instead of the normal equality operator because of the possibility of a returned 0 or empty array:
+
削除またはゴミ箱へ移動した添付ファイルのオブジェクト(投稿データ)。失敗した場合は <tt>false</tt> を返します。成功して も 0 や空の配列を返す可能性を考慮して、普通の同値演算子の代わりに型も比較する同値演算子を使ってください。
  <?php if ( false === wp_delete_attachment( $attachmentid ) ) do something; ?>
+
  <?php if ( false === wp_delete_attachment( $attachmentid ) ) エラー処理; ?>
  
==Hooks==
+
<div id="Examples">
 +
== 用例 ==
 +
</div>
  
This function fires the [[Plugin_API/Action_Reference/delete_attachment|delete_attachment]] action hook, passing the attachment's ID (<tt>$postid</tt>).
+
ID が '76' の添付ファイルを削除する例です。
  
==Example==
 
 
To delete an attachment with an ID of '76':
 
 
  <?php wp_delete_attachment( 76 ); ?>
 
  <?php wp_delete_attachment( 76 ); ?>
 +
<!-- Need creative examples. Feel free to link to external examples. -->
  
== Source File ==
+
<div id="Notes">
<tt> wp_delete_attachment()</tt> is located in {{Trac|wp-includes/post.php}}.
+
== 参考 ==
 +
</div>
  
==Related==
+
この関数は、削除を始める前に、添付ファイルの ID(<tt>$attachmentid</tt>)を引数として [[プラグイン_API/アクションフック一覧/delete_attachment|<tt>delete_attachment</tt>]] アクションフックを呼び出します。
  
[[Function Reference/wp get attachment url|wp_get_attachment_url()]]
+
この他、下記のアクションフックも呼び出されます。
 +
* <tt>delete_post</tt> : 添付ファイルの情報(投稿データ)を実際に削除する直前。
 +
* <tt>deleted_post</tt> : 添付ファイルの情報を実際に削除した直後。
 +
* <tt>wp_delete_file</tt> : 添付ファイルのファイルそのものを実際に削除する直前。
 +
 
 +
以下の条件がすべて満たされた場合、<tt>$attachmentid</tt> を引数として [[関数リファレンス/wp_trash_post|<tt>wp_trash_post()</tt>]] が実行されます。wp_delete_attachment() のフックは実行されません。
 +
* <tt>$force_delete</tt> が ''false''
 +
* 投稿の[[wp-config.php の編集#Empty_Trash|ゴミ箱機能]]が有効(デフォルトで有効になっています)
 +
* メディアのゴミ箱機能が有効(デフォルトは無効。<tt>wp-config.php</tt> に <code>define('MEDIA_TRASH', true);</code> を記述すると有効にできます)
 +
* <tt>$attachmentid</tt> の添付ファイルがまだゴミ箱にない
 +
 
 +
<div id="Change_Log">
 +
== 変更履歴 ==
 +
</div>
 +
 
 +
* [[Version 2.0|バージョン 2.0]] : 新規導入
 +
 
 +
<div id="Source_File">
 +
== ソースファイル ==
 +
</div>
 +
 
 +
<tt>wp_delete_attachment()</tt> は {{Trac|wp-includes/post.php}} にあります。
 +
 
 +
<div id="Related">
 +
== 関連資料 ==
 +
</div>
 +
 
 +
[[関数リファレンス/wp get attachment url|wp_get_attachment_url()]]
  
 
{{Tag Footer}}
 
{{Tag Footer}}
  
[[Category:Functions]]
+
{{原文|Function Reference/wp_delete_attachment|139240}} <!-- 17:13, 11 December 2013‎ TheMikeD 版 -->
 +
 
 +
{{DEFAULTSORT:Wp_delete_attachment}}
 +
[[Category:関数]]
 +
 
 +
[[en:Function_Reference/wp_delete_attachment]]

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

添付ファイルを削除するか、ゴミ箱へ移動します。関連づけられている情報(コメント、カスタムフィールド、タクソノミー・タームとの関連付け等)があれば、それらも削除されます。

使い方

<?php wp_delete_attachment( $attachmentid, $force_delete ); ?>

パラメータ

$attachmentid
整数) (必須) 削除したい添付ファイルの ID
初期値: なし
$force_delete
真偽値) (オプション) ゴミ箱への移動ではなく、完全に削除するかどうか。バージョン 2.9 で追加。
初期値: false

戻り値

削除またはゴミ箱へ移動した添付ファイルのオブジェクト(投稿データ)。失敗した場合は false を返します。成功して も 0 や空の配列を返す可能性を考慮して、普通の同値演算子の代わりに型も比較する同値演算子を使ってください。

<?php if ( false === wp_delete_attachment( $attachmentid ) ) エラー処理; ?>

用例

ID が '76' の添付ファイルを削除する例です。

<?php wp_delete_attachment( 76 ); ?>

参考

この関数は、削除を始める前に、添付ファイルの ID($attachmentid)を引数として delete_attachment アクションフックを呼び出します。

この他、下記のアクションフックも呼び出されます。

  • delete_post : 添付ファイルの情報(投稿データ)を実際に削除する直前。
  • deleted_post : 添付ファイルの情報を実際に削除した直後。
  • wp_delete_file : 添付ファイルのファイルそのものを実際に削除する直前。

以下の条件がすべて満たされた場合、$attachmentid を引数として wp_trash_post() が実行されます。wp_delete_attachment() のフックは実行されません。

  • $force_deletefalse
  • 投稿のゴミ箱機能が有効(デフォルトで有効になっています)
  • メディアのゴミ箱機能が有効(デフォルトは無効。wp-config.phpdefine('MEDIA_TRASH', true); を記述すると有効にできます)
  • $attachmentid の添付ファイルがまだゴミ箱にない

変更履歴

ソースファイル

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

wp_get_attachment_url()


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


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