wppaste
WordPress

timer_stop( int|bool $display = 0, int $precision = 3 ): string

Since
0.71
Source
wp-includes/load.php:527
Retrieves or displays the time from the page start to when function is called.

Compatibility

WordPress
since 0.71
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

$displayint|booloptional
Whether to echo or return the results. Accepts 0|false for return, 1|true for echo. Default 0|false.Default: 0
$precisionintoptional
The number of digits from the right of the decimal to display.
Default 3.Default: 3

Return value

string
The "second.microsecond" finished time calculation. The number is formatted for human consumption, both localized and rounded.

Performance profile

How much work a call to timer_stop() 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
20–22

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

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

  • hookthird-party callbacksapply_filters()one call below timer_stop()

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
!function_exists()20–21microtime(), function_exists(), number_format()
function_exists()21–22microtime(), function_exists(), number_format_i18n()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 27 instructions, 20–22 executed per call, 2 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.

Uses · 1

Source code

View on Trac View on GitHub 

function timer_stop( $display = 0, $precision = 3 ) {	global $timestart, $timeend; 	$timeend   = microtime( true );	$timetotal = $timeend - $timestart; 	if ( function_exists( 'number_format_i18n' ) ) {		$r = number_format_i18n( $timetotal, $precision );	} else {		$r = number_format( $timetotal, $precision );	} 	if ( $display ) {		echo $r;	} 	return $r;}

Changelog

Introduced in 0.71. 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/load.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.