wp_delete_attachment

パラメータ

• $postid
  メディアIDを指定（省略時は0）。
• $force_delete
  完全に削除する場合はtrue、ゴミ箱に入れる場合はfalseを指定（省略時はfalse）。

返り値

削除操作できた場合はそのメディア情報を返す。メディア情報が見つからなかった場合はnull、削除操作できなかった場合はfalseを返す。

注意

メディア情報の削除は、1つはゴミ箱に入れるパターンと、完全に削除するの2パターンである。ゴミ箱に入れる場合は添付ファイルは削除されない。

一般の投稿情報と異なりメディア情報には添付ファイルがあるため、 wp_delete_post関数とは別にこの関数が用意されている。

使用例

• メディアIDが12のメディア情報を削除（ゴミ箱）する。
  <?php wp_delete_attachment( 12 ); ?>
• メディアIDが12のメディア情報を完全に削除する。
  <?php wp_delete_attachment( 12, true ); ?>

フィルター

$check = apply_filters( 'pre_delete_attachment', null, $post, $force_delete );

アクション

do_action( 'delete_attachment', $post_id, $post );

do_action( 'delete_post', $postid, $post );

do_action( 'deleted_post', $postid, $post );

ソースファイル