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



お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

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

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

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。(2024年11月13日 更新)

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア(Clear Unknown Formatting)」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。