convert_to_screen( string $hook_name ): WP_Screen
- Since
- 3.0.0
- Source
wp-admin/includes/template.php:2676
Compatibility
- WordPress
- since 3.0.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
$hook_namestring- The hook name (also known as the hook suffix) used to determine the screen.
Return value
WP_Screen- Screen object.
Performance profile
How much work a call to convert_to_screen() 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
- 7–19
- Plugin surface
- None
- Called by
- 12
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 23.
Nothing here hands control to plugin code.
12 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
do_action()one call below convert_to_screen()
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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost convert_to_screen() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 7 | ::WP_Screen() |
| always | 19 | __(), sprintf(), _doing_it_wrong() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 23 | 7–19 | 1 | |
| 8.5 | 23 | 7–19 | 1 | |
| 8.4 | 23 | 7–19 | 1 | 2 fewer instructions than PHP 8.3 |
| 8.3 | 25 | 9–21 | 1 | |
| 8.2 | 25 | 9–21 | 1 | |
| 8.1 | 25 | 9–21 | 1 | |
| 7.4 | 25 | 9–21 | 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 · 3
- _doing_it_wrong()Marks something as being incorrectly called.
- __()Retrieves the translation of $text.
- WP_Screen::get()Fetches a screen object.
Used by · 12
- WP_List_Table::__construct()Constructor.
- _WP_List_Table_Compat::__construct()Constructor.
- _get_list_table()Fetches an instance of a WP_List_Table class.
- add_contextual_help()Add contextual help text for a page.
- add_meta_box()Adds a meta box to one or more screens.
- do_accordion_sections()Meta Box Accordion Template Function.
- do_meta_boxes()Meta-Box template function.
- get_column_headers()Get the column headers for a screen
- get_hidden_columns()Get a list of hidden columns.
- get_hidden_meta_boxes()Gets an array of IDs of hidden meta boxes.
- meta_box_prefs()Prints the meta box preferences for screen meta.
- remove_meta_box()Removes a meta box from one or more screens.
Source code
function convert_to_screen( $hook_name ) { if ( ! class_exists( 'WP_Screen' ) ) { _doing_it_wrong( 'convert_to_screen(), add_meta_box()', sprintf( /* translators: 1: wp-admin/includes/template.php, 2: add_meta_box(), 3: add_meta_boxes */ __( 'Likely direct inclusion of %1$s in order to use %2$s. This is very wrong. Hook the %2$s call into the %3$s action instead.' ), '<code>wp-admin/includes/template.php</code>', '<code>add_meta_box()</code>', '<code>add_meta_boxes</code>' ), '3.3.0' ); return (object) array( 'id' => '_invalid', 'base' => '_are_belong_to_us', ); } return WP_Screen::get( $hook_name );}Changelog
Introduced in 3.0.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.7.7 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.