wp_delete_attachment_files

説明

bool wp_delete_attachment_files( int $post_id, array $meta, array $backup_sizes, string $file )
添付ファイルとその関連ファイルを削除する。

パラメータ

  • $post_id
    メディアの投稿IDを指定。
  • $meta
    メディアのメタ情報の連想配列を指定。
  • $backup_sizes
    メディアのバックアップサイズを格納した配列を指定。
  • $file
    添付ファイルのパス名を指定。

返り値

添付ファイルとその関連ファイルが削除できた場合はtrue、いずれかが削除できなかった場合はfalseを返す。


注意

本関数は従来のwp_delete_attachment関数から切り出されたもので、wp_delete_attachment関数から呼び出される。削除対象となるメディアの添付ファイルは、画像ファイルの場合にサムネイルやいくつかのサイズが作成されることがあり、それら関連ファイルも同時に削除している。

パラメータ$metaの内容は、 wp_get_attachment_metadata関数で取得できる。

パラメータ$backup_sizesの内容は、 get_post_meta関数でキーに'_wp_attachment_backup_sizes'を指定して取得できる。

パラメータ$fileの内容は、 get_attached_file関数で取得できる。


使用例

  • 添付ファイルとその関連ファイルを削除する。
    <?php wp_delete_attachment_files( $post_id, $meta, $backup_sizes, $file ); ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/post.php

最終更新 : 2018年07月06日 15:27



お勧め

get_postsとquery_postsを使い分け(2018年5月27日 更新)

get_posts query_postsは、どちらも複数の投稿情報を取得することができる便利な関数である。パラメータとして指定できる内容も共通しているものが多く、query_postsがより詳細なパラメータを指定でき、高機能になっている。

カスタムフィールドで並び替え(2013年8月9日 更新)

WordPressでは複数の投稿記事を取得する際、並び順の指定を省略すると投稿日時の降順になる。並び順は、投稿日時だけでなく、更新日時、投稿名、記事タイトル、コメント数のほか、カスタムフィールドも指定できる。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

Login rebuilder 2.4.1の新機能紹介(2018年12月10日 更新)

少し前にLogin rebuilderをアップデートし、oEmbedに関連する情報を制限できる機能を追加。この機能は、oEmbed関連情報によってユーザーIDが類推されることを防ぐことが目的としている。

「テキスト」モードと「ビジュアル」モードを行き来すると投稿内容の一部が消える(2018年5月27日 更新)

仕事がらサイトの引っ越し作業のお手伝いをすることがあるのですが、今回は引っ越しにあわせてWordPressを「3.7.1」から最新版「4.1.1」にアップデートすることになりました。ここで紹介するのはこの案件で発生したトラブルの話です。