| [ Index ] |
WordPress Cross Reference |
[Source view] [Print] [Project Stats]
WordPress Administration Screen API.
| File Size: | 1064 lines (28 kb) |
| Included or required: | 1 time |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| get_column_headers( $screen ) X-Ref |
| Get the column headers for a screen param: string|WP_Screen $screen The screen you want the headers for return: array Containing the headers in the format id => UI String |
| get_hidden_columns( $screen ) X-Ref |
| Get a list of hidden columns. param: string|WP_Screen $screen The screen you want the hidden columns for return: array |
| meta_box_prefs( $screen ) X-Ref |
| Prints the meta box preferences for screen meta. param: string|WP_Screen $screen |
| get_hidden_meta_boxes( $screen ) X-Ref |
| Get Hidden Meta Boxes param: string|WP_Screen $screen Screen identifier return: array Hidden Meta Boxes |
| 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. |
| get_current_screen() X-Ref |
| Get the current screen object return: WP_Screen Current screen object |
| set_current_screen( $hook_name = '' ) X-Ref |
| Set the current screen object param: mixed $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen, |
| get( $hook_name = '' ) X-Ref |
| Fetches a screen object. param: string $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen. return: WP_Screen Screen object. |
| set_current_screen() X-Ref |
| Makes the screen object the current screen. |
| __construct() X-Ref |
| Constructor |
| in_admin( $admin = null ) X-Ref |
| Indicates whether the screen is in a particular admin param: string $admin The admin to check against (network | user | site). return: boolean True if the screen is in the indicated admin, false otherwise. |
| add_old_compat_help( $screen, $help ) X-Ref |
| Sets the old string-based contextual help for the screen. For backwards compatibility. param: WP_Screen $screen A screen object. param: string $help Help text. |
| set_parentage( $parent_file ) X-Ref |
| Set the parent information for the screen. This is called in admin-header.php after the menu parent for the screen has been determined. param: string $parent_file The parent file of the screen. Typically the $parent_file global. |
| add_option( $option, $args = array() X-Ref |
| Adds an option for the screen. Call this in template files after admin.php is loaded and before admin-header.php is loaded to add screen options. param: string $option Option ID param: mixed $args Option-dependent arguments. |
| remove_option( $option ) X-Ref |
| Remove an option from the screen. param: string $option Option ID. |
| remove_options() X-Ref |
| Remove all options from the screen. |
| get_options() X-Ref |
| Get the options registered for the screen. return: array Options with arguments. |
| get_option( $option, $key = false ) X-Ref |
| Gets the arguments for an option for the screen. param: string $option Option ID. param: mixed $key Optional. Specific array key for when the option is an array. |
| get_help_tabs() X-Ref |
| Gets the help tabs registered for the screen. return: array Help tabs with arguments. |
| get_help_tab( $id ) X-Ref |
| Gets the arguments for a help tab. param: string $id Help Tab ID. return: array Help tab arguments. |
| add_help_tab( $args ) X-Ref |
| Add a help tab to the contextual help for the screen. Call this on the load-$pagenow hook for the relevant screen. param: array $args |
| remove_help_tab( $id ) X-Ref |
| Removes a help tab from the contextual help for the screen. param: string $id The help tab ID. |
| remove_help_tabs() X-Ref |
| Removes all help tabs from the contextual help for the screen. |
| get_help_sidebar() X-Ref |
| Gets the content from a contextual help sidebar. return: string Contents of the help sidebar. |
| set_help_sidebar( $content ) X-Ref |
| Add a sidebar to the contextual help for the screen. Call this in template files after admin.php is loaded and before admin-header.php is loaded to add a sidebar to the contextual help. param: string $content Sidebar content in plain text or HTML. |
| get_columns() X-Ref |
| Gets the number of layout columns the user has selected. The layout_columns option controls the max number and default number of columns. This method returns the number of columns within that range selected by the user via Screen Options. If no selection has been made, the default provisioned in layout_columns is returned. If the screen does not support selecting the number of layout columns, 0 is returned. return: int Number of columns to display. |
| render_screen_meta() X-Ref |
| Render the screen's help section. This will trigger the deprecated filters for backwards compatibility. |
| show_screen_options() X-Ref |
| No description |
| render_screen_options() X-Ref |
| Render the screen options tab. |
| render_screen_layout() X-Ref |
| Render the option for number of columns on the page |
| render_per_page_options() X-Ref |
| Render the items per page option |
| Generated: Tue Mar 25 01:41:18 2014 | WordPress honlapkészítés: online1.hu |