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年02月23日 15:48

関連

参考

Code Reference: delete_metadata

お勧め

フィードにサムネイル画像を追加する（2022年11月1日 更新）

WordPressが出力するの標準のフィードには、各投稿のサムネイル画像の情報が含まれていない。ネットで検索してみるといくつかの方法があることがわかったので、その中から2つ試してみた。

投稿一覧に「投稿フォーマット」フィルターが追加される（2019年4月12日 更新）

WordPress 5.2 Beta2（以降5.2Beta2）のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」（select要素）が追加されていた。

5.5の機能強化：コメントフォームのちょっとした改良（2020年8月12日 更新）

来月にリリースされるWordPress 5.5に向けてBeta 1、2、3と公開が続いている。「WordPress 5.5 Beta 3（以降Beta 3）」のソースコードを見ていくと、コメントフォームを表示する comment_form関数が機能拡張されていた。

Login rebuilderに「XML-RPC設定」を追加しました（2018年5月27日 更新）

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

index.htmlでアーカイブページを表示させる（2011年10月14日 更新）

静的なサイトでは、各ディレクトリにindex.htmlファイルを置き、そのディレクトリの内容を紹介することが多い。WordPressで構築したサイトも同様にできないかと考え、試行錯誤してみた（こんなことを考えてるのは自分だけだろうか！？）。