comment_form ( $args = array(), $post = null )
参数
  • (array)
    $args
    { Optional. Default arguments and form fields to override. @type array $fields { Default comment fields, filterable by default via the {@see ‘comment_form_default_fields’} hook. @type string $author Comment author field HTML. @type string $email Comment author email field HTML. @type string $url Comment author URL field HTML. @type string $cookies Comment cookie opt-in field HTML. } @type string $comment_field The comment textarea field HTML. @type string $must_log_in HTML element for a ‘must be logged in to comment’ message. @type string $logged_in_as The HTML for the ‘logged in as [user]’ message, the Edit profile link, and the Log out link. @type string $comment_notes_before HTML element for a message displayed before the comment fields if the user is not logged in. Default ‘Your email address will not be published.’. @type string $comment_notes_after HTML element for a message displayed after the textarea field. @type string $action The comment form element action attribute. Default ‘/wp-comments-post.php’. @type string $id_form The comment form element id attribute. Default ‘commentform’. @type string $id_submit The comment submit element id attribute. Default ‘submit’. @type string $class_container The comment form container class attribute. Default ‘comment-respond’. @type string $class_form The comment form element class attribute. Default ‘comment-form’. @type string $class_submit The comment submit element class attribute. Default ‘submit’. @type string $name_submit The comment submit element name attribute. Default ‘submit’. @type string $title_reply The translatable ‘reply’ button label. Default ‘Leave a Reply’. @type string $title_reply_to The translatable ‘reply-to’ button label. Default ‘Leave a Reply to %s’, where %s is the author of the comment being replied to. @type string $title_reply_before HTML displayed before the comment form title. Default: ‘

    ‘. @type string $title_reply_after HTML displayed after the comment form title. Default: ‘

    ‘. @type string $cancel_reply_before HTML displayed before the cancel reply link. @type string $cancel_reply_after HTML displayed after the cancel reply link. @type string $cancel_reply_link The translatable ‘cancel reply’ button label. Default ‘Cancel reply’. @type string $label_submit The translatable ‘submit’ button label. Default ‘Post a comment’. @type string $submit_button HTML format for the Submit button. Default: ‘‘. @type string $submit_field HTML format for the markup surrounding the Submit button and comment hidden fields. Default: ‘

    %1$s %2$s

    ‘, where %1$s is the submit button markup and %2$s is the comment hidden fields. @type string $format The comment form format. Default ‘xhtml’. Accepts ‘xhtml’, ‘html5’. }

    Required:
    Default: array()
  • (int|WP_Post)
    $post
    Post ID or WP_Post object to generate the form for. Default current post.
    Required:
    Default: null
定义位置
  • wp-includes/comment-template.php
    , line 2324
引入
3.0.0
弃用

输出一个完整的评论表单,在模板中使用。

