On this page
get_hidden_meta_boxes( string|WP_Screen $screen ): string[]
Gets an array of IDs of hidden meta boxes.
Parameters
$screenstring|WP_Screen Required-
Screen identifier
Return
string[] IDs of hidden meta boxes.
Source
File: wp-admin/includes/screen.php. View all references
function get_hidden_meta_boxes( $screen ) {
if ( is_string( $screen ) ) {
$screen = convert_to_screen( $screen );
}
$hidden = get_user_option( "metaboxhidden_{$screen->id}" );
$use_defaults = ! is_array( $hidden );
// Hide slug boxes by default.
if ( $use_defaults ) {
$hidden = array();
if ( 'post' === $screen->base ) {
if ( in_array( $screen->post_type, array( 'post', 'page', 'attachment' ), true ) ) {
$hidden = array( 'slugdiv', 'trackbacksdiv', 'postcustom', 'postexcerpt', 'commentstatusdiv', 'commentsdiv', 'authordiv', 'revisionsdiv' );
} else {
$hidden = array( 'slugdiv' );
}
}
/**
* Filters the default list of hidden meta boxes.
*
* @since 3.1.0
*
* @param string[] $hidden An array of IDs of meta boxes hidden by default.
* @param WP_Screen $screen WP_Screen object of the current screen.
*/
$hidden = apply_filters( 'default_hidden_meta_boxes', $hidden, $screen );
}
/**
* Filters the list of hidden meta boxes.
*
* @since 3.3.0
*
* @param string[] $hidden An array of IDs of hidden meta boxes.
* @param WP_Screen $screen WP_Screen object of the current screen.
* @param bool $use_defaults Whether to show the default meta boxes.
* Default true.
*/
return apply_filters( 'hidden_meta_boxes', $hidden, $screen, $use_defaults );
}
Hooks
- apply_filters( 'default_hidden_meta_boxes',
string[] $hidden ,WP_Screen $screen ) -
Filters the default list of hidden meta boxes.
- apply_filters( 'hidden_meta_boxes',
string[] $hidden ,WP_Screen $screen ,bool $use_defaults ) -
Filters the list of hidden meta boxes.
Related
Uses
| Uses | Description |
|---|---|
| convert_to_screen() wp-admin/includes/template.php | Converts a screen string to a screen object. |
| get_user_option() wp-includes/user.php | Retrieves user option that can be either per Site or per Network. |
| apply_filters() wp-includes/plugin.php | Calls the callback functions that have been added to a filter hook. |
Used By
| Used By | Description |
|---|---|
| meta_box_prefs() wp-admin/includes/screen.php | Prints the meta box preferences for screen meta. |
| do_meta_boxes() wp-admin/includes/template.php | Meta-Box template function. |
| do_accordion_sections() wp-admin/includes/template.php | Meta Box Accordion Template Function. |
| post_comment_meta_box() wp-admin/includes/meta-boxes.php | Displays comments for post. |
Changelog
| Version | Description |
|---|---|
| 2.7.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_hidden_meta_boxes