add_meta_box( string $id, string $title, callable $callback, string|array|WP_Screen $screen = null, string $context = 'advanced', string $priority = 'default', array $callback_args = null )

Parameters

$idstring

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

$titlestring

Title of the meta box.

$callbackcallable

Function that fills the box with the desired content. The function should echo its output.

$screenstring|array|WP_Screenoptional

The screen or screens on which to show the box (such as a post type, 'link', or 'comment'). Accepts a single screen ID, WP_Screen object, or array of screen IDs. Default is the current screen. 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.Default: null

$contextstringoptional

The context within the screen where the box should display. Available 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. Global default is 'advanced'.Default: 'advanced'

$prioritystringoptional

The priority within the context where the box should show. Accepts 'high', 'core', 'default', or 'low'. Default 'default'.Default: 'default'

$callback_argsarrayoptional

Data that should be set as the $args property of the box array (which is the second parameter passed to your callback). Default null.Default: null

Uses · 3

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

Used by · 7

• add_meta_box()Adds a meta box to one or more screens.
• do_meta_boxes()Meta-Box template function.
• register_and_do_post_meta_boxes()Registers the default post meta boxes, and runs the `do_meta_boxes` actions.
• wp_add_dashboard_widget()Adds a new dashboard widget.
• wp_nav_menu_post_type_meta_boxes()Creates meta boxes for any post type menu item.
• wp_nav_menu_setup()Register nav menu meta boxes and advanced menu items.
• wp_nav_menu_taxonomy_meta_boxes()Creates meta boxes for any taxonomy menu item.

Source

View on Trac ↗View on GitHub ↗

1082function add_meta_box( $id, $title, $callback, $screen = null, $context = 'advanced', $priority = 'default', $callback_args = null ) {1083	global $wp_meta_boxes;1084 1085	if ( empty( $screen ) ) {1086		$screen = get_current_screen();1087	} elseif ( is_string( $screen ) ) {1088		$screen = convert_to_screen( $screen );1089	} elseif ( is_array( $screen ) ) {1090		foreach ( $screen as $single_screen ) {1091			add_meta_box( $id, $title, $callback, $single_screen, $context, $priority, $callback_args );1092		}1093	}1094 1095	if ( ! isset( $screen->id ) ) {1096		return;1097	}1098 1099	$page = $screen->id;1100 1101	if ( ! isset( $wp_meta_boxes ) ) {1102		$wp_meta_boxes = array();1103	}1104	if ( ! isset( $wp_meta_boxes[ $page ] ) ) {1105		$wp_meta_boxes[ $page ] = array();1106	}1107	if ( ! isset( $wp_meta_boxes[ $page ][ $context ] ) ) {1108		$wp_meta_boxes[ $page ][ $context ] = array();1109	}1110 1111	foreach ( array_keys( $wp_meta_boxes[ $page ] ) as $a_context ) {1112		foreach ( array( 'high', 'core', 'default', 'low' ) as $a_priority ) {1113			if ( ! isset( $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ] ) ) {1114				continue;1115			}1116 1117			// If a core box was previously removed, don't add.1118			if ( ( 'core' === $priority || 'sorted' === $priority )1119				&& false === $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ]1120			) {1121				return;1122			}1123 1124			// If a core box was previously added by a plugin, don't add.1125			if ( 'core' === $priority ) {1126				/*1127				 * If the box was added with default priority, give it core priority1128				 * to maintain sort order.1129				 */1130				if ( 'default' === $a_priority ) {1131					$wp_meta_boxes[ $page ][ $a_context ]['core'][ $id ] = $wp_meta_boxes[ $page ][ $a_context ]['default'][ $id ];1132					unset( $wp_meta_boxes[ $page ][ $a_context ]['default'][ $id ] );1133				}1134				return;1135			}1136 1137			// If no priority given and ID already present, use existing priority.1138			if ( empty( $priority ) ) {1139				$priority = $a_priority;1140				/*1141				 * Else, if we're adding to the sorted priority, we don't know the title1142				 * or callback. Grab them from the previously added context/priority.1143				 */1144			} elseif ( 'sorted' === $priority ) {1145				$title         = $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ]['title'];1146				$callback      = $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ]['callback'];1147				$callback_args = $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ]['args'];1148			}1149 1150			// An ID can be in only one priority and one context.1151			if ( $priority !== $a_priority || $context !== $a_context ) {1152				unset( $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ] );1153			}1154		}1155	}1156 1157	if ( empty( $priority ) ) {1158		$priority = 'low';1159	}1160 1161	if ( ! isset( $wp_meta_boxes[ $page ][ $context ][ $priority ] ) ) {

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 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.