wp_update_attachment_metadata

説明

mixed wp_update_attachment_metadata( int $attachment_id, array $data )
メディア(添付ファイル)のメタ情報を更新する。

パラメータ

  • $attachment_id
    メディアの投稿IDを指定。
  • $data
    メタ情報の連想配列を指定。

返り値

メタ情報を更新した場合はtrueを、パラメータ$attachment_idが無効か更新できなかった場合はfalseを返す。

注意

本関数で更新(保存)したメタ情報はキー'_wp_attachment_metadata'で保存される。このメタ情報を取得する場合は wp_get_attachment_metadata関数を使用する。

パラメータ$dataがnull(論理比較で偽)の場合は、メタ情報の更新ではなく、メタ情報の削除となる。


使用例

  • メディアのメタ情報を更新する。
    <?php wp_update_attachment_metadata( $attachment_id, $data ); ?>
  • メディアのメタ情報を削除する。
    <?php wp_update_attachment_metadata( $attachment_id, null ); ?>

フィルター

[2.1.0]メタ情報を更新する前に'wp_update_attachment_metadata'フィルターを呼び出す。パラメータ$dataにはメタ情報を、$post_idにはパラメータ$attachment_idから取得しなおした投稿情報の投稿IDが格納される。
$data = apply_filters( 'wp_update_attachment_metadata', $data, $post_id );

アクション

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

ソースファイル

/wp-includes/post.php

最終更新 : 2018年05月27日 10:42



お勧め

パスとURL(2011年10月6日 更新)

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

5.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

LevelとCapability(2018年5月27日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。