WP_Site_Health::perform_test( callable $callback ): mixed|void

Compatibility

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

Parameters

$callbackcallable

Return value

mixed|void

Performance profile

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

8

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

Plugin surface

1 hook

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

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 WP_Site_Health::perform_test() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

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

1. 1
   apply_filters( site_status_test_result )filterline 194 (+22 into the body)

   Filters the output of a finished Site Health test.

Uses · 1

• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• WP_Site_Health::enqueue_scripts()Enqueues the site health scripts.
• WP_Site_Health::wp_cron_scheduled_check()Runs the scheduled event to check and update the latest site health status for the website.

Source code

View on Trac ↗View on GitHub ↗

172	private function perform_test( $callback ) {173		/**174		 * Filters the output of a finished Site Health test.175		 *176		 * @since 5.3.0177		 *178		 * @param array $test_result {179		 *     An associative array of test result data.180		 *181		 *     @type string $label       A label describing the test, and is used as a header in the output.182		 *     @type string $status      The status of the test, which can be a value of `good`, `recommended` or `critical`.183		 *     @type array  $badge {184		 *         Tests are put into categories which have an associated badge shown, these can be modified and assigned here.185		 *186		 *         @type string $label The test label, for example `Performance`.187		 *         @type string $color Default `blue`. A string representing a color to use for the label.188		 *     }189		 *     @type string $description A more descriptive explanation of what the test looks for, and why it is important for the end user.190		 *     @type string $actions     An action to direct the user to where they can resolve the issue, if one exists.191		 *     @type string $test        The name of the test being ran, used as a reference point.192		 * }193		 */194		return apply_filters( 'site_status_test_result', call_user_func( $callback ) );195	}

Changelog

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

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-admin/includes/class-wp-site-health.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.