説明
bool delete_metadata( string $meta_type, int $object_id, string $meta_key [ , mixed $meta_value = '' [ , bool $delete_all = false ] ] )
メタ情報の値を削除する。
パラメータ
- $meta_typeメタ情報タイプ('comment'、'post'、'user')を指定。
- $object_idメタ情報タイプで指定した情報のID(コメントID、投稿ID、ユーザID)を指定。
- $meta_keyメタ情報のキー名を指定。
- $meta_valueメタ情報のキー名に対応する値を指定(省略時は'')。
- $delete_allすべてのメタ情報のキー名の値を削除する場合はtrueを指定(省略時はfalse)。
返り値
メタ情報の値を削除した場合はtrueを、失敗した場合はfalseを返す。注意
delete_post_meta関数や delete_comment_meta関数の下位関数で、個別のメタ情報だけでなく、同じキー名のメタ情報を一括して削除することができる(パラメータ$delete_allがtrueの場合は、$object_idは無視される)。
使用例
- キー名が'judge'のコメントメタ情報を削除する。<?php delete_metadata( 'comment', 0, 'judge', '', true ); ?>
フィルター
メタ情報を削除する前に"delete_{$meta_type}_metadata"(例: delete_comment_metadata)フィルターを呼び出す。各パラメータは本関数が受け取ったパラメータの値で、falseを返すことで削除は行われない。$check = apply_filters( "delete_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $delete_all );アクション
削除対象のメタ情報を検索した後で"delete_{$meta_type}_meta"(例: delete_comment_meta)アクションを呼び出す。パラメータ$meta_idsには削除対象のメタ情報IDを格納した配列が、その他のパラメータは本関数が受け取ったパラメータとなる。do_action( "delete_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );do_action( 'delete_postmeta', $meta_ids );do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );do_action( 'deleted_postmeta', $meta_ids );ソースファイル
/wp-includes/meta.php最終更新 : 2016年02月23日 15:48
関連
お勧め
ブロックエディターをちょっとだけカスタマイズしてみる(2021年11月3日 更新)
ブロックエディターで投稿を編集していると「ここは〇〇だったらいいのにな」と思うところがある。今回は、そんな気になるところをいくつか(自分好みに)調整してみた。
初期化に関連するアクションのおさらい(2013年11月27日 更新)
いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。プラグインのロード順を制御する(2014年6月9日 更新)
これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。
3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目(2011年7月6日 更新)
新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)
バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。