wpdb::set_sql_mode( array $modes = array() )
- Since
- 3.9.0
- Source
wp-includes/class-wpdb.php:949
Description
If no modes are passed, it will ensure the current SQL server modes are compatible.
Compatibility
- WordPress
- since 3.9.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
$modesarrayoptional- A list of SQL modes to set. Default empty array.Default:
array()
Performance profile
How much work a call to wpdb::set_sql_mode() 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
- 13–50
- Plugin surface
- 1 hook
- Called by
- 1
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 58.
Third-party callbacks on 'incompatible_sql_modes' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
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::set_sql_mode() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($modes) && empty($res) | 13 | mysqli_query() |
empty($modes) && !empty($res) && empty($modes_array) | 19 | mysqli_query(), mysqli_fetch_array() |
!empty($modes) | 28–29 | array_change_key_case(), apply_filters(), mysqli_query() |
empty($modes) && !empty($res) && !empty($modes_array) | 49–50 | mysqli_query(), mysqli_fetch_array(), explode(), array_change_key_case(), apply_filters(), mysqli_query() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 58 | 13–50 | 6 | |
| 8.5 | 58 | 13–50 | 6 | |
| 8.4 | 58 | 13–50 | 6 | 7 fewer instructions than PHP 8.3 |
| 8.3 | 65 | 13–54 | 6 | |
| 8.2 | 65 | 13–54 | 6 | |
| 8.1 | 65 | 13–54 | 6 | |
| 7.4 | 65 | 13–54 | 6 |
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.
Hooks and filters fired · 1
One hook fires while wpdb::set_sql_mode() runs, in this order:
- apply_filters( incompatible_sql_modes )filterline 975 (+26 into the body)
Filters the list of incompatible SQL modes to exclude.
Uses · 1
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 1
- wpdb::db_connect()Connects to and selects database.
Source code
public function set_sql_mode( $modes = array() ) { if ( empty( $modes ) ) { $res = mysqli_query( $this->dbh, 'SELECT @@SESSION.sql_mode' ); if ( empty( $res ) ) { return; } $modes_array = mysqli_fetch_array( $res ); if ( empty( $modes_array[0] ) ) { return; } $modes = explode( ',', $modes_array[0] ); } $modes = array_change_key_case( $modes, CASE_UPPER ); /** * Filters the list of incompatible SQL modes to exclude. * * @since 3.9.0 * * @param array $incompatible_modes An array of incompatible modes. */ $incompatible_modes = (array) apply_filters( 'incompatible_sql_modes', $this->incompatible_modes ); foreach ( $modes as $i => $mode ) { if ( in_array( $mode, $incompatible_modes, true ) ) { unset( $modes[ $i ] ); } } $modes_str = implode( ',', $modes ); mysqli_query( $this->dbh, "SET SESSION sql_mode='$modes_str'" ); }Changelog
Introduced in 3.9.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 7.0.4 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.