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



お勧め

各種リンクを取得する関数一覧(2014年6月12日 更新)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

Login rebuilderのログ表示機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

管理画面でツールバー(Admin bar)を非表示にする(2013年3月5日 更新)

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。

一定時間でログアウトする(2013年5月23日 更新)

ログイン関係を調べている関係で、 wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。