WP_Screen::get( string|WP_Screen $hook_name = '' ): WP_Screen

Compatibility

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|WP_Screenoptional

The hook name (also known as the hook suffix) used to determine the screen.
Defaults to the current $hook_suffix global.Default: ''

Return value

WP_Screen

Screen object.

Performance profile

How much work a call to WP_Screen::get() 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

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

47–141

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 320.

Plugin surface

1 hook

Third-party callbacks on 'replace_editor' run inside this call, and their cost is not bounded by anything here.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach 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 · 24 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Screen::get() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

One hook fires while WP_Screen::get() runs, in this order:

1. 1
   apply_filters( replace_editor )filterline 312 (+102 into the body)

   Allows replacement of the editor.

Uses · 14

• post_type_exists()Determines whether a post type is registered.
• str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.
• sanitize_key()Sanitizes a string key.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• taxonomy_exists()Determines whether the taxonomy name exists.
• wp_die()Kills WordPress execution and displays HTML page with an error message.
• __()Retrieves the translation of $text.
• get_post()Retrieves post data given a post ID or post object.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• use_block_editor_for_post()Returns whether the post can be edited in the block editor.
• is_object_in_taxonomy()Determines if the given object type is associated with the given taxonomy.
• use_block_editor_for_post_type()Returns whether a post type is compatible with the block editor.

Used by · 3

• WP_Customize_Nav_Menus_Panel::render_screen_options()Render screen options for Menus.
• convert_to_screen()Converts a screen string to a screen object.
• set_current_screen()Set the current screen object

Source code

View on Trac ↗View on GitHub ↗

210	public static function get( $hook_name = '' ) {211		if ( $hook_name instanceof WP_Screen ) {212			return $hook_name;213		}214 215		$id              = '';216		$post_type       = null;217		$taxonomy        = null;218		$in_admin        = false;219		$action          = '';220		$is_block_editor = false;221 222		if ( $hook_name ) {223			$id = $hook_name;224		} elseif ( ! empty( $GLOBALS['hook_suffix'] ) ) {225			$id = $GLOBALS['hook_suffix'];226		}227 228		// For those pesky meta boxes.229		if ( $hook_name && post_type_exists( $hook_name ) ) {230			$post_type = $id;231			$id        = 'post'; // Changes later. Ends up being $base.232		} else {233			if ( str_ends_with( $id, '.php' ) ) {234				$id = substr( $id, 0, -4 );235			}236 237			if ( in_array( $id, array( 'post-new', 'link-add', 'media-new', 'user-new' ), true ) ) {238				$id     = substr( $id, 0, -4 );239				$action = 'add';240			}241		}242 243		if ( ! $post_type && $hook_name ) {244			if ( str_ends_with( $id, '-network' ) ) {245				$id       = substr( $id, 0, -8 );246				$in_admin = 'network';247			} elseif ( str_ends_with( $id, '-user' ) ) {248				$id       = substr( $id, 0, -5 );249				$in_admin = 'user';250			}251 252			$id = sanitize_key( $id );253			if ( 'edit-comments' !== $id && 'edit-tags' !== $id && str_starts_with( $id, 'edit-' ) ) {254				$maybe = substr( $id, 5 );255				if ( taxonomy_exists( $maybe ) ) {256					$id       = 'edit-tags';257					$taxonomy = $maybe;258				} elseif ( post_type_exists( $maybe ) ) {259					$id        = 'edit';260					$post_type = $maybe;261				}262			}263 264			if ( ! $in_admin ) {265				$in_admin = 'site';266			}267		} else {268			if ( defined( 'WP_NETWORK_ADMIN' ) && WP_NETWORK_ADMIN ) {269				$in_admin = 'network';270			} elseif ( defined( 'WP_USER_ADMIN' ) && WP_USER_ADMIN ) {271				$in_admin = 'user';272			} else {273				$in_admin = 'site';274			}275		}276 277		if ( 'index' === $id ) {278			$id = 'dashboard';279		} elseif ( 'front' === $id ) {280			$in_admin = false;281		}282 283		$base = $id;284 285		// If this is the current screen, see if we can be more accurate for post types and taxonomies.286		if ( ! $hook_name ) {287			if ( isset( $_REQUEST['post_type'] ) ) {288				$post_type = post_type_exists( $_REQUEST['post_type'] ) ? $_REQUEST['post_type'] : false;289			}

Changelog

Introduced in 3.3.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-admin/includes/class-wp-screen.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.