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



お勧め

PHPとMySQLのバージョンを確認(2013年9月11日 更新)

先日、WordPressで構築されたサイトについて最新版へのバージョンアップを依頼される。使用されていたWordPressはバージョン2.xということで、最新版へバージョンアップできるのか、PHPとMySQLのバージョンを確認することになった。

投稿一覧に独自リンクを追加する(2013年10月16日 更新)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

さくらのVPSでKUSANAGI(2018年5月27日 更新)

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

Emojin:プラグイン作ってみました(2015年3月21日 更新)

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

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

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