WP_Site_Health::test_php_extension_availability( string $extension_name = null, string $function_name = null, string $constant_name = null, string $class_name = null ): bool
- Since
- 5.2.0, 5.3.0
- Source
wp-admin/includes/class-wp-site-health.php:868
Description
Make the check for available PHP modules into a simple boolean operator for a cleaner test runner.
Compatibility
- WordPress
- since 5.3.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
$extension_namestringoptional- The extension name to test. Default null.Default:
null $function_namestringoptional- The function name to test. Default null.Default:
null $constant_namestringoptional- The constant name to test for. Default null.Default:
null $class_namestringoptional- The class name to test for. Default null.Default:
null
Return value
bool- Whether or not the extension and function are available.
Performance profile
How much work a call to WP_Site_Health::test_php_extension_availability() 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
- Scaling
- Constant
- Instructions
- 9–27
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 32.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What one call costs · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Site_Health::test_php_extension_availability() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 9–15 | none |
| always | 10–19 | extension_loaded() |
| always | 13–19 | function_exists() |
| always | 14–19 | defined() |
extension_loaded() | 15–23 | extension_loaded(), function_exists() |
extension_loaded() | 16–23 | extension_loaded(), defined() |
function_exists() | 18–23 | function_exists(), defined() |
extension_loaded() && function_exists() | 20–27 | extension_loaded(), function_exists(), defined() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 32 | 9–27 | 12 | |
| 8.5 | 32 | 9–27 | 12 | |
| 8.4 | 32 | 9–27 | 12 | 2 fewer instructions than PHP 8.3 |
| 8.3 | 34 | 9–29 | 12 | |
| 8.2 | 34 | 9–29 | 12 | |
| 8.1 | 34 | 9–29 | 12 | |
| 7.4 | 34 | 9–29 | 12 |
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.
Used by · 1
- WP_Site_Health::get_test_php_extensions()Tests if required PHP modules are installed on the host.
Source code
private function test_php_extension_availability( $extension_name = null, $function_name = null, $constant_name = null, $class_name = null ) { // If no extension or function is passed, claim to fail testing, as we have nothing to test against. if ( ! $extension_name && ! $function_name && ! $constant_name && ! $class_name ) { return false; } if ( $extension_name && ! extension_loaded( $extension_name ) ) { return false; } if ( $function_name && ! function_exists( $function_name ) ) { return false; } if ( $constant_name && ! defined( $constant_name ) ) { return false; } if ( $class_name && ! class_exists( $class_name ) ) { return false; } return true; }Changelog
Introduced in 5.2.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$constant_name and $class_name parameters were added.from the docblockAbout 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.