update_comment_meta

説明

bool update_comment_meta( int $comment_id, string $meta_key, mixed $meta_value [ , mixed $prev_value = '' ] )
コメントメタ情報の値を更新する。

パラメータ

  • $comment_id
    コメントIDを指定。
  • $meta_key
    コメントメタ情報のキー名を指定。
  • $meta_value
    コメントメタ情報のキー名に対応する値を指定。
  • $prev_value
    コメントメタ情報のキー名に対応する前の値を指定(省略時は'')。

返り値

コメントメタ情報の値を更新した場合はtrueを、失敗した場合はfalseを返す。

注意

使い方は投稿情報のメタ情報を更新する update_post_meta関数と同じ。キー名で指定したコメントメタ情報が存在しない場合は追加され、すでに存在する場合はそのコメントメタ情報の値が更新される。必ずコメントメタ情報を追加する場合は、 add_comment_meta関数を使用すること。

なお、同じキー名のコメントメタ情報は、パラメータ$prev_valueを指定することで、更新対象のコメントメタ情報を絞り込める。


使用例

  • コメントIDが2014で、キー名が'judge'の値として10を設定する。
    <?php update_comment_meta( 2014, 'judge', 10 ); ?>
  • コメントIDが2014で、キー名が'judge'、直前の値が9のコメントメタ情報の値を10に変更する。
    <?php update_comment_meta( 2014, 'judge', 10, 9 ); ?>

フィルター

直接実行するフィルターはありません。

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/comment.php

最終更新 : 2014年03月09日 12:54



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

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

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。