[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-admin/includes/ -> screen.php (summary)

WordPress Administration Screen API.

File Size: 244 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 7 functions

  get_column_headers()
  get_hidden_columns()
  meta_box_prefs()
  get_hidden_meta_boxes()
  add_screen_option()
  get_current_screen()
  set_current_screen()

Functions
Functions that are not part of a class:

get_column_headers( $screen )   X-Ref
Get the column headers for a screen

return: string[] The column header labels keyed by column ID.
param: string|WP_Screen $screen The screen you want the headers for
since: 2.7.0

get_hidden_columns( $screen )   X-Ref
Get a list of hidden columns.

return: string[] Array of IDs of hidden columns.
param: string|WP_Screen $screen The screen you want the hidden columns for
since: 2.7.0

meta_box_prefs( $screen )   X-Ref
Prints the meta box preferences for screen meta.

param: WP_Screen $screen
since: 2.7.0

get_hidden_meta_boxes( $screen )   X-Ref
Gets an array of IDs of hidden meta boxes.

return: string[] IDs of hidden meta boxes.
param: string|WP_Screen $screen Screen identifier
since: 2.7.0

add_screen_option( $option, $args = array()   X-Ref
Register and configure an admin screen option

param: string $option An option name.
param: mixed  $args   Option-dependent arguments.
since: 3.1.0

get_current_screen()   X-Ref
Get the current screen object

return: WP_Screen|null Current screen object or null when screen not defined.
since: 3.1.0

set_current_screen( $hook_name = '' )   X-Ref
Set the current screen object

param: string|WP_Screen $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen,
since: 3.0.0



Generated: Thu Nov 21 01:00:03 2024 Cross-referenced by PHPXref 0.7.1