On this page
wp_delete_nav_menu( int|string|WP_Term $menu ): bool|WP_Error
Deletes a navigation menu.
Parameters
$menuint|string|WP_Term Required-
Menu ID, slug, name, or object.
Return
bool|WP_Error True on success, false or WP_Error object on failure.
Source
File: wp-includes/nav-menu.php. View all references
function wp_delete_nav_menu( $menu ) {
$menu = wp_get_nav_menu_object( $menu );
if ( ! $menu ) {
return false;
}
$menu_objects = get_objects_in_term( $menu->term_id, 'nav_menu' );
if ( ! empty( $menu_objects ) ) {
foreach ( $menu_objects as $item ) {
wp_delete_post( $item );
}
}
$result = wp_delete_term( $menu->term_id, 'nav_menu' );
// Remove this menu from any locations.
$locations = get_nav_menu_locations();
foreach ( $locations as $location => $menu_id ) {
if ( $menu_id == $menu->term_id ) {
$locations[ $location ] = 0;
}
}
set_theme_mod( 'nav_menu_locations', $locations );
if ( $result && ! is_wp_error( $result ) ) {
/**
* Fires after a navigation menu has been successfully deleted.
*
* @since 3.0.0
*
* @param int $term_id ID of the deleted menu.
*/
do_action( 'wp_delete_nav_menu', $menu->term_id );
}
return $result;
}
Hooks
- do_action( 'wp_delete_nav_menu',
int $term_id ) -
Fires after a navigation menu has been successfully deleted.
Related
Uses
| Uses | Description |
|---|---|
| set_theme_mod() wp-includes/theme.php | Updates theme modification value for the active theme. |
| wp_delete_term() wp-includes/taxonomy.php | Removes a term from the database. |
| get_objects_in_term() wp-includes/taxonomy.php | Retrieves object IDs of valid taxonomy and term. |
| wp_delete_post() wp-includes/post.php | Trashes or deletes a post or page. |
| wp_get_nav_menu_object() wp-includes/nav-menu.php | Returns a navigation menu object. |
| get_nav_menu_locations() wp-includes/nav-menu.php | Retrieves all registered navigation menu locations and the menus assigned to them. |
| do_action() wp-includes/plugin.php | Calls the callback functions that have been added to an action hook. |
| is_wp_error() wp-includes/load.php | Checks whether the given variable is a WordPress Error. |
Used By
| Used By | Description |
|---|---|
| WP_REST_Menus_Controller::delete_item() wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php | Deletes a single term from a taxonomy. |
| WP_Customize_Nav_Menu_Setting::update() wp-includes/customize/class-wp-customize-nav-menu-setting.php | Create/update the nav_menu term for this setting. |
Changelog
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_delete_nav_menu