A WordPress-centric search engine for devs and theme authors



convert_to_screen ›

Since3.0.0
Deprecatedn/a
convert_to_screen ( $hook_name )
Parameters:
  • (string) $hook_name The hook name (also known as the hook suffix) used to determine the screen.
    Required: Yes
Returns:
  • (WP_Screen) Screen object.
Defined at:
Codex:

Convert a screen string to a screen object



Source

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 );
}