get_comments_number_text( string|false $zero = false, string|false $one = false, string|false $more = false, int|WP_Post $post = 0 ): 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

$zerostring|falseoptional

Text for no comments. Default false.Default: false

$onestring|falseoptional

Text for one comment. Default false.Default: false

$morestring|falseoptional

Text for more than one comment. Default false.Default: false

$postint|WP_Postoptional

Post ID or WP_Post object. Default is the global $post.Default: 0

Return value

string

Language string for the number of comments a post has.

Performance profile

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

22–64

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

Plugin surface

1 hook

Third-party callbacks on 'comments_number' 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

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()one call below get_comments_number_text()

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 · 6 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while get_comments_number_text() runs, in this order:

1. 1
   apply_filters( comments_number )filterline 1012 (+53 into the body)

   Filters the comments count for display.

Uses · 7

• get_comments_number()Retrieves the amount of comments a post has.
• _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.
• _x()Retrieves translated string with gettext context.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• comments_number()Displays the language string for the number of comments the current post has.
• comments_popup_link()Displays the link to the comments for the current post ID.

Source code

View on Trac ↗View on GitHub ↗

959function get_comments_number_text( $zero = false, $one = false, $more = false, $post = 0 ) {960	$comments_number = (int) get_comments_number( $post );961 962	if ( $comments_number > 1 ) {963		if ( false === $more ) {964			$comments_number_text = sprintf(965				/* translators: %s: Number of comments. */966				_n( '%s Comment', '%s Comments', $comments_number ),967				number_format_i18n( $comments_number )968			);969		} else {970			// % Comments971			/*972			 * translators: If comment number in your language requires declension,973			 * translate this to 'on'. Do not translate into your own language.974			 */975			if ( 'on' === _x( 'off', 'Comment number declension: on or off' ) ) {976				$text = preg_replace( '#<span class="screen-reader-text">.+?</span>#', '', $more );977				$text = preg_replace( '/&.+?;/', '', $text ); // Remove HTML entities.978				$text = trim( strip_tags( $text ), '% ' );979 980				// Replace '% Comments' with a proper plural form.981				if ( $text && ! preg_match( '/[0-9]+/', $text ) && str_contains( $more, '%' ) ) {982					/* translators: %s: Number of comments. */983					$new_text = _n( '%s Comment', '%s Comments', $comments_number );984					$new_text = trim( sprintf( $new_text, '' ) );985 986					$more = str_replace( $text, $new_text, $more );987					if ( ! str_contains( $more, '%' ) ) {988						$more = '% ' . $more;989					}990				}991			}992 993			$comments_number_text = str_replace( '%', number_format_i18n( $comments_number ), $more );994		}995	} elseif ( 0 === $comments_number ) {996		$comments_number_text = ( false === $zero ) ? __( 'No Comments' ) : $zero;997	} else { // Must be one.998		$comments_number_text = ( false === $one ) ? __( '1 Comment' ) : $one;999	}1000 1001	/**1002	 * Filters the comments count for display.1003	 *1004	 * @since 1.5.01005	 *1006	 * @see _n()1007	 *1008	 * @param string $comments_number_text A translatable string formatted based on whether the count1009	 *                                     is equal to 0, 1, or 1+.1010	 * @param int    $comments_number      The number of post comments.1011	 */1012	return apply_filters( 'comments_number', $comments_number_text, $comments_number );1013}

Changelog

Introduced in 4.0.0. 3 changes between 6.7.7 and 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.