get_hidden_meta_boxes( string|WP_Screen $screen ): string[]

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$screenstring|WP_Screen

Screen identifier

Return value

string[]

IDs of hidden meta boxes.

Performance profile

How much work a call to get_hidden_meta_boxes() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

19–38

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 39.

Plugin surface

2 hooks

Third-party callbacks on 'default_hidden_meta_boxes', 'hidden_meta_boxes' run inside this call, and their cost is not bounded by anything here.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_hidden_meta_boxes() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while get_hidden_meta_boxes() runs, in this order:

1. 1
   apply_filters( default_hidden_meta_boxes )filterline 181 (+29 into the body)

   Filters the default list of hidden meta boxes.

2. 2
   apply_filters( hidden_meta_boxes )filterline 194 (+42 into the body)

   Filters the list of hidden meta boxes.

Uses · 3

• convert_to_screen()Converts a screen string to a screen object.
• get_user_option()Retrieves user option that can be either per Site or per Network.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 4

• do_accordion_sections()Meta Box Accordion Template Function.
• do_meta_boxes()Meta-Box template function.
• meta_box_prefs()Prints the meta box preferences for screen meta.
• post_comment_meta_box()Displays comments for post.

Source code

View on Trac ↗View on GitHub ↗

152function get_hidden_meta_boxes( $screen ) {153	if ( is_string( $screen ) ) {154		$screen = convert_to_screen( $screen );155	}156 157	$hidden = get_user_option( "metaboxhidden_{$screen->id}" );158 159	$use_defaults = ! is_array( $hidden );160 161	// Hide slug boxes by default.162	if ( $use_defaults ) {163		$hidden = array();164 165		if ( 'post' === $screen->base ) {166			if ( in_array( $screen->post_type, array( 'post', 'page', 'attachment' ), true ) ) {167				$hidden = array( 'slugdiv', 'trackbacksdiv', 'postcustom', 'postexcerpt', 'commentstatusdiv', 'commentsdiv', 'authordiv', 'revisionsdiv' );168			} else {169				$hidden = array( 'slugdiv' );170			}171		}172 173		/**174		 * Filters the default list of hidden meta boxes.175		 *176		 * @since 3.1.0177		 *178		 * @param string[]  $hidden An array of IDs of meta boxes hidden by default.179		 * @param WP_Screen $screen WP_Screen object of the current screen.180		 */181		$hidden = apply_filters( 'default_hidden_meta_boxes', $hidden, $screen );182	}183 184	/**185	 * Filters the list of hidden meta boxes.186	 *187	 * @since 3.3.0188	 *189	 * @param string[]  $hidden       An array of IDs of hidden meta boxes.190	 * @param WP_Screen $screen       WP_Screen object of the current screen.191	 * @param bool      $use_defaults Whether to show the default meta boxes.192	 *                                Default true.193	 */194	return apply_filters( 'hidden_meta_boxes', $hidden, $screen, $use_defaults );195}

Changelog

Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-admin/includes/screen.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.