comment_form( array $args = array(), int|WP_Post $post = null )

Description

Parameters

$argsarrayoptional

Default arguments and form fields to override.Default: array()

• $fieldsarray

  { Default comment fields, filterable by default via the 'comment_form_default_fields' hook.

• $authorstring

  Comment author field HTML.

• $emailstring

  Comment author email field HTML.

• $urlstring

  Comment author URL field HTML.

• $cookiesstring

  Comment cookie opt-in field HTML. } @type string $comment_field The comment textarea field HTML.

• $must_log_instring

  HTML element for a 'must be logged in to comment' message.

• $logged_in_asstring

  The HTML for the 'logged in as [user]' message, the Edit profile link, and the Log out link.

• $comment_notes_beforestringdefault: 'Your email address will not be published.'

  HTML element for a message displayed before the comment fields if the user is not logged in.

• $comment_notes_afterstring

  HTML element for a message displayed after the textarea field.

• $actionstringdefault: '/wp-comments-post.php'

  The comment form element action attribute.

• $novalidatebooldefault: false

  Whether the novalidate attribute is added to the comment form.

• $id_formstringdefault: 'commentform'

  The comment form element id attribute.

• $id_submitstringdefault: 'submit'

  The comment submit element id attribute.

• $class_containerstringdefault: 'comment-respond'

  The comment form container class attribute.

• $class_formstringdefault: 'comment-form'

  The comment form element class attribute.

• $class_submitstringdefault: 'submit'

  The comment submit element class attribute.

• $name_submitstringdefault: 'submit'

  The comment submit element name attribute.

• $title_replystringdefault: 'Leave a Reply'

  The translatable 'reply' button label.

• $title_reply_tostringdefault: 'Leave a Reply to %s', where %s is the author of the comment being replied to

  The translatable 'reply-to' button label.

• $title_reply_beforestringdefault: ''

  HTML displayed before the comment form title.

• $title_reply_afterstringdefault: ''

  HTML displayed after the comment form title.

• $cancel_reply_beforestring

  HTML displayed before the cancel reply link.

• $cancel_reply_afterstring

  HTML displayed after the cancel reply link.

• $cancel_reply_linkstringdefault: 'Cancel reply'

  The translatable 'cancel reply' button label.

• $label_submitstringdefault: 'Post a comment'

  The translatable 'submit' button label.

• $submit_buttonstringdefault: ''

  HTML format for the Submit button.

• $submit_fieldstring

  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.

• $formatstringdefault: 'xhtml'. Accepts 'xhtml', 'html5'

  The comment form format.

$postint|WP_Postoptional

Post ID or WP_Post object to generate the form for. Default current post.Default: null

Hooks fired · 19

19 hooks fire while comment_form() runs, in this order:

1. 1
   do_action( comment_form_comments_closed )actionline 2507 (+13 into the body)

   Fires after the comment form if comments are closed.

2. 2
   apply_filters( comment_form_default_fields )filterline 2605 (+111 into the body)

   Filters the default comment form fields.

3. 3
   apply_filters( the_permalink )filterline 2624 (+130 into the body)

   Filters the display of the permalink for the current post.

4. 4
   apply_filters( the_permalink )filterline 2635 (+141 into the body)

   Filters the display of the permalink for the current post.

5. 5
   apply_filters( comment_form_defaults )filterline 2679 (+185 into the body)

   Filters the comment form default arguments.

6. 6
   do_action( comment_form_before )actionline 2698 (+204 into the body)

   Fires before the comment form.

7. 7
   do_action( comment_form_must_log_in_after )actionline 2724 (+230 into the body)

   Fires after the HTML-formatted 'must log in after' message in the comment form.

8. 8
   do_action( comment_form_top )actionline 2741 (+247 into the body)

   Fires at the top of the comment form, inside the form tag.

9. 9
   apply_filters( comment_form_logged_in )filterline 2757 (+263 into the body)

   Filters the 'logged in' message for the comment form for display.

10. 10
    do_action( comment_form_logged_in_after )actionline 2769 (+275 into the body)

    Fires after the is_user_logged_in() check in the comment form.

11. 11
    apply_filters( comment_form_fields )filterline 2787 (+293 into the body)

    Filters the comment form fields, including the textarea.

12. 12
    apply_filters( comment_form_field_comment )filterline 2807 (+313 into the body)

    Filters the content of the comment textarea field for display.

13. 13
    do_action( comment_form_before_fields )actionline 2819 (+325 into the body)

    Fires before the comment fields in the comment form, excluding the textarea.

14. 14
    apply_filters( comment_form_field_{$name} )filterline 2840 (+346 into the body)

    Filters a comment form field for display.

