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



お勧め

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

固定ページを投稿ページ用テンプレートファイル(single.php)で表示する(2013年7月31日 更新)

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

もうquery_postsは呼ばない(2011年9月27日 更新)

トップページやカテゴリーページで標準の条件に少し手を加えた投稿情報を表示するケースがある。そんな時、テンプレートファイルの先頭で query_posts関数を呼び出して投稿情報を再抽出していたのだが、フィルター処理をうまく使えばquery_posts関数を呼び出さなくても大丈夫みたいだ。

使っていないか確認しないとね!(2017年11月18日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.9.0現在、廃止予定となっている関数をまとめて紹介する。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。