WP_Screen
class WP_Screen
// Constructor: function Object() { [native code] } Core class used to implement an admin screen API.
Methods 33 methods
| Method / Return | Description |
|---|---|
| get() WP_Screen | Fetches a screen object.
Parameters: $hook_name: mixed |
| set_current_screen() void | Makes the screen object the current screen. |
| __construct() void | Constructor |
| in_admin() bool | Indicates whether the screen is in a particular admin.
Parameters: $admin: mixed |
| is_block_editor() bool | Sets or returns whether the block editor is loading on the current screen.
Parameters: $set: mixed |
| add_old_compat_help() void | Sets the old string-based contextual help for the screen for backward compatibility.
Parameters: $screen: mixed, $help: mixed |
| set_parentage() void | Sets the parent information for the screen.
Parameters: $parent_file: mixed |
| add_option() void | Adds an option for the screen.
Parameters: $option: mixed, $args: mixed |
| remove_option() void | Removes an option from the screen.
Parameters: $option: mixed |
| remove_options() void | Removes all options from the screen. |
| get_options() array | Gets the options registered for the screen. |
| get_option() string | Gets the arguments for an option for the screen.
Parameters: $option: mixed, $key: mixed |
| get_help_tabs() array | Gets the help tabs registered for the screen. |
| get_help_tab() array | Gets the arguments for a help tab.
Parameters: $id: mixed |
| add_help_tab() void | Adds a help tab to the contextual help for the screen.
Parameters: $args: mixed |
| remove_help_tab() void | Removes a help tab from the contextual help for the screen.
Parameters: $id: mixed |
| remove_help_tabs() void | Removes all help tabs from the contextual help for the screen. |
| get_help_sidebar() string | Gets the content from a contextual help sidebar. |
| set_help_sidebar() void | Adds a sidebar to the contextual help for the screen.
Parameters: $content: mixed |
| get_columns() int | Gets the number of layout columns the user has selected. |
| get_screen_reader_content() string[] | Gets the accessible hidden headings and text used in the screen. |
| get_screen_reader_text() string | Gets a screen reader text string.
Parameters: $key: mixed |
| set_screen_reader_content() void | Adds accessible hidden headings and text for the screen.
Parameters: $content: mixed |
| remove_screen_reader_content() void | Removes all the accessible hidden headings and text for the screen. |
| render_screen_meta() void | Renders the screen's help section. |
| show_screen_options() bool | No description available. |
| render_screen_options() void | Renders the screen options tab.
Parameters: $options: mixed |
| render_meta_boxes_preferences() void | Renders the meta boxes preferences. |
| render_list_table_columns_preferences() void | Renders the list table columns preferences. |
| render_screen_layout() void | Renders the option for number of columns on the page. |
| render_per_page_options() void | Renders the items per page option. |
| render_view_mode() void | Renders the list table view mode preferences. |
| render_screen_reader_content() void | Renders screen reader text.
Parameters: $key: mixed, $tag: mixed |
Properties
| Property / Type | Description |
|---|---|
| $action mixed public | No description available. |
| $base mixed public | No description available. |
| $columns mixed public | No description available. |
| $id mixed public | No description available. |
| $in_admin mixed public | No description available. |
| $is_network mixed public | No description available. |
| $is_user mixed public | No description available. |
| $parent_base mixed public | No description available. |
| $parent_file mixed public | No description available. |
| $post_type mixed public | No description available. |
| $taxonomy mixed public | No description available. |
| $_help_tabs mixed public | No description available. |
| $_help_sidebar mixed public | No description available. |
| $_screen_reader_content mixed public | No description available. |
| $_old_compat_help mixed public | No description available. |
| $_options mixed public | No description available. |
| $_registry mixed public | No description available. |
| $_show_screen_options mixed public | No description available. |
| $_screen_settings mixed public | No description available. |
| $is_block_editor mixed public | No description available. |