wpdb::bail( string $message, string $error_code = '500' ): void|false
- Since
- 1.5.0
- Source
wp-includes/class-wpdb.php:3931
Description
Will not die if wpdb::$show_errors is false.
Compatibility
- WordPress
- since 1.5.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
$messagestring- The error message.
$error_codestringoptional- A computer-readable string to identify the error.
Default '500'.Default:'500'
Return value
void|false- Void if the showing of errors is enabled, false if disabled.
Performance profile
How much work a call to wpdb::bail() 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–24
- Plugin surface
- None
- Called by
- 3
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 42.
Nothing here hands control to plugin code.
3 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below wpdb::bail()
Further down the call graph this can also reach query, option, cache, serialize 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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wpdb::bail() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 9–13 | none |
!($value instanceof) && !mysqli_connect_errno() | 16–20 | mysqli_connect_errno(), wp_die() |
!($value instanceof) && mysqli_connect_errno() | 19–23 | mysqli_connect_errno(), mysqli_connect_error(), wp_die() |
$value instanceof | 20–24 | mysqli_error(), wp_die() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 42 | 9–24 | 5 | |
| 8.5 | 42 | 9–24 | 5 | |
| 8.4 | 42 | 9–24 | 5 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 45 | 12–24 | 5 | |
| 8.2 | 45 | 12–24 | 5 | |
| 8.1 | 45 | 12–24 | 5 | |
| 7.4 | 45 | 12–24 | 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
- wp_die()Kills WordPress execution and displays HTML page with an error message.
- WP_Error::__construct()Initializes the error.
Used by · 3
- wpdb::check_connection()Checks that the connection to the database is still up. If not, try to reconnect.
- wpdb::db_connect()Connects to and selects database.
- wpdb::select()Selects a database using the current or provided database connection.
Source code
public function bail( $message, $error_code = '500' ) { if ( $this->show_errors ) { $error = ''; if ( $this->dbh instanceof mysqli ) { $error = mysqli_error( $this->dbh ); } elseif ( mysqli_connect_errno() ) { $error = mysqli_connect_error(); } if ( $error ) { $message = '<p><code>' . $error . "</code></p>\n" . $message; } wp_die( $message ); } else { if ( class_exists( 'WP_Error', false ) ) { $this->error = new WP_Error( $error_code, $message ); } else { $this->error = $message; } return false; } }Changelog
Introduced in 1.5.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
void|false to false.verified against sourceAbout this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/class-wpdb.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.