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

お勧め

wp_titleからwp_get_document_titleへ（2018年5月27日 更新）

先週、WordPress 4.4 beta1（以降4.4 beta1）が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

ツイート引用が簡単になる仕組み（2012年6月8日 更新）

WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。

5.5の機能強化：テーマ変更時に要求バージョンを確認（2020年8月12日 更新）

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2（以降RC 2）」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

サイトヘルス機能を使ってみた（2019年4月12日 更新）

先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2（以降5.2Beta2）が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。

ブロックエディターで編集したページが出力した余分な改行を削除（2019年2月22日 更新）

ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。