• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/add comment meta

提供: WordPress Codex 日本語版
移動先: 案内検索

説明

コメントにメタデータフィールド(カスタムフィールド)を追加します。

使い方

<?php add_comment_meta( $comment_id, $meta_key, $meta_value, $unique ); ?>

パラメータ

$comment_id
整数) (required) コメント ID
初期値: なし
$meta_key
文字列) (required) メタデータの名前。追加されるメタデータフィールドのキーになる。
初期値: なし
$meta_value
mixed) (required) メタデータの値
初期値: なし
$unique
真偽値) (optional) キーをユニークにするかどうか。true を設定すると、指定したコメントに同じメタデータフィールドが存在する場合には追加されません。
初期値: false

戻り値

(真偽値) 
失敗すれば false、成功すれば true

用例

すべての新規コメントにカスタム POST 値を追加する

<?php
function add_custom_comment_field( $comment_id ) {

   add_comment_meta( $comment_id, 'my_custom_comment_field', $_POST['my_custom_comment_field'] );
}
add_action( 'comment_post', 'add_custom_comment_field' );
?>

変更履歴

2.9 以降

ソースファイル

add_comment_meta()wp-includes/comment.php で定義されています。

関連

コメントメタ関数: add_comment_meta(), get_comment_meta()/en, update_comment_meta()/en, delete_comment_meta()/en


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function_Reference/add_comment_meta最新版との差分