wppaste
WordPress

the_post_thumbnail_caption( int|WP_Post|null $post = null )

Since
4.6.0
Source
wp-includes/post-thumbnail-template.php:320
Displays the post thumbnail caption.

Compatibility

WordPress
since 4.6.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$postint|WP_Post|nulloptional
Post ID or WP_Post object. Default is global $post.Default: null

Performance profile

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

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
10

Executed per call on PHP 8.5. The body compiles to 10.

Plugin surface
1 hook

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

Called by
0

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

What it touches

  • hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, cache, serialize, option 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 · 1 distinct outcome

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

WhenInstructionsCalls it makes
always10get_the_post_thumbnail_caption(), apply_filters()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 10 instructions, 10 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 1

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

  1. apply_filters( the_post_thumbnail_caption )filterline 328 (+8 into the body)

    Filters the displayed post thumbnail caption.

Uses · 2

Source code

View on Trac View on GitHub 

function the_post_thumbnail_caption( $post = null ) {	/**	 * Filters the displayed post thumbnail caption.	 *	 * @since 4.6.0	 *	 * @param string $caption Caption for the given attachment.	 */	echo apply_filters( 'the_post_thumbnail_caption', get_the_post_thumbnail_caption( $post ) );}

Changelog

Introduced in 4.6.0. One change 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.

6.8.8
Parameter $post retyped from int|WP_Post to int|WP_Post|null.verified against source
4.6.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/post-thumbnail-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.