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



お勧め

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

oEmbedについて考えてみた(2018年5月27日 更新)

本サイト向けにテーマをリニューアルしようと思い一から作っている最中、ふと生成されているHTMLの中にあるoEmbedの記述が目についた。「この記述いつからだっけ」くらいに思いながらリンク先を開き、ちょっとモヤモヤしてしまった。

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

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