wp_update_attachment_metadata

（2.1.0以降）
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

関連

参考

Code Reference: wp_update_attachment_metadata

お勧め

サイドバーの初期化はwidgets_initアクションで（2011年7月14日 更新）

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

任意の名前でエラーログファイルを指定する（2019年2月15日 更新）

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

カレンダーウィジェットをAjaxで切り替える（2011年8月22日 更新）

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

Post-tag automaton：プラグイン作ってみました（2012年12月24日 更新）

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

管理画面でよく使うスタイルをまとめてみた「メッセージ編」（2019年7月30日 更新）

標準で用意されているスタイルを知っておくことで、独自に用意するスタイルを軽減でき、機能拡張した部分の見た目は違和感が少なくなる。そんな共通要素のスタイルのひとつが「メッセージ」だ。メッセージにはいくつかの意味合いがあり、用途に応じてすぐに使い分けすることになる。今回はそんなメッセージ向けのスタイルをざっくりまとめてみた。