説明
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
関連
お勧め
Contact Form 7に確認フェーズを(2012年12月16日 更新)
Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。投稿一覧に独自リンクを追加する(2013年10月16日 更新)
管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)
投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。投稿日の検索が自由自在に(2015年3月7日 更新)
WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろん query_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。
プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)
バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。