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

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

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.

• $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

Performance profile

How much work a call to comment_form() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

11–489

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 568.

Plugin surface

18 hooks

Third-party callbacks on 'comment_form_comments_closed', 'comment_form_default_fields', 'the_permalink' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksdo_action()called directly
• optionoption read or writeget_option()called directly
• cacheobject cachewp_cache_get()one call below comment_form()
• serializeserialisationmaybe_unserialize()one call below comment_form()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 31 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost comment_form() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 19

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

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

   Fires after the comment form if comments are closed.

2. 2
   apply_filters( comment_form_default_fields )filterline 2602 (+109 into the body)

   Filters the default comment form fields.

3. 3
   apply_filters( the_permalink )filterline 2621 (+128 into the body)

   Filters the display of the permalink for the current post.

4. 4
   apply_filters( the_permalink )filterline 2632 (+139 into the body)

   Filters the display of the permalink for the current post.

5. 5
   apply_filters( comment_form_defaults )filterline 2675 (+182 into the body)

   Filters the comment form default arguments.

6. 6
   do_action( comment_form_before )actionline 2694 (+201 into the body)

   Fires before the comment form.

7. 7
   do_action( comment_form_must_log_in_after )actionline 2720 (+227 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 2737 (+244 into the body)

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

9. 9
   apply_filters( comment_form_logged_in )filterline 2753 (+260 into the body)

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

10. 10
    do_action( comment_form_logged_in_after )actionline 2765 (+272 into the body)

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

11. 11
    apply_filters( comment_form_fields )filterline 2783 (+290 into the body)

    Filters the comment form fields, including the textarea.

12. 12
    apply_filters( comment_form_field_comment )filterline 2803 (+310 into the body)

    Filters the content of the comment textarea field for display.

13. 13
    do_action( comment_form_before_fields )actionline 2815 (+322 into the body)

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

14. 14
    apply_filters( comment_form_field_{$name} )filterline 2836 (+343 into the body)

    Filters a comment form field for display.

15. 15
    do_action( comment_form_after_fields )actionline 2844 (+351 into the body)

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

16. 16
    apply_filters( comment_form_submit_button )filterline 2865 (+372 into the body)

    Filters the submit button for the comment form to display.

17. 17
    apply_filters( comment_form_submit_field )filterline 2884 (+391 into the body)

    Filters the submit field for the comment form to display.

18. 18
    do_action( comment_form )actionline 2893 (+400 into the body)

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

19. 19
    do_action( comment_form_after )actionline 2907 (+414 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()Documentation for function.

Source code

View on Trac ↗View on GitHub ↗

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

Changelog

Introduced in 5.5.0. 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.7.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.