| [ Index ] |
PHP Cross Reference of WordPress |
[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 False if $menu param isn't supplied or term does not exist, menu object if successful. 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 * Check if 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 array $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 array Registered navigation menu locations. If none are registered, an empty array. 147 */ 148 function get_registered_nav_menus() { 149 global $_wp_registered_nav_menus; 150 if ( isset( $_wp_registered_nav_menus ) ) { 151 return $_wp_registered_nav_menus; 152 } 153 return array(); 154 } 155 156 /** 157 * Retrieves all registered navigation menu locations and the menus assigned to them. 158 * 159 * @since 3.0.0 160 * 161 * @return array Registered navigation menu locations and the menus assigned them. 162 * If none are registered, an empty array. 163 */ 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 * Delete 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 * Save 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 * Save 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 into `wp_insert_post()`. 411 * 412 * @since 3.0.0 413 * 414 * @param int $menu_id The ID of the menu. Required. If "0", makes the menu item a draft orphan. 415 * @param int $menu_item_db_id The ID of the menu item. If "0", creates a new menu item. 416 * @param array $menu_item_data The menu item's data. 417 * @return int|WP_Error The menu item's database ID or WP_Error object on failure. 418 */ 419 function wp_update_nav_menu_item( $menu_id = 0, $menu_item_db_id = 0, $menu_item_data = array() ) { 420 $menu_id = (int) $menu_id; 421 $menu_item_db_id = (int) $menu_item_db_id; 422 423 // Make sure that we don't convert non-nav_menu_item objects into nav_menu_item objects. 424 if ( ! empty( $menu_item_db_id ) && ! is_nav_menu_item( $menu_item_db_id ) ) { 425 return new WP_Error( 'update_nav_menu_item_failed', __( 'The given object ID is not that of a menu item.' ) ); 426 } 427 428 $menu = wp_get_nav_menu_object( $menu_id ); 429 430 if ( ! $menu && 0 !== $menu_id ) { 431 return new WP_Error( 'invalid_menu_id', __( 'Invalid menu ID.' ) ); 432 } 433 434 if ( is_wp_error( $menu ) ) { 435 return $menu; 436 } 437 438 $defaults = array( 439 'menu-item-db-id' => $menu_item_db_id, 440 'menu-item-object-id' => 0, 441 'menu-item-object' => '', 442 'menu-item-parent-id' => 0, 443 'menu-item-position' => 0, 444 'menu-item-type' => 'custom', 445 'menu-item-title' => '', 446 'menu-item-url' => '', 447 'menu-item-description' => '', 448 'menu-item-attr-title' => '', 449 'menu-item-target' => '', 450 'menu-item-classes' => '', 451 'menu-item-xfn' => '', 452 'menu-item-status' => '', 453 ); 454 455 $args = wp_parse_args( $menu_item_data, $defaults ); 456 457 if ( 0 == $menu_id ) { 458 $args['menu-item-position'] = 1; 459 } elseif ( 0 == (int) $args['menu-item-position'] ) { 460 $menu_items = 0 == $menu_id ? array() : (array) wp_get_nav_menu_items( $menu_id, array( 'post_status' => 'publish,draft' ) ); 461 $last_item = array_pop( $menu_items ); 462 $args['menu-item-position'] = ( $last_item && isset( $last_item->menu_order ) ) ? 1 + $last_item->menu_order : count( $menu_items ); 463 } 464 465 $original_parent = 0 < $menu_item_db_id ? get_post_field( 'post_parent', $menu_item_db_id ) : 0; 466 467 if ( 'custom' === $args['menu-item-type'] ) { 468 // If custom menu item, trim the URL. 469 $args['menu-item-url'] = trim( $args['menu-item-url'] ); 470 } else { 471 /* 472 * If non-custom menu item, then: 473 * - use the original object's URL. 474 * - blank default title to sync with the original object's title. 475 */ 476 477 $args['menu-item-url'] = ''; 478 479 $original_title = ''; 480 if ( 'taxonomy' === $args['menu-item-type'] ) { 481 $original_parent = get_term_field( 'parent', $args['menu-item-object-id'], $args['menu-item-object'], 'raw' ); 482 $original_title = get_term_field( 'name', $args['menu-item-object-id'], $args['menu-item-object'], 'raw' ); 483 } elseif ( 'post_type' === $args['menu-item-type'] ) { 484 485 $original_object = get_post( $args['menu-item-object-id'] ); 486 $original_parent = (int) $original_object->post_parent; 487 $original_title = $original_object->post_title; 488 } elseif ( 'post_type_archive' === $args['menu-item-type'] ) { 489 $original_object = get_post_type_object( $args['menu-item-object'] ); 490 if ( $original_object ) { 491 $original_title = $original_object->labels->archives; 492 } 493 } 494 495 if ( wp_unslash( $args['menu-item-title'] ) === wp_specialchars_decode( $original_title ) ) { 496 $args['menu-item-title'] = ''; 497 } 498 499 // Hack to get wp to create a post object when too many properties are empty. 500 if ( '' === $args['menu-item-title'] && '' === $args['menu-item-description'] ) { 501 $args['menu-item-description'] = ' '; 502 } 503 } 504 505 // Populate the menu item object. 506 $post = array( 507 'menu_order' => $args['menu-item-position'], 508 'ping_status' => 0, 509 'post_content' => $args['menu-item-description'], 510 'post_excerpt' => $args['menu-item-attr-title'], 511 'post_parent' => $original_parent, 512 'post_title' => $args['menu-item-title'], 513 'post_type' => 'nav_menu_item', 514 ); 515 516 $update = 0 != $menu_item_db_id; 517 518 // New menu item. Default is draft status. 519 if ( ! $update ) { 520 $post['ID'] = 0; 521 $post['post_status'] = 'publish' === $args['menu-item-status'] ? 'publish' : 'draft'; 522 $menu_item_db_id = wp_insert_post( $post ); 523 if ( ! $menu_item_db_id || is_wp_error( $menu_item_db_id ) ) { 524 return $menu_item_db_id; 525 } 526 527 /** 528 * Fires immediately after a new navigation menu item has been added. 529 * 530 * @since 4.4.0 531 * 532 * @see wp_update_nav_menu_item() 533 * 534 * @param int $menu_id ID of the updated menu. 535 * @param int $menu_item_db_id ID of the new menu item. 536 * @param array $args An array of arguments used to update/add the menu item. 537 */ 538 do_action( 'wp_add_nav_menu_item', $menu_id, $menu_item_db_id, $args ); 539 } 540 541 // Associate the menu item with the menu term. 542 // Only set the menu term if it isn't set to avoid unnecessary wp_get_object_terms(). 543 if ( $menu_id && ( ! $update || ! is_object_in_term( $menu_item_db_id, 'nav_menu', (int) $menu->term_id ) ) ) { 544 wp_set_object_terms( $menu_item_db_id, array( $menu->term_id ), 'nav_menu' ); 545 } 546 547 if ( 'custom' === $args['menu-item-type'] ) { 548 $args['menu-item-object-id'] = $menu_item_db_id; 549 $args['menu-item-object'] = 'custom'; 550 } 551 552 $menu_item_db_id = (int) $menu_item_db_id; 553 554 update_post_meta( $menu_item_db_id, '_menu_item_type', sanitize_key( $args['menu-item-type'] ) ); 555 update_post_meta( $menu_item_db_id, '_menu_item_menu_item_parent', (string) ( (int) $args['menu-item-parent-id'] ) ); 556 update_post_meta( $menu_item_db_id, '_menu_item_object_id', (string) ( (int) $args['menu-item-object-id'] ) ); 557 update_post_meta( $menu_item_db_id, '_menu_item_object', sanitize_key( $args['menu-item-object'] ) ); 558 update_post_meta( $menu_item_db_id, '_menu_item_target', sanitize_key( $args['menu-item-target'] ) ); 559 560 $args['menu-item-classes'] = array_map( 'sanitize_html_class', explode( ' ', $args['menu-item-classes'] ) ); 561 $args['menu-item-xfn'] = implode( ' ', array_map( 'sanitize_html_class', explode( ' ', $args['menu-item-xfn'] ) ) ); 562 update_post_meta( $menu_item_db_id, '_menu_item_classes', $args['menu-item-classes'] ); 563 update_post_meta( $menu_item_db_id, '_menu_item_xfn', $args['menu-item-xfn'] ); 564 update_post_meta( $menu_item_db_id, '_menu_item_url', esc_url_raw( $args['menu-item-url'] ) ); 565 566 if ( 0 == $menu_id ) { 567 update_post_meta( $menu_item_db_id, '_menu_item_orphaned', (string) time() ); 568 } elseif ( get_post_meta( $menu_item_db_id, '_menu_item_orphaned' ) ) { 569 delete_post_meta( $menu_item_db_id, '_menu_item_orphaned' ); 570 } 571 572 // Update existing menu item. Default is publish status. 573 if ( $update ) { 574 $post['ID'] = $menu_item_db_id; 575 $post['post_status'] = ( 'draft' === $args['menu-item-status'] ) ? 'draft' : 'publish'; 576 wp_update_post( $post ); 577 } 578 579 /** 580 * Fires after a navigation menu item has been updated. 581 * 582 * @since 3.0.0 583 * 584 * @see wp_update_nav_menu_item() 585 * 586 * @param int $menu_id ID of the updated menu. 587 * @param int $menu_item_db_id ID of the updated menu item. 588 * @param array $args An array of arguments used to update a menu item. 589 */ 590 do_action( 'wp_update_nav_menu_item', $menu_id, $menu_item_db_id, $args ); 591 592 return $menu_item_db_id; 593 } 594 595 /** 596 * Returns all navigation menu objects. 597 * 598 * @since 3.0.0 599 * @since 4.1.0 Default value of the 'orderby' argument was changed from 'none' 600 * to 'name'. 601 * 602 * @param array $args Optional. Array of arguments passed on to get_terms(). 603 * Default empty array. 604 * @return WP_Term[] An array of menu objects. 605 */ 606 function wp_get_nav_menus( $args = array() ) { 607 $defaults = array( 608 'taxonomy' => 'nav_menu', 609 'hide_empty' => false, 610 'orderby' => 'name', 611 ); 612 $args = wp_parse_args( $args, $defaults ); 613 614 /** 615 * Filters the navigation menu objects being returned. 616 * 617 * @since 3.0.0 618 * 619 * @see get_terms() 620 * 621 * @param WP_Term[] $menus An array of menu objects. 622 * @param array $args An array of arguments used to retrieve menu objects. 623 */ 624 return apply_filters( 'wp_get_nav_menus', get_terms( $args ), $args ); 625 } 626 627 /** 628 * Return if a menu item is valid. 629 * 630 * @link https://core.trac.wordpress.org/ticket/13958 631 * 632 * @since 3.2.0 633 * @access private 634 * 635 * @param object $item The menu item to check. 636 * @return bool False if invalid, otherwise true. 637 */ 638 function _is_valid_nav_menu_item( $item ) { 639 return empty( $item->_invalid ); 640 } 641 642 /** 643 * Retrieves all menu items of a navigation menu. 644 * 645 * Note: Most arguments passed to the `$args` parameter – save for 'output_key' – are 646 * specifically for retrieving nav_menu_item posts from get_posts() and may only 647 * indirectly affect the ultimate ordering and content of the resulting nav menu 648 * items that get returned from this function. 649 * 650 * @since 3.0.0 651 * 652 * @param int|string|WP_Term $menu Menu ID, slug, name, or object. 653 * @param array $args { 654 * Optional. Arguments to pass to get_posts(). 655 * 656 * @type string $order How to order nav menu items as queried with get_posts(). Will be ignored 657 * if 'output' is ARRAY_A. Default 'ASC'. 658 * @type string $orderby Field to order menu items by as retrieved from get_posts(). Supply an orderby 659 * field via 'output_key' to affect the output order of nav menu items. 660 * Default 'menu_order'. 661 * @type string $post_type Menu items post type. Default 'nav_menu_item'. 662 * @type string $post_status Menu items post status. Default 'publish'. 663 * @type string $output How to order outputted menu items. Default ARRAY_A. 664 * @type string $output_key Key to use for ordering the actual menu items that get returned. Note that 665 * that is not a get_posts() argument and will only affect output of menu items 666 * processed in this function. Default 'menu_order'. 667 * @type bool $nopaging Whether to retrieve all menu items (true) or paginate (false). Default true. 668 * } 669 * @return array|false Array of menu items, otherwise false. 670 */ 671 function wp_get_nav_menu_items( $menu, $args = array() ) { 672 $menu = wp_get_nav_menu_object( $menu ); 673 674 if ( ! $menu ) { 675 return false; 676 } 677 678 static $fetched = array(); 679 680 $items = get_objects_in_term( $menu->term_id, 'nav_menu' ); 681 if ( is_wp_error( $items ) ) { 682 return false; 683 } 684 685 $defaults = array( 686 'order' => 'ASC', 687 'orderby' => 'menu_order', 688 'post_type' => 'nav_menu_item', 689 'post_status' => 'publish', 690 'output' => ARRAY_A, 691 'output_key' => 'menu_order', 692 'nopaging' => true, 693 ); 694 $args = wp_parse_args( $args, $defaults ); 695 $args['include'] = $items; 696 697 if ( ! empty( $items ) ) { 698 $items = get_posts( $args ); 699 } else { 700 $items = array(); 701 } 702 703 // Get all posts and terms at once to prime the caches. 704 if ( empty( $fetched[ $menu->term_id ] ) && ! wp_using_ext_object_cache() ) { 705 $fetched[ $menu->term_id ] = true; 706 $posts = array(); 707 $terms = array(); 708 foreach ( $items as $item ) { 709 $object_id = get_post_meta( $item->ID, '_menu_item_object_id', true ); 710 $object = get_post_meta( $item->ID, '_menu_item_object', true ); 711 $type = get_post_meta( $item->ID, '_menu_item_type', true ); 712 713 if ( 'post_type' === $type ) { 714 $posts[ $object ][] = $object_id; 715 } elseif ( 'taxonomy' === $type ) { 716 $terms[ $object ][] = $object_id; 717 } 718 } 719 720 if ( ! empty( $posts ) ) { 721 foreach ( array_keys( $posts ) as $post_type ) { 722 get_posts( 723 array( 724 'post__in' => $posts[ $post_type ], 725 'post_type' => $post_type, 726 'nopaging' => true, 727 'update_post_term_cache' => false, 728 ) 729 ); 730 } 731 } 732 unset( $posts ); 733 734 if ( ! empty( $terms ) ) { 735 foreach ( array_keys( $terms ) as $taxonomy ) { 736 get_terms( 737 array( 738 'taxonomy' => $taxonomy, 739 'include' => $terms[ $taxonomy ], 740 'hierarchical' => false, 741 ) 742 ); 743 } 744 } 745 unset( $terms ); 746 } 747 748 $items = array_map( 'wp_setup_nav_menu_item', $items ); 749 750 if ( ! is_admin() ) { // Remove invalid items only on front end. 751 $items = array_filter( $items, '_is_valid_nav_menu_item' ); 752 } 753 754 if ( ARRAY_A == $args['output'] ) { 755 $items = wp_list_sort( 756 $items, 757 array( 758 $args['output_key'] => 'ASC', 759 ) 760 ); 761 $i = 1; 762 foreach ( $items as $k => $item ) { 763 $items[ $k ]->{$args['output_key']} = $i++; 764 } 765 } 766 767 /** 768 * Filters the navigation menu items being returned. 769 * 770 * @since 3.0.0 771 * 772 * @param array $items An array of menu item post objects. 773 * @param object $menu The menu object. 774 * @param array $args An array of arguments used to retrieve menu item objects. 775 */ 776 return apply_filters( 'wp_get_nav_menu_items', $items, $menu, $args ); 777 } 778 779 /** 780 * Decorates a menu item object with the shared navigation menu item properties. 781 * 782 * Properties: 783 * - ID: The term_id if the menu item represents a taxonomy term. 784 * - attr_title: The title attribute of the link element for this menu item. 785 * - classes: The array of class attribute values for the link element of this menu item. 786 * - db_id: The DB ID of this item as a nav_menu_item object, if it exists (0 if it doesn't exist). 787 * - description: The description of this menu item. 788 * - menu_item_parent: The DB ID of the nav_menu_item that is this item's menu parent, if any. 0 otherwise. 789 * - object: The type of object originally represented, such as 'category', 'post', or 'attachment'. 790 * - object_id: The DB ID of the original object this menu item represents, e.g. ID for posts and term_id for categories. 791 * - post_parent: The DB ID of the original object's parent object, if any (0 otherwise). 792 * - post_title: A "no title" label if menu item represents a post that lacks a title. 793 * - target: The target attribute of the link element for this menu item. 794 * - title: The title of this menu item. 795 * - type: The family of objects originally represented, such as 'post_type' or 'taxonomy'. 796 * - type_label: The singular label used to describe this type of menu item. 797 * - url: The URL to which this menu item points. 798 * - xfn: The XFN relationship expressed in the link of this menu item. 799 * - _invalid: Whether the menu item represents an object that no longer exists. 800 * 801 * @since 3.0.0 802 * 803 * @param object $menu_item The menu item to modify. 804 * @return object The menu item with standard menu item properties. 805 */ 806 function wp_setup_nav_menu_item( $menu_item ) { 807 if ( isset( $menu_item->post_type ) ) { 808 if ( 'nav_menu_item' === $menu_item->post_type ) { 809 $menu_item->db_id = (int) $menu_item->ID; 810 $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; 811 $menu_item->object_id = ! isset( $menu_item->object_id ) ? get_post_meta( $menu_item->ID, '_menu_item_object_id', true ) : $menu_item->object_id; 812 $menu_item->object = ! isset( $menu_item->object ) ? get_post_meta( $menu_item->ID, '_menu_item_object', true ) : $menu_item->object; 813 $menu_item->type = ! isset( $menu_item->type ) ? get_post_meta( $menu_item->ID, '_menu_item_type', true ) : $menu_item->type; 814 815 if ( 'post_type' === $menu_item->type ) { 816 $object = get_post_type_object( $menu_item->object ); 817 if ( $object ) { 818 $menu_item->type_label = $object->labels->singular_name; 819 // Denote post states for special pages (only in the admin). 820 if ( function_exists( 'get_post_states' ) ) { 821 $menu_post = get_post( $menu_item->object_id ); 822 $post_states = get_post_states( $menu_post ); 823 if ( $post_states ) { 824 $menu_item->type_label = wp_strip_all_tags( implode( ', ', $post_states ) ); 825 } 826 } 827 } else { 828 $menu_item->type_label = $menu_item->object; 829 $menu_item->_invalid = true; 830 } 831 832 if ( 'trash' === get_post_status( $menu_item->object_id ) ) { 833 $menu_item->_invalid = true; 834 } 835 836 $original_object = get_post( $menu_item->object_id ); 837 838 if ( $original_object ) { 839 $menu_item->url = get_permalink( $original_object->ID ); 840 /** This filter is documented in wp-includes/post-template.php */ 841 $original_title = apply_filters( 'the_title', $original_object->post_title, $original_object->ID ); 842 } else { 843 $menu_item->url = ''; 844 $original_title = ''; 845 $menu_item->_invalid = true; 846 } 847 848 if ( '' === $original_title ) { 849 /* translators: %d: ID of a post. */ 850 $original_title = sprintf( __( '#%d (no title)' ), $menu_item->object_id ); 851 } 852 853 $menu_item->title = ( '' === $menu_item->post_title ) ? $original_title : $menu_item->post_title; 854 855 } elseif ( 'post_type_archive' === $menu_item->type ) { 856 $object = get_post_type_object( $menu_item->object ); 857 if ( $object ) { 858 $menu_item->title = ( '' === $menu_item->post_title ) ? $object->labels->archives : $menu_item->post_title; 859 $post_type_description = $object->description; 860 } else { 861 $post_type_description = ''; 862 $menu_item->_invalid = true; 863 } 864 865 $menu_item->type_label = __( 'Post Type Archive' ); 866 $post_content = wp_trim_words( $menu_item->post_content, 200 ); 867 $post_type_description = ( '' === $post_content ) ? $post_type_description : $post_content; 868 $menu_item->url = get_post_type_archive_link( $menu_item->object ); 869 870 } elseif ( 'taxonomy' === $menu_item->type ) { 871 $object = get_taxonomy( $menu_item->object ); 872 if ( $object ) { 873 $menu_item->type_label = $object->labels->singular_name; 874 } else { 875 $menu_item->type_label = $menu_item->object; 876 $menu_item->_invalid = true; 877 } 878 879 $original_object = get_term( (int) $menu_item->object_id, $menu_item->object ); 880 881 if ( $original_object && ! is_wp_error( $original_object ) ) { 882 $menu_item->url = get_term_link( (int) $menu_item->object_id, $menu_item->object ); 883 $original_title = $original_object->name; 884 } else { 885 $menu_item->url = ''; 886 $original_title = ''; 887 $menu_item->_invalid = true; 888 } 889 890 if ( '' === $original_title ) { 891 /* translators: %d: ID of a term. */ 892 $original_title = sprintf( __( '#%d (no title)' ), $menu_item->object_id ); 893 } 894 895 $menu_item->title = ( '' === $menu_item->post_title ) ? $original_title : $menu_item->post_title; 896 897 } else { 898 $menu_item->type_label = __( 'Custom Link' ); 899 $menu_item->title = $menu_item->post_title; 900 $menu_item->url = ! isset( $menu_item->url ) ? get_post_meta( $menu_item->ID, '_menu_item_url', true ) : $menu_item->url; 901 } 902 903 $menu_item->target = ! isset( $menu_item->target ) ? get_post_meta( $menu_item->ID, '_menu_item_target', true ) : $menu_item->target; 904 905 /** 906 * Filters a navigation menu item's title attribute. 907 * 908 * @since 3.0.0 909 * 910 * @param string $item_title The menu item title attribute. 911 */ 912 $menu_item->attr_title = ! isset( $menu_item->attr_title ) ? apply_filters( 'nav_menu_attr_title', $menu_item->post_excerpt ) : $menu_item->attr_title; 913 914 if ( ! isset( $menu_item->description ) ) { 915 /** 916 * Filters a navigation menu item's description. 917 * 918 * @since 3.0.0 919 * 920 * @param string $description The menu item description. 921 */ 922 $menu_item->description = apply_filters( 'nav_menu_description', wp_trim_words( $menu_item->post_content, 200 ) ); 923 } 924 925 $menu_item->classes = ! isset( $menu_item->classes ) ? (array) get_post_meta( $menu_item->ID, '_menu_item_classes', true ) : $menu_item->classes; 926 $menu_item->xfn = ! isset( $menu_item->xfn ) ? get_post_meta( $menu_item->ID, '_menu_item_xfn', true ) : $menu_item->xfn; 927 } else { 928 $menu_item->db_id = 0; 929 $menu_item->menu_item_parent = 0; 930 $menu_item->object_id = (int) $menu_item->ID; 931 $menu_item->type = 'post_type'; 932 933 $object = get_post_type_object( $menu_item->post_type ); 934 $menu_item->object = $object->name; 935 $menu_item->type_label = $object->labels->singular_name; 936 937 if ( '' === $menu_item->post_title ) { 938 /* translators: %d: ID of a post. */ 939 $menu_item->post_title = sprintf( __( '#%d (no title)' ), $menu_item->ID ); 940 } 941 942 $menu_item->title = $menu_item->post_title; 943 $menu_item->url = get_permalink( $menu_item->ID ); 944 $menu_item->target = ''; 945 946 /** This filter is documented in wp-includes/nav-menu.php */ 947 $menu_item->attr_title = apply_filters( 'nav_menu_attr_title', '' ); 948 949 /** This filter is documented in wp-includes/nav-menu.php */ 950 $menu_item->description = apply_filters( 'nav_menu_description', '' ); 951 $menu_item->classes = array(); 952 $menu_item->xfn = ''; 953 } 954 } elseif ( isset( $menu_item->taxonomy ) ) { 955 $menu_item->ID = $menu_item->term_id; 956 $menu_item->db_id = 0; 957 $menu_item->menu_item_parent = 0; 958 $menu_item->object_id = (int) $menu_item->term_id; 959 $menu_item->post_parent = (int) $menu_item->parent; 960 $menu_item->type = 'taxonomy'; 961 962 $object = get_taxonomy( $menu_item->taxonomy ); 963 $menu_item->object = $object->name; 964 $menu_item->type_label = $object->labels->singular_name; 965 966 $menu_item->title = $menu_item->name; 967 $menu_item->url = get_term_link( $menu_item, $menu_item->taxonomy ); 968 $menu_item->target = ''; 969 $menu_item->attr_title = ''; 970 $menu_item->description = get_term_field( 'description', $menu_item->term_id, $menu_item->taxonomy ); 971 $menu_item->classes = array(); 972 $menu_item->xfn = ''; 973 974 } 975 976 /** 977 * Filters a navigation menu item object. 978 * 979 * @since 3.0.0 980 * 981 * @param object $menu_item The menu item object. 982 */ 983 return apply_filters( 'wp_setup_nav_menu_item', $menu_item ); 984 } 985 986 /** 987 * Get the menu items associated with a particular object. 988 * 989 * @since 3.0.0 990 * 991 * @param int $object_id Optional. The ID of the original object. Default 0. 992 * @param string $object_type Optional. The type of object, such as 'post_type' or 'taxonomy'. 993 * Default 'post_type'. 994 * @param string $taxonomy Optional. If $object_type is 'taxonomy', $taxonomy is the name 995 * of the tax that $object_id belongs to. Default empty. 996 * @return int[] The array of menu item IDs; empty array if none. 997 */ 998 function wp_get_associated_nav_menu_items( $object_id = 0, $object_type = 'post_type', $taxonomy = '' ) { 999 $object_id = (int) $object_id; 1000 $menu_item_ids = array(); 1001 1002 $query = new WP_Query; 1003 $menu_items = $query->query( 1004 array( 1005 'meta_key' => '_menu_item_object_id', 1006 'meta_value' => $object_id, 1007 'post_status' => 'any', 1008 'post_type' => 'nav_menu_item', 1009 'posts_per_page' => -1, 1010 ) 1011 ); 1012 foreach ( (array) $menu_items as $menu_item ) { 1013 if ( isset( $menu_item->ID ) && is_nav_menu_item( $menu_item->ID ) ) { 1014 $menu_item_type = get_post_meta( $menu_item->ID, '_menu_item_type', true ); 1015 if ( 1016 'post_type' === $object_type && 1017 'post_type' === $menu_item_type 1018 ) { 1019 $menu_item_ids[] = (int) $menu_item->ID; 1020 } elseif ( 1021 'taxonomy' === $object_type && 1022 'taxonomy' === $menu_item_type && 1023 get_post_meta( $menu_item->ID, '_menu_item_object', true ) == $taxonomy 1024 ) { 1025 $menu_item_ids[] = (int) $menu_item->ID; 1026 } 1027 } 1028 } 1029 1030 return array_unique( $menu_item_ids ); 1031 } 1032 1033 /** 1034 * Callback for handling a menu item when its original object is deleted. 1035 * 1036 * @since 3.0.0 1037 * @access private 1038 * 1039 * @param int $object_id The ID of the original object being trashed. 1040 */ 1041 function _wp_delete_post_menu_item( $object_id ) { 1042 $object_id = (int) $object_id; 1043 1044 $menu_item_ids = wp_get_associated_nav_menu_items( $object_id, 'post_type' ); 1045 1046 foreach ( (array) $menu_item_ids as $menu_item_id ) { 1047 wp_delete_post( $menu_item_id, true ); 1048 } 1049 } 1050 1051 /** 1052 * Serves as a callback for handling a menu item when its original object is deleted. 1053 * 1054 * @since 3.0.0 1055 * @access private 1056 * 1057 * @param int $object_id The ID of the original object being trashed. 1058 * @param int $tt_id Term taxonomy ID. Unused. 1059 * @param string $taxonomy Taxonomy slug. 1060 */ 1061 function _wp_delete_tax_menu_item( $object_id, $tt_id, $taxonomy ) { 1062 $object_id = (int) $object_id; 1063 1064 $menu_item_ids = wp_get_associated_nav_menu_items( $object_id, 'taxonomy', $taxonomy ); 1065 1066 foreach ( (array) $menu_item_ids as $menu_item_id ) { 1067 wp_delete_post( $menu_item_id, true ); 1068 } 1069 } 1070 1071 /** 1072 * Automatically add newly published page objects to menus with that as an option. 1073 * 1074 * @since 3.0.0 1075 * @access private 1076 * 1077 * @param string $new_status The new status of the post object. 1078 * @param string $old_status The old status of the post object. 1079 * @param WP_Post $post The post object being transitioned from one status to another. 1080 */ 1081 function _wp_auto_add_pages_to_menu( $new_status, $old_status, $post ) { 1082 if ( 'publish' !== $new_status || 'publish' === $old_status || 'page' !== $post->post_type ) { 1083 return; 1084 } 1085 if ( ! empty( $post->post_parent ) ) { 1086 return; 1087 } 1088 $auto_add = get_option( 'nav_menu_options' ); 1089 if ( empty( $auto_add ) || ! is_array( $auto_add ) || ! isset( $auto_add['auto_add'] ) ) { 1090 return; 1091 } 1092 $auto_add = $auto_add['auto_add']; 1093 if ( empty( $auto_add ) || ! is_array( $auto_add ) ) { 1094 return; 1095 } 1096 1097 $args = array( 1098 'menu-item-object-id' => $post->ID, 1099 'menu-item-object' => $post->post_type, 1100 'menu-item-type' => 'post_type', 1101 'menu-item-status' => 'publish', 1102 ); 1103 1104 foreach ( $auto_add as $menu_id ) { 1105 $items = wp_get_nav_menu_items( $menu_id, array( 'post_status' => 'publish,draft' ) ); 1106 if ( ! is_array( $items ) ) { 1107 continue; 1108 } 1109 foreach ( $items as $item ) { 1110 if ( $post->ID == $item->object_id ) { 1111 continue 2; 1112 } 1113 } 1114 wp_update_nav_menu_item( $menu_id, 0, $args ); 1115 } 1116 } 1117 1118 /** 1119 * Delete auto-draft posts associated with the supplied changeset. 1120 * 1121 * @since 4.8.0 1122 * @access private 1123 * 1124 * @param int $post_id Post ID for the customize_changeset. 1125 */ 1126 function _wp_delete_customize_changeset_dependent_auto_drafts( $post_id ) { 1127 $post = get_post( $post_id ); 1128 1129 if ( ! $post || 'customize_changeset' !== $post->post_type ) { 1130 return; 1131 } 1132 1133 $data = json_decode( $post->post_content, true ); 1134 if ( empty( $data['nav_menus_created_posts']['value'] ) ) { 1135 return; 1136 } 1137 remove_action( 'delete_post', '_wp_delete_customize_changeset_dependent_auto_drafts' ); 1138 foreach ( $data['nav_menus_created_posts']['value'] as $stub_post_id ) { 1139 if ( empty( $stub_post_id ) ) { 1140 continue; 1141 } 1142 if ( 'auto-draft' === get_post_status( $stub_post_id ) ) { 1143 wp_delete_post( $stub_post_id, true ); 1144 } elseif ( 'draft' === get_post_status( $stub_post_id ) ) { 1145 wp_trash_post( $stub_post_id ); 1146 delete_post_meta( $stub_post_id, '_customize_changeset_uuid' ); 1147 } 1148 } 1149 add_action( 'delete_post', '_wp_delete_customize_changeset_dependent_auto_drafts' ); 1150 } 1151 1152 /** 1153 * Handle menu config after theme change. 1154 * 1155 * @access private 1156 * @since 4.9.0 1157 */ 1158 function _wp_menus_changed() { 1159 $old_nav_menu_locations = get_option( 'theme_switch_menu_locations', array() ); 1160 $new_nav_menu_locations = get_nav_menu_locations(); 1161 $mapped_nav_menu_locations = wp_map_nav_menu_locations( $new_nav_menu_locations, $old_nav_menu_locations ); 1162 1163 set_theme_mod( 'nav_menu_locations', $mapped_nav_menu_locations ); 1164 delete_option( 'theme_switch_menu_locations' ); 1165 } 1166 1167 /** 1168 * Maps nav menu locations according to assignments in previously active theme. 1169 * 1170 * @since 4.9.0 1171 * 1172 * @param array $new_nav_menu_locations New nav menu locations assignments. 1173 * @param array $old_nav_menu_locations Old nav menu locations assignments. 1174 * @return array Nav menus mapped to new nav menu locations. 1175 */ 1176 function wp_map_nav_menu_locations( $new_nav_menu_locations, $old_nav_menu_locations ) { 1177 $registered_nav_menus = get_registered_nav_menus(); 1178 $new_nav_menu_locations = array_intersect_key( $new_nav_menu_locations, $registered_nav_menus ); 1179 1180 // Short-circuit if there are no old nav menu location assignments to map. 1181 if ( empty( $old_nav_menu_locations ) ) { 1182 return $new_nav_menu_locations; 1183 } 1184 1185 // If old and new theme have just one location, map it and we're done. 1186 if ( 1 === count( $old_nav_menu_locations ) && 1 === count( $registered_nav_menus ) ) { 1187 $new_nav_menu_locations[ key( $registered_nav_menus ) ] = array_pop( $old_nav_menu_locations ); 1188 return $new_nav_menu_locations; 1189 } 1190 1191 $old_locations = array_keys( $old_nav_menu_locations ); 1192 1193 // Map locations with the same slug. 1194 foreach ( $registered_nav_menus as $location => $name ) { 1195 if ( in_array( $location, $old_locations, true ) ) { 1196 $new_nav_menu_locations[ $location ] = $old_nav_menu_locations[ $location ]; 1197 unset( $old_nav_menu_locations[ $location ] ); 1198 } 1199 } 1200 1201 // If there are no old nav menu locations left, then we're done. 1202 if ( empty( $old_nav_menu_locations ) ) { 1203 return $new_nav_menu_locations; 1204 } 1205 1206 /* 1207 * If old and new theme both have locations that contain phrases 1208 * from within the same group, make an educated guess and map it. 1209 */ 1210 $common_slug_groups = array( 1211 array( 'primary', 'menu-1', 'main', 'header', 'navigation', 'top' ), 1212 array( 'secondary', 'menu-2', 'footer', 'subsidiary', 'bottom' ), 1213 array( 'social' ), 1214 ); 1215 1216 // Go through each group... 1217 foreach ( $common_slug_groups as $slug_group ) { 1218 1219 // ...and see if any of these slugs... 1220 foreach ( $slug_group as $slug ) { 1221 1222 // ...and any of the new menu locations... 1223 foreach ( $registered_nav_menus as $new_location => $name ) { 1224 1225 // ...actually match! 1226 if ( is_string( $new_location ) && false === stripos( $new_location, $slug ) && false === stripos( $slug, $new_location ) ) { 1227 continue; 1228 } elseif ( is_numeric( $new_location ) && $new_location !== $slug ) { 1229 continue; 1230 } 1231 1232 // Then see if any of the old locations... 1233 foreach ( $old_nav_menu_locations as $location => $menu_id ) { 1234 1235 // ...and any slug in the same group... 1236 foreach ( $slug_group as $slug ) { 1237 1238 // ... have a match as well. 1239 if ( is_string( $location ) && false === stripos( $location, $slug ) && false === stripos( $slug, $location ) ) { 1240 continue; 1241 } elseif ( is_numeric( $location ) && $location !== $slug ) { 1242 continue; 1243 } 1244 1245 // Make sure this location wasn't mapped and removed previously. 1246 if ( ! empty( $old_nav_menu_locations[ $location ] ) ) { 1247 1248 // We have a match that can be mapped! 1249 $new_nav_menu_locations[ $new_location ] = $old_nav_menu_locations[ $location ]; 1250 1251 // Remove the mapped location so it can't be mapped again. 1252 unset( $old_nav_menu_locations[ $location ] ); 1253 1254 // Go back and check the next new menu location. 1255 continue 3; 1256 } 1257 } // End foreach ( $slug_group as $slug ). 1258 } // End foreach ( $old_nav_menu_locations as $location => $menu_id ). 1259 } // End foreach foreach ( $registered_nav_menus as $new_location => $name ). 1260 } // End foreach ( $slug_group as $slug ). 1261 } // End foreach ( $common_slug_groups as $slug_group ). 1262 1263 return $new_nav_menu_locations; 1264 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Wed Nov 25 01:00:04 2020 | Cross-referenced by PHPXref 0.7.1 |