大多数字符串和表单字段可以通过传递到函数中的`$args`数组来控制,同时你也可以选择使用{@see ‘comment_form_default_fields’}过滤器来修改默认字段数组,如果你只想添加一个新字段或删除一个字段。所有字段也会单独通过{@see ‘comment_form_field_$name’}过滤器,其中`$name’是字段数组中使用的键。

function comment_form( $args = array(), $post = null ) {
	$post = get_post( $post );

	// Exit the function if the post is invalid or comments are closed.
	if ( ! $post || ! comments_open( $post ) ) {
		/**
		 * Fires after the comment form if comments are closed.
		 *
		 * For backward compatibility, this action also fires if comment_form()
		 * is called with an invalid post object or ID.
		 *
		 * @since 3.0.0
		 */
		do_action( 'comment_form_comments_closed' );

		return;
	}

	$post_id       = $post->ID;
	$commenter     = wp_get_current_commenter();
	$user          = wp_get_current_user();
	$user_identity = $user->exists() ? $user->display_name : '';

	$args = wp_parse_args( $args );
	if ( ! isset( $args['format'] ) ) {
		$args['format'] = current_theme_supports( 'html5', 'comment-form' ) ? 'html5' : 'xhtml';
	}

	$req   = get_option( 'require_name_email' );
	$html5 = 'html5' === $args['format'];

	// Define attributes in HTML5 or XHTML syntax.
	$required_attribute = ( $html5 ? ' required' : ' required="required"' );
	$checked_attribute  = ( $html5 ? ' checked' : ' checked="checked"' );

	// Identify required fields visually and create a message about the indicator.
	$required_indicator = ' ' . wp_required_field_indicator();
	$required_text      = ' ' . wp_required_field_message();

	$fields = array(
		'author' => sprintf(
			'

%s %s

', sprintf( '', __( 'Name' ), ( $req ? $required_indicator : '' ) ), sprintf( '', esc_attr( $commenter['comment_author'] ), ( $req ? $required_attribute : '' ) ) ), 'email' => sprintf( '', sprintf( '', __( 'Email' ), ( $req ? $required_indicator : '' ) ), sprintf( '', ( $html5 ? 'type="email"' : 'type="text"' ), esc_attr( $commenter['comment_author_email'] ), ( $req ? $required_attribute : '' ) ) ), 'url' => sprintf( '

%s %s

', sprintf( '', __( 'Website' ) ), sprintf( '', ( $html5 ? 'type="url"' : 'type="text"' ), esc_attr( $commenter['comment_author_url'] ) ) ), ); if ( has_action( 'set_comment_cookies', 'wp_set_comment_cookies' ) && get_option( 'show_comments_cookies_opt_in' ) ) { $consent = empty( $commenter['comment_author_email'] ) ? '' : $checked_attribute; $fields['cookies'] = sprintf( '', sprintf( '', $consent ), sprintf( '', __( 'Save my name, email, and website in this browser for the next time I comment.' ) ) ); // Ensure that the passed fields include cookies consent. if ( isset( $args['fields'] ) && ! isset( $args['fields']['cookies'] ) ) { $args['fields']['cookies'] = $fields['cookies']; } } /** * Filters the default comment form fields. * * @since 3.0.0 * * @param string[] $fields Array of the default comment fields. */ $fields = apply_filters( 'comment_form_default_fields', $fields ); $defaults = array( 'fields' => $fields, 'comment_field' => sprintf( '

%s %s

', sprintf( '', _x( 'Comment', 'noun' ), $required_indicator ), '' ), 'must_log_in' => sprintf( '', sprintf( /* translators: %s: Login URL. */ __( 'You must be logged in to post a comment.' ), /** This filter is documented in wp-includes/link-template.php */ wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ), $post_id ) ) ) ), 'logged_in_as' => sprintf( '

%s%s

', sprintf( /* translators: 1: User name, 2: Edit user link, 3: Logout URL. */ __( 'Logged in as %1$s. Edit your profile. Log out?' ), $user_identity, get_edit_user_link(), /** This filter is documented in wp-includes/link-template.php */ wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ), $post_id ) ) ), $required_text ), 'comment_notes_before' => sprintf( '

%s%s

', sprintf( '%s', __( 'Your email address will not be published.' ) ), $required_text ), 'comment_notes_after' => '', 'action' => site_url( '/wp-comments-post.php' ), 'id_form' => 'commentform', 'id_submit' => 'submit', 'class_container' => 'comment-respond', 'class_form' => 'comment-form', 'class_submit' => 'submit', 'name_submit' => 'submit', 'title_reply' => __( 'Leave a Reply' ), /* translators: %s: Author of the comment being replied to. */ 'title_reply_to' => __( 'Leave a Reply to %s' ), 'title_reply_before' => '

', 'title_reply_after' => '

', 'cancel_reply_before' => ' ', 'cancel_reply_after' => '', 'cancel_reply_link' => __( 'Cancel reply' ), 'label_submit' => __( 'Post Comment' ), 'submit_button' => '', 'submit_field' => '

%1$s %2$s

', 'format' => 'xhtml', ); /** * Filters the comment form default arguments. * * Use {@see 'comment_form_default_fields'} to filter the comment fields. * * @since 3.0.0 * * @param array $defaults The default comment form arguments. */ $args = wp_parse_args( $args, apply_filters( 'comment_form_defaults', $defaults ) ); // Ensure that the filtered arguments contain all required default values. $args = array_merge( $defaults, $args ); // Remove `aria-describedby` from the email field if there's no associated description. if ( isset( $args['fields']['email'] ) && false === strpos( $args['comment_notes_before'], 'id="email-notes"' ) ) { $args['fields']['email'] = str_replace( ' aria-describedby="email-notes"', '', $args['fields']['email'] ); } /** * Fires before the comment form. * * @since 3.0.0 */ do_action( 'comment_form_before' ); ?>
', esc_url( $args['action'] ), esc_attr( $args['id_form'] ), esc_attr( $args['class_form'] ), ( $html5 ? ' novalidate' : '' ) ); /** * Fires at the top of the comment form, inside the form tag. * * @since 3.0.0 */ do_action( 'comment_form_top' ); if ( is_user_logged_in() ) : /** * Filters the 'logged in' message for the comment form for display. * * @since 3.0.0 * * @param string $args_logged_in The HTML for the 'logged in as [user]' message, * the Edit profile link, and the Log out link. * @param array $commenter An array containing the comment author's * username, email, and URL. * @param string $user_identity If the commenter is a registered user, * the display name, blank otherwise. */ echo apply_filters( 'comment_form_logged_in', $args['logged_in_as'], $commenter, $user_identity ); /** * Fires after the is_user_logged_in() check in the comment form. * * @since 3.0.0 * * @param array $commenter An array containing the comment author's * username, email, and URL. * @param string $user_identity If the commenter is a registered user, * the display name, blank otherwise. */ do_action( 'comment_form_logged_in_after', $commenter, $user_identity ); else : echo $args['comment_notes_before']; endif; // Prepare an array of all fields, including the textarea. $comment_fields = array( 'comment' => $args['comment_field'] ) + (array) $args['fields']; /** * Filters the comment form fields, including the textarea. * * @since 4.4.0 * * @param array $comment_fields The comment fields. */ $comment_fields = apply_filters( 'comment_form_fields', $comment_fields ); // Get an array of field names, excluding the textarea. $comment_field_keys = array_diff( array_keys( $comment_fields ), array( 'comment' ) ); // Get the first and the last field name, excluding the textarea. $first_field = reset( $comment_field_keys ); $last_field = end( $comment_field_keys ); foreach ( $comment_fields as $name => $field ) { if ( 'comment' === $name ) { /** * Filters the content of the comment textarea field for display. * * @since 3.0.0 * * @param string $args_comment_field The content of the comment textarea field. */ echo apply_filters( 'comment_form_field_comment', $field ); echo $args['comment_notes_after']; } elseif ( ! is_user_logged_in() ) { if ( $first_field === $name ) { /** * Fires before the comment fields in the comment form, excluding the textarea. * * @since 3.0.0 */ do_action( 'comment_form_before_fields' ); } /** * Filters a comment form field for display. * * The dynamic portion of the hook name, `$name`, refers to the name * of the comment form field. * * Possible hook names include: * * - `comment_form_field_comment` * - `comment_form_field_author` * - `comment_form_field_email` * - `comment_form_field_url` * - `comment_form_field_cookies` * * @since 3.0.0 * * @param string $field The HTML-formatted output of the comment form field. */ echo apply_filters( "comment_form_field_{$name}", $field ) . "n"; if ( $last_field === $name ) { /** * Fires after the comment fields in the comment form, excluding the textarea. * * @since 3.0.0 */ do_action( 'comment_form_after_fields' ); } } } $submit_button = sprintf( $args['submit_button'], esc_attr( $args['name_submit'] ), esc_attr( $args['id_submit'] ), esc_attr( $args['class_submit'] ), esc_attr( $args['label_submit'] ) ); /** * Filters the submit button for the comment form to display. * * @since 4.2.0 * * @param string $submit_button HTML markup for the submit button. * @param array $args Arguments passed to comment_form(). */ $submit_button = apply_filters( 'comment_form_submit_button', $submit_button, $args ); $submit_field = sprintf( $args['submit_field'], $submit_button, get_comment_id_fields( $post_id ) ); /** * Filters the submit field for the comment form to display. * * The submit field includes the submit button, hidden fields for the * comment form, and any wrapper markup. * * @since 4.2.0 * * @param string $submit_field HTML markup for the submit field. * @param array $args Arguments passed to comment_form(). */ echo apply_filters( 'comment_form_submit_field', $submit_field, $args ); /** * Fires at the bottom of the comment form, inside the closing form tag. * * @since 1.5.0 * * @param int $post_id The post ID. */ do_action( 'comment_form', $post_id ); echo ''; endif; ?>