wpdb::add_placeholder_escape( string $query ): string
- Since
- 4.8.3
- Source
wp-includes/class-wpdb.php:2436
Compatibility
- WordPress
- since 4.8.3
- 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
$querystring- The query to escape.
Return value
string- The query with the placeholder escape string inserted where necessary.
Performance profile
How much work a call to wpdb::add_placeholder_escape() 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
- 6
- Plugin surface
- None
- Called by
- 2
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. The body compiles to 6.
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 wpdb::add_placeholder_escape() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 6 | ->placeholder_escape() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 6 | 6 | 0 | |
| 8.5 | 6 | 6 | 0 | |
| 8.4 | 6 | 6 | 0 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 9 | 9 | 0 | |
| 8.2 | 9 | 9 | 0 | |
| 8.1 | 9 | 9 | 0 | |
| 7.4 | 9 | 9 | 0 |
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 · 1
- wpdb::placeholder_escape()Generates and returns a placeholder escape string for use in queries returned by ::prepare().
Used by · 2
- wpdb::_real_escape()Real escape using mysqli_real_escape_string().
- wpdb::prepare()Prepares a SQL query for safe execution.
Source code
public function add_placeholder_escape( $query ) { /* * To prevent returning anything that even vaguely resembles a placeholder, * we clobber every % we can find. */ return str_replace( '%', $this->placeholder_escape(), $query ); }Changelog
Introduced in 4.8.3. 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.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.