delete_metadata

(2.9.0以降)
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年12月19日 登録)

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

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 登録)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

決まった値を返すだけの関数群(2015年7月15日 登録)

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

Blacklist keys manager:プラグイン作ってみました(2013年9月13日 登録)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

HTML編集モードに定型文ボタンを追加する(2011年6月1日 登録)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

最終更新日時 : 2016-02-23 15:48