wp_get_extension_error_description( array $error ): string
- Since
- 5.2.0
- Source
wp-includes/error-protection.php:47
Compatibility
- WordPress
- since 5.2.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
$errorarray- Error details from
error_get_last().
Return value
string- Formatted error description.
Performance profile
How much work a call to wp_get_extension_error_description() 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
- Light
- Scaling
- Scales with input
- Instructions
- 43–49
- Plugin surface
- None
- Called by
- 2
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 56.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
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_get_extension_error_description() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 43–49 | get_defined_constants(), __(), sprintf() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 56 | 43–49 | 5 | |
| 8.5 | 56 | 43–49 | 5 | |
| 8.4 | 56 | 43–49 | 5 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 59 | 43–49 | 5 | |
| 8.2 | 59 | 43–49 | 5 | |
| 8.1 | 59 | 43–49 | 5 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 61 | 44–50 | 5 |
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 · 2
- str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
- __()Retrieves the translation of $text.
Used by · 2
- WP_Plugins_List_Table::single_row()
- WP_Recovery_Mode_Email_Service::send_recovery_mode_email()Sends the Recovery Mode email to the site admin email address.
Source code
function wp_get_extension_error_description( $error ) { $constants = get_defined_constants( true ); $constants = isset( $constants['Core'] ) ? $constants['Core'] : $constants['internal']; $core_errors = array(); foreach ( $constants as $constant => $value ) { if ( str_starts_with( $constant, 'E_' ) ) { $core_errors[ $value ] = $constant; } } if ( isset( $core_errors[ $error['type'] ] ) ) { $error['type'] = $core_errors[ $error['type'] ]; } /* translators: 1: Error type, 2: Error line number, 3: Error file name, 4: Error message. */ $error_message = __( 'An error of type %1$s was caused in line %2$s of the file %3$s. Error message: %4$s' ); return sprintf( $error_message, "<code>{$error['type']}</code>", "<code>{$error['line']}</code>", "<code>{$error['file']}</code>", "<code>{$error['message']}</code>" );}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.
About this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 tag, from
src/wp-includes/error-protection.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.