remove_meta_box( string $id, string|array|WP_Screen $screen, string $context )

Parameters

$idstring

Meta box ID (used in the 'id' attribute for the meta box).

$screenstring|array|WP_Screen

The screen or screens on which the meta box is shown (such as a post type, 'link', or 'comment'). Accepts a single screen ID, WP_Screen object, or array of screen IDs.

$contextstring

The context within the screen where the box is set to display. Contexts vary from screen to screen. Post edit screen contexts include 'normal', 'side', and 'advanced'. Comments screen contexts include 'normal' and 'side'. Menus meta boxes (accordion sections) all use the 'side' context.

Uses · 3

• get_current_screen()Get the current screen object
• convert_to_screen()Converts a screen string to a screen object.
• remove_meta_box()Removes a meta box from one or more screens.

Used by · 1

• remove_meta_box()Removes a meta box from one or more screens.

Source

View on Trac ↗View on GitHub ↗

1486function remove_meta_box( $id, $screen, $context ) {1487	global $wp_meta_boxes;1488 1489	if ( empty( $screen ) ) {1490		$screen = get_current_screen();1491	} elseif ( is_string( $screen ) ) {1492		$screen = convert_to_screen( $screen );1493	} elseif ( is_array( $screen ) ) {1494		foreach ( $screen as $single_screen ) {1495			remove_meta_box( $id, $single_screen, $context );1496		}1497	}1498 1499	if ( ! isset( $screen->id ) ) {1500		return;1501	}1502 1503	$page = $screen->id;1504 1505	if ( ! isset( $wp_meta_boxes ) ) {1506		$wp_meta_boxes = array();1507	}1508	if ( ! isset( $wp_meta_boxes[ $page ] ) ) {1509		$wp_meta_boxes[ $page ] = array();1510	}1511	if ( ! isset( $wp_meta_boxes[ $page ][ $context ] ) ) {1512		$wp_meta_boxes[ $page ][ $context ] = array();1513	}1514 1515	foreach ( array( 'high', 'core', 'default', 'low' ) as $priority ) {1516		$wp_meta_boxes[ $page ][ $context ][ $priority ][ $id ] = false;1517	}1518}

History

Introduced in 2.6.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 7.1.0 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.