convert_to_screen() – Convert a screen string to a screen object

You appear to be a bot. Output may be restricted

Description

Converts a screen string to a screen object.

Usage

$WP_Screen = convert_to_screen( $hook_name );

Parameters

$hook_name
( string ) required – The hook name (also known as the hook suffix) used to determine the screen.

Returns

WP_Screen Screen object.

Source

File name: wordpress/wp-admin/includes/template.php
Lines:

1 to 21 of 21
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::WP_Screen::get( $hook_name );
}
 

 View on GitHub View on Trac