delete_metadata

説明

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 );
パラメータ$meta_typeが'post'の場合のみ、削除対象のメタ情報を検索した後で"delete_postmeta"アクションを呼び出す(旧スタイル)。パラメータ$meta_idsには削除対象のメタ情報IDを格納した配列となる。
do_action( 'delete_postmeta', $meta_ids );
メタ情報を削除した後で"deleted_{$meta_type}_meta"(例: deleted_comment_meta)アクションを呼び出す。パラメータ$meta_idsには削除したメタ情報IDを格納した配列が、その他のパラメータは本関数が受け取ったパラメータとなる。
do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );
パラメータ$meta_typeが'post'の場合のみ、削除対象のメタ情報を検索した後で"delete_postmeta"アクションを呼び出す(旧スタイル)。パラメータ$meta_idsには削除したメタ情報IDを格納した配列となる。
do_action( 'deleted_postmeta', $meta_ids );

ソースファイル

/wp-includes/meta.php

最終更新 : 2016年02月23日 15:48



お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

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

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

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。