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