15. 15
    do_action( comment_form_after_fields )actionline 2848 (+354 into the body)

    Fires after the comment fields in the comment form, excluding the textarea.

16. 16
    apply_filters( comment_form_submit_button )filterline 2869 (+375 into the body)

    Filters the submit button for the comment form to display.

17. 17
    apply_filters( comment_form_submit_field )filterline 2888 (+394 into the body)

    Filters the submit field for the comment form to display.

18. 18
    do_action( comment_form )actionline 2897 (+403 into the body)

    Fires at the bottom of the comment form, inside the closing form tag.

19. 19
    do_action( comment_form_after )actionline 2911 (+417 into the body)

    Fires after the comment form.

Uses · 26

• get_post()Retrieves post data given a post ID or post object.
• comments_open()Determines whether the current post is open for comments.
• do_action()Calls the callback functions that have been added to an action hook.
• wp_get_current_commenter()Gets current commenter's name, email, and URL.
• wp_get_current_user()Retrieves the current user object.
• wp_parse_args()Merges user defined arguments into defaults array.
• current_theme_supports()Checks a theme's support for a given feature.
• get_option()Retrieves an option value based on an option name.
• wp_required_field_indicator()Assigns a visual indicator for required form fields.
• wp_required_field_message()Creates a message to explain required form fields.
• __()Retrieves the translation of $text.
• esc_attr()Escaping for HTML attributes.

Used by · 2

• render_block_core_post_comments_form()Renders the `core/post-comments-form` block on the server.
• twentynineteen_comment_form()Displays the comment form.

Source

View on Trac ↗View on GitHub ↗

2494function comment_form( $args = array(), $post = null ) {2495	$post = get_post( $post );2496 2497	// Exit the function if the post is invalid or comments are closed.2498	if ( ! $post || ! comments_open( $post ) ) {2499		/**2500		 * Fires after the comment form if comments are closed.2501		 *2502		 * For backward compatibility, this action also fires if comment_form()2503		 * is called with an invalid post object or ID.2504		 *2505		 * @since 3.0.02506		 */2507		do_action( 'comment_form_comments_closed' );2508 2509		return;2510	}2511 2512	$post_id       = $post->ID;2513	$commenter     = wp_get_current_commenter();2514	$user          = wp_get_current_user();2515	$user_identity = $user->exists() ? $user->display_name : '';2516 2517	$args = wp_parse_args( $args );2518	if ( ! isset( $args['format'] ) ) {2519		$args['format'] = current_theme_supports( 'html5', 'comment-form' ) ? 'html5' : 'xhtml';2520	}2521 2522	$req   = get_option( 'require_name_email' );2523	$html5 = 'html5' === $args['format'];2524 2525	// Define attributes in HTML5 or XHTML syntax.2526	$required_attribute = ( $html5 ? ' required' : ' required="required"' );2527	$checked_attribute  = ( $html5 ? ' checked' : ' checked="checked"' );2528 2529	// Identify required fields visually and create a message about the indicator.2530	$required_indicator = ' ' . wp_required_field_indicator();2531	$required_text      = ' ' . wp_required_field_message();2532 2533	$fields = array(2534		'author' => sprintf(2535			'<p class="comment-form-author">%s %s</p>',2536			sprintf(2537				'<label for="author">%s%s</label>',2538				__( 'Name' ),2539				( $req ? $required_indicator : '' )2540			),2541			sprintf(2542				'<input id="author" name="author" type="text" value="%s" size="30" maxlength="245" autocomplete="name"%s />',2543				esc_attr( $commenter['comment_author'] ),2544				( $req ? $required_attribute : '' )2545			)2546		),2547		'email'  => sprintf(2548			'<p class="comment-form-email">%s %s</p>',2549			sprintf(2550				'<label for="email">%s%s</label>',2551				__( 'Email' ),2552				( $req ? $required_indicator : '' )2553			),2554			sprintf(2555				'<input id="email" name="email" %s value="%s" size="30" maxlength="100" aria-describedby="email-notes" autocomplete="email"%s />',2556				( $html5 ? 'type="email"' : 'type="text"' ),2557				esc_attr( $commenter['comment_author_email'] ),2558				( $req ? $required_attribute : '' )2559			)2560		),2561		'url'    => sprintf(2562			'<p class="comment-form-url">%s %s</p>',2563			sprintf(2564				'<label for="url">%s</label>',2565				__( 'Website' )2566			),2567			sprintf(2568				'<input id="url" name="url" %s value="%s" size="30" maxlength="200" autocomplete="url" />',2569				( $html5 ? 'type="url"' : 'type="text"' ),2570				esc_attr( $commenter['comment_author_url'] )2571			)2572		),2573	);

History

Introduced in 6.8.2. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/comment-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.