| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Navigation Menu functions 4 * 5 * @package WordPress 6 * @subpackage Nav_Menus 7 * @since 3.0.0 8 */ 9 10 /** 11 * Returns a navigation menu object. 12 * 13 * @since 3.0.0 14 * 15 * @param int|string|WP_Term $menu Menu ID, slug, name, or object. 16 * @return WP_Term|false Menu object on success, false if $menu param isn't supplied or term does not exist. 17 */ 18 function wp_get_nav_menu_object( $menu ) { 19 $menu_obj = false; 20 21 if ( is_object( $menu ) ) { 22 $menu_obj = $menu; 23 } 24 25 if ( $menu && ! $menu_obj ) { 26 $menu_obj = get_term( $menu, 'nav_menu' ); 27 28 if ( ! $menu_obj ) { 29 $menu_obj = get_term_by( 'slug', $menu, 'nav_menu' ); 30 } 31 32 if ( ! $menu_obj ) { 33 $menu_obj = get_term_by( 'name', $menu, 'nav_menu' ); 34 } 35 } 36 37 if ( ! $menu_obj || is_wp_error( $menu_obj ) ) { 38 $menu_obj = false; 39 } 40 41 /** 42 * Filters the nav_menu term retrieved for wp_get_nav_menu_object(). 43 * 44 * @since 4.3.0 45 * 46 * @param WP_Term|false $menu_obj Term from nav_menu taxonomy, or false if nothing had been found. 47 * @param int|string|WP_Term $menu The menu ID, slug, name, or object passed to wp_get_nav_menu_object(). 48 */ 49 return apply_filters( 'wp_get_nav_menu_object', $menu_obj, $menu ); 50 } 51 52 /** 53 * Determines whether the given ID is a navigation menu. 54 * 55 * Returns true if it is; false otherwise. 56 * 57 * @since 3.0.0 58 * 59 * @param int|string|WP_Term $menu Menu ID, slug, name, or object of menu to check. 60 * @return bool Whether the menu exists. 61 */ 62 function is_nav_menu( $menu ) { 63 if ( ! $menu ) { 64 return false; 65 } 66 67 $menu_obj = wp_get_nav_menu_object( $menu ); 68 69 if ( 70 $menu_obj && 71 ! is_wp_error( $menu_obj ) && 72 ! empty( $menu_obj->taxonomy ) && 73 'nav_menu' === $menu_obj->taxonomy 74 ) { 75 return true; 76 } 77 78 return false; 79 } 80 81 /** 82 * Registers navigation menu locations for a theme. 83 * 84 * @since 3.0.0 85 * 86 * @global array $_wp_registered_nav_menus 87 * 88 * @param string[] $locations Associative array of menu location identifiers (like a slug) and descriptive text. 89 */ 90 function register_nav_menus( $locations = array() ) { 91 global $_wp_registered_nav_menus; 92 93 add_theme_support( 'menus' ); 94 95 foreach ( $locations as $key => $value ) { 96 if ( is_int( $key ) ) { 97 _doing_it_wrong( __FUNCTION__, __( 'Nav menu locations must be strings.' ), '5.3.0' ); 98 break; 99 } 100 } 101 102 $_wp_registered_nav_menus = array_merge( (array) $_wp_registered_nav_menus, $locations ); 103 } 104 105 /** 106 * Unregisters a navigation menu location for a theme. 107 * 108 * @since 3.1.0 109 * 110 * @global array $_wp_registered_nav_menus 111 * 112 * @param string $location The menu location identifier. 113 * @return bool True on success, false on failure. 114 */ 115 function unregister_nav_menu( $location ) { 116 global $_wp_registered_nav_menus; 117 118 if ( is_array( $_wp_registered_nav_menus ) && isset( $_wp_registered_nav_menus[ $location ] ) ) { 119 unset( $_wp_registered_nav_menus[ $location ] ); 120 if ( empty( $_wp_registered_nav_menus ) ) { 121 _remove_theme_support( 'menus' ); 122 } 123 return true; 124 } 125 return false; 126 } 127 128 /** 129 * Registers a navigation menu location for a theme. 130 * 131 * @since 3.0.0 132 * 133 * @param string $location Menu location identifier, like a slug. 134 * @param string $description Menu location descriptive text. 135 */ 136 function register_nav_menu( $location, $description ) { 137 register_nav_menus( array( $location => $description ) ); 138 } 139 /** 140 * Retrieves all registered navigation menu locations in a theme. 141 * 142 * @since 3.0.0 143 * 144 * @global array $_wp_registered_nav_menus 145 * 146 * @return string[] Associative array of registered navigation menu descriptions keyed 147 * by their location. If none are registered, an empty array. 148 */ 149 function get_registered_nav_menus() { 150 global $_wp_registered_nav_menus; 151 if ( isset( $_wp_registered_nav_menus ) ) { 152 return $_wp_registered_nav_menus; 153 } 154 return array(); 155 } 156 157 /** 158 * Retrieves all registered navigation menu locations and the menus assigned to them. 159 * 160 * @since 3.0.0 161 * 162 * @return int[] Associative array of registered navigation menu IDs keyed by their 163 * location name. If none are registered, an empty array. 164 */ 165 function get_nav_menu_locations() { 166 $locations = get_theme_mod( 'nav_menu_locations' ); 167 return ( is_array( $locations ) ) ? $locations : array(); 168 } 169 170 /** 171 * Determines whether a registered nav menu location has a menu assigned to it. 172 * 173 * @since 3.0.0 174 * 175 * @param string $location Menu location identifier. 176 * @return bool Whether location has a menu. 177 */ 178 function has_nav_menu( $location ) { 179 $has_nav_menu = false; 180 181 $registered_nav_menus = get_registered_nav_menus(); 182 if ( isset( $registered_nav_menus[ $location ] ) ) { 183 $locations = get_nav_menu_locations(); 184 $has_nav_menu = ! empty( $locations[ $location ] ); 185 } 186 187 /** 188 * Filters whether a nav menu is assigned to the specified location. 189 * 190 * @since 4.3.0 191 * 192 * @param bool $has_nav_menu Whether there is a menu assigned to a location. 193 * @param string $location Menu location. 194 */ 195 return apply_filters( 'has_nav_menu', $has_nav_menu, $location ); 196 } 197 198 /** 199 * Returns the name of a navigation menu. 200 * 201 * @since 4.9.0 202 * 203 * @param string $location Menu location identifier. 204 * @return string Menu name. 205 */ 206 function wp_get_nav_menu_name( $location ) { 207 $menu_name = ''; 208 209 $locations = get_nav_menu_locations(); 210 211 if ( isset( $locations[ $location ] ) ) { 212 $menu = wp_get_nav_menu_object( $locations[ $location ] ); 213 214 if ( $menu && $menu->name ) { 215 $menu_name = $menu->name; 216 } 217 } 218 219 /** 220 * Filters the navigation menu name being returned. 221 * 222 * @since 4.9.0 223 * 224 * @param string $menu_name Menu name. 225 * @param string $location Menu location identifier. 226 */ 227 return apply_filters( 'wp_get_nav_menu_name', $menu_name, $location ); 228 } 229 230 /** 231 * Determines whether the given ID is a nav menu item. 232 * 233 * @since 3.0.0 234 * 235 * @param int $menu_item_id The ID of the potential nav menu item. 236 * @return bool Whether the given ID is that of a nav menu item. 237 */ 238 function is_nav_menu_item( $menu_item_id = 0 ) { 239 return ( ! is_wp_error( $menu_item_id ) && ( 'nav_menu_item' === get_post_type( $menu_item_id ) ) ); 240 } 241 242 /** 243 * Creates a navigation menu. 244 * 245 * Note that `$menu_name` is expected to be pre-slashed. 246 * 247 * @since 3.0.0 248 * 249 * @param string $menu_name Menu name. 250 * @return int|WP_Error Menu ID on success, WP_Error object on failure. 251 */ 252 function wp_create_nav_menu( $menu_name ) { 253 // expected_slashed ($menu_name) 254 return wp_update_nav_menu_object( 0, array( 'menu-name' => $menu_name ) ); 255 } 256 257 /** 258 * Deletes a navigation menu. 259 * 260 * @since 3.0.0 261 * 262 * @param int|string|WP_Term $menu Menu ID, slug, name, or object. 263 * @return bool|WP_Error True on success, false or WP_Error object on failure. 264 */ 265 function wp_delete_nav_menu( $menu ) { 266 $menu = wp_get_nav_menu_object( $menu ); 267 if ( ! $menu ) { 268 return false; 269 } 270 271 $menu_objects = get_objects_in_term( $menu->term_id, 'nav_menu' ); 272 if ( ! empty( $menu_objects ) ) { 273 foreach ( $menu_objects as $item ) { 274 wp_delete_post( $item ); 275 } 276 } 277 278 $result = wp_delete_term( $menu->term_id, 'nav_menu' ); 279 280 // Remove this menu from any locations. 281 $locations = get_nav_menu_locations(); 282 foreach ( $locations as $location => $menu_id ) { 283 if ( $menu_id === $menu->term_id ) { 284 $locations[ $location ] = 0; 285 } 286 } 287 set_theme_mod( 'nav_menu_locations', $locations ); 288 289 if ( $result && ! is_wp_error( $result ) ) { 290 291 /** 292 * Fires after a navigation menu has been successfully deleted. 293 * 294 * @since 3.0.0 295 * 296 * @param int $term_id ID of the deleted menu. 297 */ 298 do_action( 'wp_delete_nav_menu', $menu->term_id ); 299 } 300 301 return $result; 302 } 303 304 /** 305 * Saves the properties of a menu or create a new menu with those properties. 306 * 307 * Note that `$menu_data` is expected to be pre-slashed. 308 * 309 * @since 3.0.0 310 * 311 * @param int $menu_id The ID of the menu or "0" to create a new menu. 312 * @param array $menu_data The array of menu data. 313 * @return int|WP_Error Menu ID on success, WP_Error object on failure. 314 */ 315 function wp_update_nav_menu_object( $menu_id = 0, $menu_data = array() ) { 316 // expected_slashed ($menu_data) 317 $menu_id = (int) $menu_id; 318 319 $_menu = wp_get_nav_menu_object( $menu_id ); 320 321 $args = array( 322 'description' => ( isset( $menu_data['description'] ) ? $menu_data['description'] : '' ), 323 'name' => ( isset( $menu_data['menu-name'] ) ? $menu_data['menu-name'] : '' ), 324 'parent' => ( isset( $menu_data['parent'] ) ? (int) $menu_data['parent'] : 0 ), 325 'slug' => null, 326 ); 327 328 // Double-check that we're not going to have one menu take the name of another. 329 $_possible_existing = get_term_by( 'name', $menu_data['menu-name'], 'nav_menu' ); 330 if ( 331 $_possible_existing && 332 ! is_wp_error( $_possible_existing ) && 333 isset( $_possible_existing->term_id ) && 334 $_possible_existing->term_id !== $menu_id 335 ) { 336 return new WP_Error( 337 'menu_exists', 338 sprintf( 339 /* translators: %s: Menu name. */ 340 __( 'The menu name %s conflicts with another menu name. Please try another.' ), 341 '<strong>' . esc_html( $menu_data['menu-name'] ) . '</strong>' 342 ) 343 ); 344 } 345 346 // Menu doesn't already exist, so create a new menu. 347 if ( ! $_menu || is_wp_error( $_menu ) ) { 348 $menu_exists = get_term_by( 'name', $menu_data['menu-name'], 'nav_menu' ); 349 350 if ( $menu_exists ) { 351 return new WP_Error( 352 'menu_exists', 353 sprintf( 354 /* translators: %s: Menu name. */ 355 __( 'The menu name %s conflicts with another menu name. Please try another.' ), 356 '<strong>' . esc_html( $menu_data['menu-name'] ) . '</strong>' 357 ) 358 ); 359 } 360 361 $_menu = wp_insert_term( $menu_data['menu-name'], 'nav_menu', $args ); 362 363 if ( is_wp_error( $_menu ) ) { 364 return $_menu; 365 } 366 367 /** 368 * Fires after a navigation menu is successfully created. 369 * 370 * @since 3.0.0 371 * 372 * @param int $term_id ID of the new menu. 373 * @param array $menu_data An array of menu data. 374 */ 375 do_action( 'wp_create_nav_menu', $_menu['term_id'], $menu_data ); 376 377 return (int) $_menu['term_id']; 378 } 379 380 if ( ! $_menu || ! isset( $_menu->term_id ) ) { 381 return 0; 382 } 383 384 $menu_id = (int) $_menu->term_id; 385 386 $update_response = wp_update_term( $menu_id, 'nav_menu', $args ); 387 388 if ( is_wp_error( $update_response ) ) { 389 return $update_response; 390 } 391 392 $menu_id = (int) $update_response['term_id']; 393 394 /** 395 * Fires after a navigation menu has been successfully updated. 396 * 397 * @since 3.0.0 398 * 399 * @param int $menu_id ID of the updated menu. 400 * @param array $menu_data An array of menu data. 401 */ 402 do_action( 'wp_update_nav_menu', $menu_id, $menu_data ); 403 return $menu_id; 404 } 405 406 /** 407 * Saves the properties of a menu item or create a new one. 408 * 409 * The menu-item-title, menu-item-description and menu-item-attr-title are expected 410 * to be pre-slashed since they are passed directly to APIs that expect slashed data. 411 * 412 * @since 3.0.0 413 * @since 5.9.0 Added the `$fire_after_hooks` parameter. 414 * 415 * @param int $menu_id The ID of the menu. If 0, makes the menu item a draft orphan. 416 * @param int $menu_item_db_id The ID of the menu item. If 0, creates a new menu item. 417 * @param array $menu_item_data The menu item's data. 418 * @param bool $fire_after_hooks Whether to fire the after insert hooks. Default true. 419 * @return int|WP_Error The menu item's database ID or WP_Error object on failure. 420 */ 421 function wp_update_nav_menu_item( $menu_id = 0, $menu_item_db_id = 0, $menu_item_data = array(), $fire_after_hooks = true ) { 422 $menu_id = (int) $menu_id; 423 $menu_item_db_id = (int) $menu_item_db_id; 424 425 // Make sure that we don't convert non-nav_menu_item objects into nav_menu_item objects. 426 if ( ! empty( $menu_item_db_id ) && ! is_nav_menu_item( $menu_item_db_id ) ) { 427 return new WP_Error( 'update_nav_menu_item_failed', __( 'The given object ID is not that of a menu item.' ) ); 428 } 429 430 $menu = wp_get_nav_menu_object( $menu_id ); 431 432 if ( ! $menu && 0 !== $menu_id ) { 433 return new WP_Error( 'invalid_menu_id', __( 'Invalid menu ID.' ) ); 434 } 435 436 if ( is_wp_error( $menu ) ) { 437 return $menu; 438 } 439 440 $defaults = array( 441 'menu-item-db-id' => $menu_item_db_id, 442 'menu-item-object-id' => 0, 443 'menu-item-object' => '', 444 'menu-item-parent-id' => 0, 445 'menu-item-position' => 0, 446 'menu-item-type' => 'custom', 447 'menu-item-title' => '', 448 'menu-item-url' => '', 449 'menu-item-description' => '', 450 'menu-item-attr-title' => '', 451 'menu-item-target' => '', 452 'menu-item-classes' => '', 453 'menu-item-xfn' => '', 454 'menu-item-status' => '', 455 'menu-item-post-date' => '', 456 'menu-item-post-date-gmt' => '', 457 ); 458 459 $args = wp_parse_args( $menu_item_data, $defaults ); 460 461 if ( 0 === $menu_id ) { 462 $args['menu-item-position'] = 1; 463 } elseif ( 0 === (int) $args['menu-item-position'] ) { 464 $menu_items = array(); 465 466 if ( 0 !== $menu_id ) { 467 $menu_items = (array) wp_get_nav_menu_items( $menu_id, array( 'post_status' => 'publish,draft' ) ); 468 } 469 470 $last_item = array_pop( $menu_items ); 471 472 if ( $last_item && isset( $last_item->menu_order ) ) { 473 $args['menu-item-position'] = 1 + $last_item->menu_order; 474 } else { 475 $args['menu-item-position'] = count( $menu_items ); 476 } 477 } 478 479 $original_parent = 0 < $menu_item_db_id ? get_post_field( 'post_parent', $menu_item_db_id ) : 0; 480 481 if ( 'custom' === $args['menu-item-type'] ) { 482 // If custom menu item, trim the URL. 483 $args['menu-item-url'] = trim( $args['menu-item-url'] ); 484 } else { 485 /* 486 * If non-custom menu item, then: 487 * - use the original object's URL. 488 * - blank default title to sync with the original object's title. 489 */ 490 491 $args['menu-item-url'] = ''; 492 493 $original_title = ''; 494 if ( 'taxonomy' === $args['menu-item-type'] ) { 495 $original_parent = get_term_field( 'parent', $args['menu-item-object-id'], $args['menu-item-object'], 'raw' ); 496 $original_title = get_term_field( 'name', $args['menu-item-object-id'], $args['menu-item-object'], 'raw' ); 497 } elseif ( 'post_type' === $args['menu-item-type'] ) { 498 499 $original_object = get_post( $args['menu-item-object-id'] ); 500 $original_parent = (int) $original_object->post_parent; 501 $original_title = $original_object->post_title; 502 } elseif ( 'post_type_archive' === $args['menu-item-type'] ) { 503 $original_object = get_post_type_object( $args['menu-item-object'] ); 504 if ( $original_object ) { 505 $original_title = $original_object->labels->archives; 506 } 507 } 508 509 if ( wp_unslash( $args['menu-item-title'] ) === wp_specialchars_decode( $original_title ) ) { 510 $args['menu-item-title'] = ''; 511 } 512 513 // Hack to get wp to create a post object when too many properties are empty. 514 if ( '' === $args['menu-item-title'] && '' === $args['menu-item-description'] ) { 515 $args['menu-item-description'] = ' '; 516 } 517 } 518 519 // Populate the menu item object. 520 $post = array( 521 'menu_order' => $args['menu-item-position'], 522 'ping_status' => 0, 523 'post_content' => $args['menu-item-description'], 524 'post_excerpt' => $args['menu-item-attr-title'], 525 'post_parent' => $original_parent, 526 'post_title' => $args['menu-item-title'], 527 'post_type' => 'nav_menu_item', 528 ); 529 530 $post_date = wp_resolve_post_date( $args['menu-item-post-date'], $args['menu-item-post-date-gmt'] ); 531 if ( $post_date ) { 532 $post['post_date'] = $post_date; 533 } 534 535 $update = 0 !== $menu_item_db_id; 536 537 // New menu item. Default is draft status. 538 if ( ! $update ) { 539 $post['ID'] = 0; 540 $post['post_status'] = 'publish' === $args['menu-item-status'] ? 'publish' : 'draft'; 541 $menu_item_db_id = wp_insert_post( $post, true, $fire_after_hooks ); 542 if ( ! $menu_item_db_id || is_wp_error( $menu_item_db_id ) ) { 543 return $menu_item_db_id; 544 } 545 546 /** 547 * Fires immediately after a new navigation menu item has been added. 548 * 549 * @since 4.4.0 550 * 551 * @see wp_update_nav_menu_item() 552 * 553 * @param int $menu_id ID of the updated menu. 554 * @param int $menu_item_db_id ID of the new menu item. 555 * @param array $args An array of arguments used to update/add the menu item. 556 */ 557 do_action( 'wp_add_nav_menu_item', $menu_id, $menu_item_db_id, $args ); 558 } 559 560 /* 561 * Associate the menu item with the menu term. 562 * Only set the menu term if it isn't set to avoid unnecessary wp_get_object_terms(). 563 */ 564 if ( $menu_id && ( ! $update || ! is_object_in_term( $menu_item_db_id, 'nav_menu', (int) $menu->term_id ) ) ) { 565 $update_terms = wp_set_object_terms( $menu_item_db_id, array( $menu->term_id ), 'nav_menu' ); 566 if ( is_wp_error( $update_terms ) ) { 567 return $update_terms; 568 } 569 } 570 571 if ( 'custom' === $args['menu-item-type'] ) { 572 $args['menu-item-object-id'] = $menu_item_db_id; 573 $args['menu-item-object'] = 'custom'; 574 } 575 576 $menu_item_db_id = (int) $menu_item_db_id; 577 578 // Reset invalid `menu_item_parent`. 579 if ( (int) $args['menu-item-parent-id'] === $menu_item_db_id ) { 580 $args['menu-item-parent-id'] = 0; 581 } 582 583 update_post_meta( $menu_item_db_id, '_menu_item_type', sanitize_key( $args['menu-item-type'] ) ); 584 update_post_meta( $menu_item_db_id, '_menu_item_menu_item_parent', (string) ( (int) $args['menu-item-parent-id'] ) ); 585 update_post_meta( $menu_item_db_id, '_menu_item_object_id', (string) ( (int) $args['menu-item-object-id'] ) ); 586 update_post_meta( $menu_item_db_id, '_menu_item_object', sanitize_key( $args['menu-item-object'] ) ); 587 update_post_meta( $menu_item_db_id, '_menu_item_target', sanitize_key( $args['menu-item-target'] ) ); 588 589 $args['menu-item-classes'] = array_map( 'sanitize_html_class', explode( ' ', $args['menu-item-classes'] ) ); 590 $args['menu-item-xfn'] = implode( ' ', array_map( 'sanitize_html_class', explode( ' ', $args['menu-item-xfn'] ) ) ); 591 update_post_meta( $menu_item_db_id, '_menu_item_classes', $args['menu-item-classes'] ); 592 update_post_meta( $menu_item_db_id, '_menu_item_xfn', $args['menu-item-xfn'] ); 593 update_post_meta( $menu_item_db_id, '_menu_item_url', sanitize_url( $args['menu-item-url'] ) ); 594 595 if ( 0 === $menu_id ) { 596 update_post_meta( $menu_item_db_id, '_menu_item_orphaned', (string) time() ); 597 } elseif ( get_post_meta( $menu_item_db_id, '_menu_item_orphaned' ) ) { 598 delete_post_meta( $menu_item_db_id, '_menu_item_orphaned' ); 599 } 600 601 // Update existing menu item. Default is publish status. 602 if ( $update ) { 603 $post['ID'] = $menu_item_db_id; 604 $post['post_status'] = ( 'draft' === $args['menu-item-status'] ) ? 'draft' : 'publish'; 605 606 $update_post = wp_update_post( $post, true ); 607 if ( is_wp_error( $update_post ) ) { 608 return $update_post; 609 } 610 } 611 612 /** 613 * Fires after a navigation menu item has been updated. 614 * 615 * @since 3.0.0 616 * 617 * @see wp_update_nav_menu_item() 618 * 619 * @param int $menu_id ID of the updated menu. 620 * @param int $menu_item_db_id ID of the updated menu item. 621 * @param array $args An array of arguments used to update a menu item. 622 */ 623 do_action( 'wp_update_nav_menu_item', $menu_id, $menu_item_db_id, $args ); 624 625 return $menu_item_db_id; 626 } 627 628 /** 629 * Returns all navigation menu objects. 630 * 631 * @since 3.0.0 632 * @since 4.1.0 Default value of the 'orderby' argument was changed from 'none' 633 * to 'name'. 634 * 635 * @param array $args Optional. Array of arguments passed on to get_terms(). 636 * Default empty array. 637 * @return WP_Term[] An array of menu objects. 638 */ 639 function wp_get_nav_menus( $args = array() ) { 640 $defaults = array( 641 'taxonomy' => 'nav_menu', 642 'hide_empty' => false, 643 'orderby' => 'name', 644 ); 645 $args = wp_parse_args( $args, $defaults ); 646 647 /** 648 * Filters the navigation menu objects being returned. 649 * 650 * @since 3.0.0 651 * 652 * @see get_terms() 653 * 654 * @param WP_Term[] $menus An array of menu objects. 655 * @param array $args An array of arguments used to retrieve menu objects. 656 */ 657 return apply_filters( 'wp_get_nav_menus', get_terms( $args ), $args ); 658 } 659 660 /** 661 * Determines whether a menu item is valid. 662 * 663 * @link https://core.trac.wordpress.org/ticket/13958 664 * 665 * @since 3.2.0 666 * @access private 667 * 668 * @param object $item The menu item to check. 669 * @return bool False if invalid, otherwise true. 670 */ 671 function _is_valid_nav_menu_item( $item ) { 672 return empty( $item->_invalid ); 673 } 674 675 /** 676 * Retrieves all menu items of a navigation menu. 677 * 678 * Note: Most arguments passed to the `$args` parameter – save for 'output_key' – are 679 * specifically for retrieving nav_menu_item posts from get_posts() and may only 680 * indirectly affect the ultimate ordering and content of the resulting nav menu 681 * items that get returned from this function. 682 * 683 * @since 3.0.0 684 * 685 * @param int|string|WP_Term $menu Menu ID, slug, name, or object. 686 * @param array $args { 687 * Optional. Arguments to pass to get_posts(). 688 * 689 * @type string $order How to order nav menu items as queried with get_posts(). 690 * Will be ignored if 'output' is ARRAY_A. Default 'ASC'. 691 * @type string $orderby Field to order menu items by as retrieved from get_posts(). 692 * Supply an orderby field via 'output_key' to affect the 693 * output order of nav menu items. Default 'menu_order'. 694 * @type string $post_type Menu items post type. Default 'nav_menu_item'. 695 * @type string $post_status Menu items post status. Default 'publish'. 696 * @type string $output How to order outputted menu items. Default ARRAY_A. 697 * @type string $output_key Key to use for ordering the actual menu items that get 698 * returned. Note that that is not a get_posts() argument 699 * and will only affect output of menu items processed in 700 * this function. Default 'menu_order'. 701 * @type bool $nopaging Whether to retrieve all menu items (true) or paginate 702 * (false). Default true. 703 * @type bool $update_menu_item_cache Whether to update the menu item cache. Default true. 704 * } 705 * @return array|false Array of menu items, otherwise false. 706 */ 707 function wp_get_nav_menu_items( $menu, $args = array() ) { 708 $menu = wp_get_nav_menu_object( $menu ); 709 710 if ( ! $menu ) { 711 return false; 712 } 713 714 if ( ! taxonomy_exists( 'nav_menu' ) ) { 715 return false; 716 } 717 718 $defaults = array( 719 'order' => 'ASC', 720 'orderby' => 'menu_order', 721 'post_type' => 'nav_menu_item', 722 'post_status' => 'publish', 723 'output' => ARRAY_A, 724 'output_key' => 'menu_order', 725 'nopaging' => true, 726 'update_menu_item_cache' => true, 727 'tax_query' => array( 728 array( 729 'taxonomy' => 'nav_menu', 730 'field' => 'term_taxonomy_id', 731 'terms' => $menu->term_taxonomy_id, 732 ), 733 ), 734 ); 735 $args = wp_parse_args( $args, $defaults ); 736 if ( $menu->count > 0 ) { 737 $items = get_posts( $args ); 738 } else { 739 $items = array(); 740 } 741 742 $items = array_map( 'wp_setup_nav_menu_item', $items ); 743 744 if ( ! is_admin() ) { // Remove invalid items only on front end. 745 $items = array_filter( $items, '_is_valid_nav_menu_item' ); 746 } 747 748 if ( ARRAY_A === $args['output'] ) { 749 $items = wp_list_sort( 750 $items, 751 array( 752 $args['output_key'] => 'ASC', 753 ) 754 ); 755 756 $i = 1; 757 758 foreach ( $items as $k => $item ) { 759 $items[ $k ]->{$args['output_key']} = $i++; 760 } 761 } 762 763 /** 764 * Filters the navigation menu items being returned. 765 * 766 * @since 3.0.0 767 * 768 * @param array $items An array of menu item post objects. 769 * @param object $menu The menu object. 770 * @param array $args An array of arguments used to retrieve menu item objects. 771 */ 772 return apply_filters( 'wp_get_nav_menu_items', $items, $menu, $args ); 773 } 774 775 /** 776 * Updates post and term caches for all linked objects for a list of menu items. 777 * 778 * @since 6.1.0 779 * 780 * @param WP_Post[] $menu_items Array of menu item post objects. 781 */ 782 function update_menu_item_cache( $menu_items ) { 783 $post_ids = array(); 784 $term_ids = array(); 785 786 foreach ( $menu_items as $menu_item ) { 787 if ( 'nav_menu_item' !== $menu_item->post_type ) { 788 continue; 789 } 790 791 $object_id = get_post_meta( $menu_item->ID, '_menu_item_object_id', true ); 792 $type = get_post_meta( $menu_item->ID, '_menu_item_type', true ); 793 794 if ( 'post_type' === $type ) { 795 $post_ids[] = (int) $object_id; 796 } elseif ( 'taxonomy' === $type ) { 797 $term_ids[] = (int) $object_id; 798 } 799 } 800 801 if ( ! empty( $post_ids ) ) { 802 _prime_post_caches( $post_ids, false ); 803 } 804 805 if ( ! empty( $term_ids ) ) { 806 _prime_term_caches( $term_ids ); 807 } 808 } 809 810 /** 811 * Decorates a menu item object with the shared navigation menu item properties. 812 * 813 * Properties: 814 * - ID: The term_id if the menu item represents a taxonomy term. 815 * - attr_title: The title attribute of the link element for this menu item. 816 * - classes: The array of class attribute values for the link element of this menu item. 817 * - db_id: The DB ID of this item as a nav_menu_item object, if it exists (0 if it doesn't exist). 818 * - description: The description of this menu item. 819 * - menu_item_parent: The DB ID of the nav_menu_item that is this item's menu parent, if any. 0 otherwise. 820 * - object: The type of object originally represented, such as 'category', 'post', or 'attachment'. 821 * - object_id: The DB ID of the original object this menu item represents, e.g. ID for posts and term_id for categories. 822 * - post_parent: The DB ID of the original object's parent object, if any (0 otherwise). 823 * - post_title: A "no title" label if menu item represents a post that lacks a title. 824 * - target: The target attribute of the link element for this menu item. 825 * - title: The title of this menu item. 826 * - type: The family of objects originally represented, such as 'post_type' or 'taxonomy'. 827 * - type_label: The singular label used to describe this type of menu item. 828 * - url: The URL to which this menu item points. 829 * - xfn: The XFN relationship expressed in the link of this menu item. 830 * - _invalid: Whether the menu item represents an object that no longer exists. 831 * 832 * @since 3.0.0 833 * 834 * @param object $menu_item The menu item to modify. 835 * @return object The menu item with standard menu item properties. 836 */ 837 function wp_setup_nav_menu_item( $menu_item ) { 838 839 /** 840 * Filters whether to short-circuit the wp_setup_nav_menu_item() output. 841 * 842 * Returning a non-null value from the filter will short-circuit wp_setup_nav_menu_item(), 843 * returning that value instead. 844 * 845 * @since 6.3.0 846 * 847 * @param object|null $modified_menu_item Modified menu item. Default null. 848 * @param object $menu_item The menu item to modify. 849 */ 850 $pre_menu_item = apply_filters( 'pre_wp_setup_nav_menu_item', null, $menu_item ); 851 852 if ( null !== $pre_menu_item ) { 853 return $pre_menu_item; 854 } 855 856 if ( isset( $menu_item->post_type ) ) { 857 if ( 'nav_menu_item' === $menu_item->post_type ) { 858 $menu_item->db_id = (int) $menu_item->ID; 859 $menu_item->menu_item_parent = ! isset( $menu_item->menu_item_parent ) ? get_post_meta( $menu_item->ID, '_menu_item_menu_item_parent', true ) : $menu_item->menu_item_parent; 860 $menu_item->object_id = ! isset( $menu_item->object_id ) ? get_post_meta( $menu_item->ID, '_menu_item_object_id', true ) : $menu_item->object_id; 861 $menu_item->object = ! isset( $menu_item->object ) ? get_post_meta( $menu_item->ID, '_menu_item_object', true ) : $menu_item->object; 862 $menu_item->type = ! isset( $menu_item->type ) ? get_post_meta( $menu_item->ID, '_menu_item_type', true ) : $menu_item->type; 863 864 if ( 'post_type' === $menu_item->type ) { 865 $object = get_post_type_object( $menu_item->object ); 866 if ( $object ) { 867 $menu_item->type_label = $object->labels->singular_name; 868 // Denote post states for special pages (only in the admin). 869 if ( function_exists( 'get_post_states' ) ) { 870 $menu_post = get_post( $menu_item->object_id ); 871 $post_states = get_post_states( $menu_post ); 872 if ( $post_states ) { 873 $menu_item->type_label = wp_strip_all_tags( implode( ', ', $post_states ) ); 874 } 875 } 876 } else { 877 $menu_item->type_label = $menu_item->object; 878 $menu_item->_invalid = true; 879 } 880 881 if ( 'trash' === get_post_status( $menu_item->object_id ) ) { 882 $menu_item->_invalid = true; 883 } 884 885 $original_object = get_post( $menu_item->object_id ); 886 887 if ( $original_object ) { 888 $menu_item->url = get_permalink( $original_object->ID ); 889 /** This filter is documented in wp-includes/post-template.php */ 890 $original_title = apply_filters( 'the_title', $original_object->post_title, $original_object->ID ); 891 } else { 892 $menu_item->url = ''; 893 $original_title = ''; 894 $menu_item->_invalid = true; 895 } 896 897 if ( '' === $original_title ) { 898 /* translators: %d: ID of a post. */ 899 $original_title = sprintf( __( '#%d (no title)' ), $menu_item->object_id ); 900 } 901 902 $menu_item->title = ( '' === $menu_item->post_title ) ? $original_title : $menu_item->post_title; 903 904 } elseif ( 'post_type_archive' === $menu_item->type ) { 905 $object = get_post_type_object( $menu_item->object ); 906 if ( $object ) { 907 $menu_item->title = ( '' === $menu_item->post_title ) ? $object->labels->archives : $menu_item->post_title; 908 $post_type_description = $object->description; 909 } else { 910 $post_type_description = ''; 911 $menu_item->_invalid = true; 912 } 913 914 $menu_item->type_label = __( 'Post Type Archive' ); 915 $post_content = wp_trim_words( $menu_item->post_content, 200 ); 916 $post_type_description = ( '' === $post_content ) ? $post_type_description : $post_content; 917 $menu_item->url = get_post_type_archive_link( $menu_item->object ); 918 919 } elseif ( 'taxonomy' === $menu_item->type ) { 920 $object = get_taxonomy( $menu_item->object ); 921 if ( $object ) { 922 $menu_item->type_label = $object->labels->singular_name; 923 } else { 924 $menu_item->type_label = $menu_item->object; 925 $menu_item->_invalid = true; 926 } 927 928 $original_object = get_term( (int) $menu_item->object_id, $menu_item->object ); 929 930 if ( $original_object && ! is_wp_error( $original_object ) ) { 931 $menu_item->url = get_term_link( (int) $menu_item->object_id, $menu_item->object ); 932 $original_title = $original_object->name; 933 } else { 934 $menu_item->url = ''; 935 $original_title = ''; 936 $menu_item->_invalid = true; 937 } 938 939 if ( '' === $original_title ) { 940 /* translators: %d: ID of a term. */ 941 $original_title = sprintf( __( '#%d (no title)' ), $menu_item->object_id ); 942 } 943 944 $menu_item->title = ( '' === $menu_item->post_title ) ? $original_title : $menu_item->post_title; 945 946 } else { 947 $menu_item->type_label = __( 'Custom Link' ); 948 $menu_item->title = $menu_item->post_title; 949 $menu_item->url = ! isset( $menu_item->url ) ? get_post_meta( $menu_item->ID, '_menu_item_url', true ) : $menu_item->url; 950 } 951 952 $menu_item->target = ! isset( $menu_item->target ) ? get_post_meta( $menu_item->ID, '_menu_item_target', true ) : $menu_item->target; 953 954 /** 955 * Filters a navigation menu item's title attribute. 956 * 957 * @since 3.0.0 958 * 959 * @param string $item_title The menu item title attribute. 960 */ 961 $menu_item->attr_title = ! isset( $menu_item->attr_title ) ? apply_filters( 'nav_menu_attr_title', $menu_item->post_excerpt ) : $menu_item->attr_title; 962 963 if ( ! isset( $menu_item->description ) ) { 964 /** 965 * Filters a navigation menu item's description. 966 * 967 * @since 3.0.0 968 * 969 * @param string $description The menu item description. 970 */ 971 $menu_item->description = apply_filters( 'nav_menu_description', wp_trim_words( $menu_item->post_content, 200 ) ); 972 } 973 974 $menu_item->classes = ! isset( $menu_item->classes ) ? (array) get_post_meta( $menu_item->ID, '_menu_item_classes', true ) : $menu_item->classes; 975 $menu_item->xfn = ! isset( $menu_item->xfn ) ? get_post_meta( $menu_item->ID, '_menu_item_xfn', true ) : $menu_item->xfn; 976 } else { 977 $menu_item->db_id = 0; 978 $menu_item->menu_item_parent = 0; 979 $menu_item->object_id = (int) $menu_item->ID; 980 $menu_item->type = 'post_type'; 981 982 $object = get_post_type_object( $menu_item->post_type ); 983 $menu_item->object = $object->name; 984 $menu_item->type_label = $object->labels->singular_name; 985 986 if ( '' === $menu_item->post_title ) { 987 /* translators: %d: ID of a post. */ 988 $menu_item->post_title = sprintf( __( '#%d (no title)' ), $menu_item->ID ); 989 } 990 991 $menu_item->title = $menu_item->post_title; 992 $menu_item->url = get_permalink( $menu_item->ID ); 993 $menu_item->target = ''; 994 995 /** This filter is documented in wp-includes/nav-menu.php */ 996 $menu_item->attr_title = apply_filters( 'nav_menu_attr_title', '' ); 997 998 /** This filter is documented in wp-includes/nav-menu.php */ 999 $menu_item->description = apply_filters( 'nav_menu_description', '' ); 1000 $menu_item->classes = array(); 1001 $menu_item->xfn = ''; 1002 } 1003 } elseif ( isset( $menu_item->taxonomy ) ) { 1004 $menu_item->ID = $menu_item->term_id; 1005 $menu_item->db_id = 0; 1006 $menu_item->menu_item_parent = 0; 1007 $menu_item->object_id = (int) $menu_item->term_id; 1008 $menu_item->post_parent = (int) $menu_item->parent; 1009 $menu_item->type = 'taxonomy'; 1010 1011 $object = get_taxonomy( $menu_item->taxonomy ); 1012 $menu_item->object = $object->name; 1013 $menu_item->type_label = $object->labels->singular_name; 1014 1015 $menu_item->title = $menu_item->name; 1016 $menu_item->url = get_term_link( $menu_item, $menu_item->taxonomy ); 1017 $menu_item->target = ''; 1018 $menu_item->attr_title = ''; 1019 $menu_item->description = get_term_field( 'description', $menu_item->term_id, $menu_item->taxonomy ); 1020 $menu_item->classes = array(); 1021 $menu_item->xfn = ''; 1022 1023 } 1024 1025 /** 1026 * Filters a navigation menu item object. 1027 * 1028 * @since 3.0.0 1029 * 1030 * @param object $menu_item The menu item object. 1031 */ 1032 return apply_filters( 'wp_setup_nav_menu_item', $menu_item ); 1033 } 1034 1035 /** 1036 * Returns the menu items associated with a particular object. 1037 * 1038 * @since 3.0.0 1039 * 1040 * @param int $object_id Optional. The ID of the original object. Default 0. 1041 * @param string $object_type Optional. The type of object, such as 'post_type' or 'taxonomy'. 1042 * Default 'post_type'. 1043 * @param string $taxonomy Optional. If $object_type is 'taxonomy', $taxonomy is the name 1044 * of the tax that $object_id belongs to. Default empty. 1045 * @return int[] The array of menu item IDs; empty array if none. 1046 */ 1047 function wp_get_associated_nav_menu_items( $object_id = 0, $object_type = 'post_type', $taxonomy = '' ) { 1048 $object_id = (int) $object_id; 1049 $menu_item_ids = array(); 1050 1051 $query = new WP_Query(); 1052 $menu_items = $query->query( 1053 array( 1054 'meta_key' => '_menu_item_object_id', 1055 'meta_value' => $object_id, 1056 'post_status' => 'any', 1057 'post_type' => 'nav_menu_item', 1058 'posts_per_page' => -1, 1059 ) 1060 ); 1061 foreach ( (array) $menu_items as $menu_item ) { 1062 if ( isset( $menu_item->ID ) && is_nav_menu_item( $menu_item->ID ) ) { 1063 $menu_item_type = get_post_meta( $menu_item->ID, '_menu_item_type', true ); 1064 if ( 1065 'post_type' === $object_type && 1066 'post_type' === $menu_item_type 1067 ) { 1068 $menu_item_ids[] = (int) $menu_item->ID; 1069 } elseif ( 1070 'taxonomy' === $object_type && 1071 'taxonomy' === $menu_item_type && 1072 get_post_meta( $menu_item->ID, '_menu_item_object', true ) === $taxonomy 1073 ) { 1074 $menu_item_ids[] = (int) $menu_item->ID; 1075 } 1076 } 1077 } 1078 1079 return array_unique( $menu_item_ids ); 1080 } 1081 1082 /** 1083 * Callback for handling a menu item when its original object is deleted. 1084 * 1085 * @since 3.0.0 1086 * @access private 1087 * 1088 * @param int $object_id The ID of the original object being trashed. 1089 */ 1090 function _wp_delete_post_menu_item( $object_id ) { 1091 $object_id = (int) $object_id; 1092 1093 $menu_item_ids = wp_get_associated_nav_menu_items( $object_id, 'post_type' ); 1094 1095 foreach ( (array) $menu_item_ids as $menu_item_id ) { 1096 wp_delete_post( $menu_item_id, true ); 1097 } 1098 } 1099 1100 /** 1101 * Serves as a callback for handling a menu item when its original object is deleted. 1102 * 1103 * @since 3.0.0 1104 * @access private 1105 * 1106 * @param int $object_id The ID of the original object being trashed. 1107 * @param int $tt_id Term taxonomy ID. Unused. 1108 * @param string $taxonomy Taxonomy slug. 1109 */ 1110 function _wp_delete_tax_menu_item( $object_id, $tt_id, $taxonomy ) { 1111 $object_id = (int) $object_id; 1112 1113 $menu_item_ids = wp_get_associated_nav_menu_items( $object_id, 'taxonomy', $taxonomy ); 1114 1115 foreach ( (array) $menu_item_ids as $menu_item_id ) { 1116 wp_delete_post( $menu_item_id, true ); 1117 } 1118 } 1119 1120 /** 1121 * Automatically add newly published page objects to menus with that as an option. 1122 * 1123 * @since 3.0.0 1124 * @access private 1125 * 1126 * @param string $new_status The new status of the post object. 1127 * @param string $old_status The old status of the post object. 1128 * @param WP_Post $post The post object being transitioned from one status to another. 1129 */ 1130 function _wp_auto_add_pages_to_menu( $new_status, $old_status, $post ) { 1131 if ( 'publish' !== $new_status || 'publish' === $old_status || 'page' !== $post->post_type ) { 1132 return; 1133 } 1134 if ( ! empty( $post->post_parent ) ) { 1135 return; 1136 } 1137 $auto_add = get_option( 'nav_menu_options' ); 1138 if ( empty( $auto_add ) || ! is_array( $auto_add ) || ! isset( $auto_add['auto_add'] ) ) { 1139 return; 1140 } 1141 $auto_add = $auto_add['auto_add']; 1142 if ( empty( $auto_add ) || ! is_array( $auto_add ) ) { 1143 return; 1144 } 1145 1146 $args = array( 1147 'menu-item-object-id' => $post->ID, 1148 'menu-item-object' => $post->post_type, 1149 'menu-item-type' => 'post_type', 1150 'menu-item-status' => 'publish', 1151 ); 1152 1153 foreach ( $auto_add as $menu_id ) { 1154 $items = wp_get_nav_menu_items( $menu_id, array( 'post_status' => 'publish,draft' ) ); 1155 if ( ! is_array( $items ) ) { 1156 continue; 1157 } 1158 foreach ( $items as $item ) { 1159 if ( $post->ID === (int) $item->object_id ) { 1160 continue 2; 1161 } 1162 } 1163 wp_update_nav_menu_item( $menu_id, 0, $args ); 1164 } 1165 } 1166 1167 /** 1168 * Deletes auto-draft posts associated with the supplied changeset. 1169 * 1170 * @since 4.8.0 1171 * @access private 1172 * 1173 * @param int $post_id Post ID for the customize_changeset. 1174 */ 1175 function _wp_delete_customize_changeset_dependent_auto_drafts( $post_id ) { 1176 $post = get_post( $post_id ); 1177 1178 if ( ! $post || 'customize_changeset' !== $post->post_type ) { 1179 return; 1180 } 1181 1182 $data = json_decode( $post->post_content, true ); 1183 if ( empty( $data['nav_menus_created_posts']['value'] ) ) { 1184 return; 1185 } 1186 remove_action( 'delete_post', '_wp_delete_customize_changeset_dependent_auto_drafts' ); 1187 foreach ( $data['nav_menus_created_posts']['value'] as $stub_post_id ) { 1188 if ( empty( $stub_post_id ) ) { 1189 continue; 1190 } 1191 if ( 'auto-draft' === get_post_status( $stub_post_id ) ) { 1192 wp_delete_post( $stub_post_id, true ); 1193 } elseif ( 'draft' === get_post_status( $stub_post_id ) ) { 1194 wp_trash_post( $stub_post_id ); 1195 delete_post_meta( $stub_post_id, '_customize_changeset_uuid' ); 1196 } 1197 } 1198 add_action( 'delete_post', '_wp_delete_customize_changeset_dependent_auto_drafts' ); 1199 } 1200 1201 /** 1202 * Handles menu config after theme change. 1203 * 1204 * @access private 1205 * @since 4.9.0 1206 */ 1207 function _wp_menus_changed() { 1208 $old_nav_menu_locations = get_option( 'theme_switch_menu_locations', array() ); 1209 $new_nav_menu_locations = get_nav_menu_locations(); 1210 $mapped_nav_menu_locations = wp_map_nav_menu_locations( $new_nav_menu_locations, $old_nav_menu_locations ); 1211 1212 set_theme_mod( 'nav_menu_locations', $mapped_nav_menu_locations ); 1213 delete_option( 'theme_switch_menu_locations' ); 1214 } 1215 1216 /** 1217 * Maps nav menu locations according to assignments in previously active theme. 1218 * 1219 * @since 4.9.0 1220 * 1221 * @param array $new_nav_menu_locations New nav menu locations assignments. 1222 * @param array $old_nav_menu_locations Old nav menu locations assignments. 1223 * @return array Nav menus mapped to new nav menu locations. 1224 */ 1225 function wp_map_nav_menu_locations( $new_nav_menu_locations, $old_nav_menu_locations ) { 1226 $registered_nav_menus = get_registered_nav_menus(); 1227 $new_nav_menu_locations = array_intersect_key( $new_nav_menu_locations, $registered_nav_menus ); 1228 1229 // Short-circuit if there are no old nav menu location assignments to map. 1230 if ( empty( $old_nav_menu_locations ) ) { 1231 return $new_nav_menu_locations; 1232 } 1233 1234 // If old and new theme have just one location, map it and we're done. 1235 if ( 1 === count( $old_nav_menu_locations ) && 1 === count( $registered_nav_menus ) ) { 1236 $new_nav_menu_locations[ key( $registered_nav_menus ) ] = array_pop( $old_nav_menu_locations ); 1237 return $new_nav_menu_locations; 1238 } 1239 1240 $old_locations = array_keys( $old_nav_menu_locations ); 1241 1242 // Map locations with the same slug. 1243 foreach ( $registered_nav_menus as $location => $name ) { 1244 if ( in_array( $location, $old_locations, true ) ) { 1245 $new_nav_menu_locations[ $location ] = $old_nav_menu_locations[ $location ]; 1246 unset( $old_nav_menu_locations[ $location ] ); 1247 } 1248 } 1249 1250 // If there are no old nav menu locations left, then we're done. 1251 if ( empty( $old_nav_menu_locations ) ) { 1252 return $new_nav_menu_locations; 1253 } 1254 1255 /* 1256 * If old and new theme both have locations that contain phrases 1257 * from within the same group, make an educated guess and map it. 1258 */ 1259 $common_slug_groups = array( 1260 array( 'primary', 'menu-1', 'main', 'header', 'navigation', 'top' ), 1261 array( 'secondary', 'menu-2', 'footer', 'subsidiary', 'bottom' ), 1262 array( 'social' ), 1263 ); 1264 1265 // Go through each group... 1266 foreach ( $common_slug_groups as $slug_group ) { 1267 1268 // ...and see if any of these slugs... 1269 foreach ( $slug_group as $slug ) { 1270 1271 // ...and any of the new menu locations... 1272 foreach ( $registered_nav_menus as $new_location => $name ) { 1273 1274 // ...actually match! 1275 if ( is_string( $new_location ) && false === stripos( $new_location, $slug ) && false === stripos( $slug, $new_location ) ) { 1276 continue; 1277 } elseif ( is_numeric( $new_location ) && $new_location !== $slug ) { 1278 continue; 1279 } 1280 1281 // Then see if any of the old locations... 1282 foreach ( $old_nav_menu_locations as $location => $menu_id ) { 1283 1284 // ...and any slug in the same group... 1285 foreach ( $slug_group as $slug ) { 1286 1287 // ... have a match as well. 1288 if ( is_string( $location ) && false === stripos( $location, $slug ) && false === stripos( $slug, $location ) ) { 1289 continue; 1290 } elseif ( is_numeric( $location ) && $location !== $slug ) { 1291 continue; 1292 } 1293 1294 // Make sure this location wasn't mapped and removed previously. 1295 if ( ! empty( $old_nav_menu_locations[ $location ] ) ) { 1296 1297 // We have a match that can be mapped! 1298 $new_nav_menu_locations[ $new_location ] = $old_nav_menu_locations[ $location ]; 1299 1300 // Remove the mapped location so it can't be mapped again. 1301 unset( $old_nav_menu_locations[ $location ] ); 1302 1303 // Go back and check the next new menu location. 1304 continue 3; 1305 } 1306 } // End foreach ( $slug_group as $slug ). 1307 } // End foreach ( $old_nav_menu_locations as $location => $menu_id ). 1308 } // End foreach foreach ( $registered_nav_menus as $new_location => $name ). 1309 } // End foreach ( $slug_group as $slug ). 1310 } // End foreach ( $common_slug_groups as $slug_group ). 1311 1312 return $new_nav_menu_locations; 1313 } 1314 1315 /** 1316 * Prevents menu items from being their own parent. 1317 * 1318 * Resets menu_item_parent to 0 when the parent is set to the item itself. 1319 * For use before saving `_menu_item_menu_item_parent` in nav-menus.php. 1320 * 1321 * @since 6.2.0 1322 * @access private 1323 * 1324 * @param array $menu_item_data The menu item data array. 1325 * @return array The menu item data with reset menu_item_parent. 1326 */ 1327 function _wp_reset_invalid_menu_item_parent( $menu_item_data ) { 1328 if ( ! is_array( $menu_item_data ) ) { 1329 return $menu_item_data; 1330 } 1331 1332 if ( 1333 ! empty( $menu_item_data['ID'] ) && 1334 ! empty( $menu_item_data['menu_item_parent'] ) && 1335 (int) $menu_item_data['ID'] === (int) $menu_item_data['menu_item_parent'] 1336 ) { 1337 $menu_item_data['menu_item_parent'] = 0; 1338 } 1339 1340 return $menu_item_data; 1341 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Thu May 9 08:20:02 2024 | Cross-referenced by PHPXref |