render_block_core_comments_title( array $attributes ): string

Compatibility

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

Parameters

$attributesarray

Block attributes.

Return value

string

Return the post comments title.

Performance profile

How much work a call to render_block_core_comments_title() 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

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

5–66

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• querycontent queryget_post()one call below render_block_core_comments_title()
• hookthird-party callbacksapply_filters()one call below render_block_core_comments_title()

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 5 distinct outcomes

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

Uses · 7

• post_password_required()Determines whether the post requires password and whether a correct password has been provided.
• get_block_wrapper_attributes()Generates a string of attributes by applying to the current block being rendered all of the features that the block supports.
• get_comments_number()Retrieves the amount of comments a post has.
• get_the_title()Retrieves the post title.
• __()Retrieves the translation of $text.
• _n()Translates and retrieves the singular or plural form based on the supplied number.
• number_format_i18n()Converts float number to format based on the locale.

Source code

View on Trac ↗View on GitHub ↗

17function render_block_core_comments_title( $attributes ) {18 19	if ( post_password_required() ) {20		return;21	}22 23	$align_class_name    = empty( $attributes['textAlign'] ) ? '' : "has-text-align-{$attributes['textAlign']}";24	$show_post_title     = ! empty( $attributes['showPostTitle'] ) && $attributes['showPostTitle'];25	$show_comments_count = ! empty( $attributes['showCommentsCount'] ) && $attributes['showCommentsCount'];26	$wrapper_attributes  = get_block_wrapper_attributes( array( 'class' => $align_class_name ) );27	$comments_count      = get_comments_number();28	$post_title          = get_the_title();29	$tag_name            = 'h2';30	if ( isset( $attributes['level'] ) ) {31		$tag_name = 'h' . $attributes['level'];32	}33 34	if ( '0' === $comments_count ) {35		return;36	}37 38	if ( $show_comments_count ) {39		if ( $show_post_title ) {40			if ( '1' === $comments_count ) {41				/* translators: %s: Post title. */42				$comments_title = sprintf( __( 'One response to &#8220;%s&#8221;' ), $post_title );43			} else {44				$comments_title = sprintf(45					/* translators: 1: Number of comments, 2: Post title. */46					_n(47						'%1$s response to &#8220;%2$s&#8221;',48						'%1$s responses to &#8220;%2$s&#8221;',49						$comments_count50					),51					number_format_i18n( $comments_count ),52					$post_title53				);54			}55		} elseif ( '1' === $comments_count ) {56			$comments_title = __( 'One response' );57		} else {58			$comments_title = sprintf(59				/* translators: %s: Number of comments. */60				_n( '%s response', '%s responses', $comments_count ),61				number_format_i18n( $comments_count )62			);63		}64	} elseif ( $show_post_title ) {65		if ( '1' === $comments_count ) {66			/* translators: %s: Post title. */67			$comments_title = sprintf( __( 'Response to &#8220;%s&#8221;' ), $post_title );68		} else {69			/* translators: %s: Post title. */70			$comments_title = sprintf( __( 'Responses to &#8220;%s&#8221;' ), $post_title );71		}72	} elseif ( '1' === $comments_count ) {73		$comments_title = __( 'Response' );74	} else {75		$comments_title = __( 'Responses' );76	}77 78	return sprintf(79		'<%1$s id="comments" %2$s>%3$s</%1$s>',80		$tag_name,81		$wrapper_attributes,82		$comments_title83	);84}

Changelog

Introduced in 6.0.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 7.1.0 tag, from src/wp-includes/blocks/comments-title.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.