do_meta_boxes( string|WP_Screen $screen, string $context, mixed $data_object ): int

Parameters

$screenstring|WP_Screen

The screen identifier. If you have used add_menu_page() or add_submenu_page() to create a new screen (and hence screen_id) make sure your menu slug conforms to the limits of sanitize_key() otherwise the 'screen' menu may not correctly render on your page.

$contextstring

The screen context for which to display meta boxes.

$data_objectmixed

Gets passed to the meta box callback function as the first parameter. Often this is the object that's the focus of the current screen, for example a WP_Post or WP_Comment object.

Return

int

Number of meta_boxes.

Uses · 10

• get_current_screen()Get the current screen object
• convert_to_screen()Converts a screen string to a screen object.
• get_hidden_meta_boxes()Gets an array of IDs of hidden meta boxes.
• esc_attr()Escaping for HTML attributes.
• get_user_option()Retrieves user option that can be either per Site or per Network.
• add_meta_box()Adds a meta box to one or more screens.
• postbox_classes()Returns the list of classes to be used by a meta box.
• __()Retrieves the translation of $text.
• _get_plugin_from_callback()Internal helper function to find the plugin from a meta box callback.
• wp_admin_notice()Outputs an admin notice.

Used by · 2

• the_block_editor_meta_boxes()Renders the meta boxes forms.
• wp_dashboard()Displays the dashboard.

Source

View on Trac ↗View on GitHub ↗

1299function do_meta_boxes( $screen, $context, $data_object ) {1300	global $wp_meta_boxes;1301	static $already_sorted = false;1302 1303	if ( empty( $screen ) ) {1304		$screen = get_current_screen();1305	} elseif ( is_string( $screen ) ) {1306		$screen = convert_to_screen( $screen );1307	}1308 1309	$page = $screen->id;1310 1311	$hidden = get_hidden_meta_boxes( $screen );1312 1313	printf( '<div id="%s-sortables" class="meta-box-sortables">', esc_attr( $context ) );1314 1315	/*1316	 * Grab the ones the user has manually sorted.1317	 * Pull them out of their previous context/priority and into the one the user chose.1318	 */1319	$sorted = get_user_option( "meta-box-order_$page" );1320 1321	if ( ! $already_sorted && $sorted ) {1322		foreach ( $sorted as $box_context => $ids ) {1323			foreach ( explode( ',', $ids ) as $id ) {1324				if ( $id && 'dashboard_browser_nag' !== $id ) {1325					add_meta_box( $id, null, null, $screen, $box_context, 'sorted' );1326				}1327			}1328		}1329	}1330 1331	$already_sorted = true;1332 1333	$i = 0;1334 1335	if ( isset( $wp_meta_boxes[ $page ][ $context ] ) ) {1336		foreach ( array( 'high', 'sorted', 'core', 'default', 'low' ) as $priority ) {1337			if ( isset( $wp_meta_boxes[ $page ][ $context ][ $priority ] ) ) {1338				foreach ( (array) $wp_meta_boxes[ $page ][ $context ][ $priority ] as $box ) {1339					if ( false === $box || ! $box['title'] ) {1340						continue;1341					}1342 1343					$block_compatible = true;1344					if ( is_array( $box['args'] ) ) {1345						// If a meta box is just here for back compat, don't show it in the block editor.1346						if ( $screen->is_block_editor() && isset( $box['args']['__back_compat_meta_box'] ) && $box['args']['__back_compat_meta_box'] ) {1347							continue;1348						}1349 1350						if ( isset( $box['args']['__block_editor_compatible_meta_box'] ) ) {1351							$block_compatible = (bool) $box['args']['__block_editor_compatible_meta_box'];1352							unset( $box['args']['__block_editor_compatible_meta_box'] );1353						}1354 1355						// If the meta box is declared as incompatible with the block editor, override the callback function.1356						if ( ! $block_compatible && $screen->is_block_editor() ) {1357							$box['old_callback'] = $box['callback'];1358							$box['callback']     = 'do_block_editor_incompatible_meta_box';1359						}1360 1361						if ( isset( $box['args']['__back_compat_meta_box'] ) ) {1362							$block_compatible = $block_compatible || (bool) $box['args']['__back_compat_meta_box'];1363							unset( $box['args']['__back_compat_meta_box'] );1364						}1365					}1366 1367					++$i;1368					// get_hidden_meta_boxes() doesn't apply in the block editor.1369					$hidden_class = ( ! $screen->is_block_editor() && in_array( $box['id'], $hidden, true ) ) ? ' hide-if-js' : '';1370					echo '<div id="' . $box['id'] . '" class="postbox ' . postbox_classes( $box['id'], $page ) . $hidden_class . '" ' . '>' . "\n";1371 1372					echo '<div class="postbox-header">';1373					echo '<h2 class="hndle">';1374					if ( 'dashboard_php_nag' === $box['id'] ) {1375						echo '<span aria-hidden="true" class="dashicons dashicons-warning"></span>';1376						echo '<span class="screen-reader-text">' .1377							/* translators: Hidden accessibility text. */1378							__( 'Warning:' ) .

History

Introduced in 2.5.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/template.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.