comment_form

（3.0.0以降）
comment_form - コメント投稿フォームを表示する

説明

void comment_form( [ array $args = array() [ , mixed $post_id = null ] ] )
コメント投稿フォームを表示する。

パラメータ

  • $args
    オプションパラメータを連想配列で指定（省略時はarray()）。連想配列の内容は次の通り。
    キー名意味
    'fields'コメント投稿者情報の入力フィールド（HTML）を連想配列（通常はキーが'author'、'email'、'url'）。
    'comment_field'コメント内容の入力フィールド（HTML）。
    'must_log_in'ログイン済みユーザーのみコメントが許諾されている場合の未ログイン時に表示されるメッセージ。
    'logged_in_as'ログイン済みユーザーの場合に投稿者情報フィールドの代わりに表示されるメッセージ。
    'comment_notes_before'コメント内容の入力フィールドの直前に表示されるメッセージ。
    'comment_notes_after'コメント内容の入力フィールドの直後に表示されるメッセージ。
    'id_form'formタグのid要素の値（省略時は'commentform'）。
    'title_reply'コメントタイトル1（省略時は'Leave a Reply'の翻訳テキスト）。
    'title_reply_to'コメントタイトル2（省略時は'Leave a Reply to %s'の翻訳テキスト）。
    'cancel_reply_link'コメントキャンセル時のテキスト（省略時は'Cancel reply'の翻訳テキスト）。
    'id_submit'送信ボタンのid要素の値（省略時は'submit'）。
    'name_submit'送信ボタンのname要素の値（省略時は'submit'）。
    'label_submit'送信ボタンのラベル（省略時は'Post Comment'の翻訳テキスト）。
    'format'HTMLフォーマットとして'html5'または'xhtml'（省略時はテーマに依存）。
  • $post_id
    コメント対象の投稿IDまたは投稿情報（WP_postオブジェクト）を指定（省略時はnull）。

返り値

返り値はありません。

注意

ディスカッション設定の「名前とメールアドレスの入力を必須にする（オプション名'require_name_email）」のチェック状態など、各種設定内容が反映される。

使用例

  • 現在の投稿情報のコメント投稿フォームを表示する。
    <?php comment_form(); ?>
  • 現在の投稿情報のコメント投稿フォームを表示する。
    <?php comment_form( array() ); ?>
  • 投稿ID$post_idを指定してコメント投稿フォームを表示する。
    <?php comment_form( array(), $post_id ); ?>

フィルター

[3.0.0]formatオプションの確認後、'comment_form_default_fields'フィルターを呼び出す。パラメータ$fieldsにはデフォルトのコメント投稿者情報入力フィールドの連想配列となる。
$fields = apply_filters( 'comment_form_default_fields', $fields );
[3.0.0]'comment_form_default_fields'フィルターの後、'comment_form_defaults'フィルターを呼び出す。パラメータ$defaultsにはデフォルトのオプション設定の連想配列となる。
$args = wp_parse_args( $args, apply_filters( 'comment_form_defaults', $defaults ) );
[3.0.0]ログイン済みメッセージを表示する前に'comment_form_logged_in'フィルターを呼び出す。パラメータ$logged_in_asにはログイン済みユーザーの場合に投稿者情報フィールドの代わりに表示されるメッセージ、$commenterにはコメント投稿者情報、$user_identityにはログイン済みユーザー名となる。
echo apply_filters( 'comment_form_logged_in', $logged_in_as, $commenter, $user_identity );
[3.0.0]各コメント投稿者情報入力フィールドを表示する直前に"comment_form_field_{$name}"フィルターを呼び出す（$nameは'author'、'email'、'url'など）。パラメータ$fieldは各入力フィールドのHTMLとなる。
echo apply_filters( "comment_form_field_{$name}", $field ) . "\n";
[3.0.0]コメント内容入力フィールドを表示する直前、'comment_form_field_comment'フィルターを呼び出す。パラメータ$comment_fieldはコメント内容入力フィールドとなる。
echo apply_filters( 'comment_form_field_comment', $comment_field );

アクション

[3.0.0]タイトルを含むコメントフォームを表示する前に'comment_form_before'アクションを呼び出す。
do_action( 'comment_form_before' );
[3.0.0]ログイン済みメッセージの表示後に'comment_form_must_log_in_after'アクションを呼び出す。
do_action( 'comment_form_must_log_in_after' );
[3.0.0]form開始タグの表示直後に'comment_form_top'アクションを呼び出す。
do_action( 'comment_form_top' );
[3.0.0]ログイン済みメッセージの表示直後に'comment_form_logged_in_after'アクションを呼び出す。
do_action( 'comment_form_logged_in_after', $commenter, $user_identity );
[3.0.0]コメント投稿者情報入力フィールドを表示する直前に'comment_form_before_fields'アクションを呼び出す。
do_action( 'comment_form_before_fields' );
[3.0.0]コメント投稿者情報入力フィールドの表示直後に'comment_form_after_fields'アクションを呼び出す。
do_action( 'comment_form_after_fields' );
[3.0.0]form終了タグを表示する直前に'comment_form'アクションを呼び出す。パラメータ$post_idは投稿IDとなる。
do_action( 'comment_form', $post_id );
[3.0.0]コメントフォームの表示後に'comment_form_after'アクションを呼び出す。
do_action( 'comment_form_after' );
[3.0.0]コメント投稿が許可されていない場合に'comment_form_comments_closed'アクションを呼び出す。
do_action( 'comment_form_comments_closed' );

ソースファイル

/wp-includes/comment-template.php

最終更新 : 2014年10月05日 18:12

関連

参考

Code Reference: comment_form

お勧め

Emojin：プラグイン作ってみました（2015年3月21日 更新）

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。