_admin_search_query()
- Since
- 2.7.0
- Source
wp-admin/includes/template.php:2113
Description
A simple wrapper to display the "s" parameter in a GET URI. This function should only be used when the_search_query() cannot.
Compatibility
- WordPress
- since 2.7.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.
Performance profile
How much work a call to _admin_search_query() 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–16
- 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 17.
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 _admin_search_query()
Further down the call graph this can also reach option, cache, serialize, query 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost _admin_search_query() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!isset($value) | 6 | none |
isset($value) | 16 | wp_unslash(), esc_attr() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 16 | 6–15 | 1 | 1 fewer instruction than PHP 8.5 |
| 8.5 | 17 | 6–16 | 1 | |
| 8.4 | 17 | 6–16 | 1 | |
| 8.3 | 17 | 6–16 | 1 | |
| 8.2 | 17 | 6–16 | 1 | |
| 8.1 | 17 | 6–16 | 1 | |
| 7.4 | 17 | 6–16 | 1 |
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
- esc_attr()Escaping for HTML attributes.
- wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
Used by · 3
- WP_List_Table::search_box()Displays the search box.
- WP_Media_List_Table::views()Overrides parent views to use the filter bar display.
- WP_Plugins_List_Table::search_box()Displays the search box.
Source code
function _admin_search_query() { echo isset( $_REQUEST['s'] ) ? esc_attr( wp_unslash( $_REQUEST['s'] ) ) : '';}Changelog
Introduced in 2.7.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-admin/includes/template.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.