| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Toolbar API: Top-level Toolbar functionality 4 * 5 * @package WordPress 6 * @subpackage Toolbar 7 * @since 3.1.0 8 */ 9 10 /** 11 * Instantiates the admin bar object and set it up as a global for access elsewhere. 12 * 13 * UNHOOKING THIS FUNCTION WILL NOT PROPERLY REMOVE THE ADMIN BAR. 14 * For that, use show_admin_bar(false) or the {@see 'show_admin_bar'} filter. 15 * 16 * @since 3.1.0 17 * @access private 18 * 19 * @global WP_Admin_Bar $wp_admin_bar 20 * 21 * @return bool Whether the admin bar was successfully initialized. 22 */ 23 function _wp_admin_bar_init() { 24 global $wp_admin_bar; 25 26 if ( ! is_admin_bar_showing() ) { 27 return false; 28 } 29 30 /* Load the admin bar class code ready for instantiation */ 31 require_once ABSPATH . WPINC . '/class-wp-admin-bar.php'; 32 33 /* Instantiate the admin bar */ 34 35 /** 36 * Filters the admin bar class to instantiate. 37 * 38 * @since 3.1.0 39 * 40 * @param string $wp_admin_bar_class Admin bar class to use. Default 'WP_Admin_Bar'. 41 */ 42 $admin_bar_class = apply_filters( 'wp_admin_bar_class', 'WP_Admin_Bar' ); 43 if ( class_exists( $admin_bar_class ) ) { 44 $wp_admin_bar = new $admin_bar_class(); 45 } else { 46 return false; 47 } 48 49 $wp_admin_bar->initialize(); 50 $wp_admin_bar->add_menus(); 51 52 return true; 53 } 54 55 /** 56 * Renders the admin bar to the page based on the $wp_admin_bar->menu member var. 57 * 58 * This is called very early on the {@see 'wp_body_open'} action so that it will render 59 * before anything else being added to the page body. 60 * 61 * For backward compatibility with themes not using the 'wp_body_open' action, 62 * the function is also called late on {@see 'wp_footer'}. 63 * 64 * It includes the {@see 'admin_bar_menu'} action which should be used to hook in and 65 * add new menus to the admin bar. This also gives you access to the `$post` global, 66 * among others. 67 * 68 * @since 3.1.0 69 * @since 5.4.0 Called on 'wp_body_open' action first, with 'wp_footer' as a fallback. 70 * 71 * @global WP_Admin_Bar $wp_admin_bar 72 */ 73 function wp_admin_bar_render() { 74 global $wp_admin_bar; 75 static $rendered = false; 76 77 if ( $rendered ) { 78 return; 79 } 80 81 if ( ! is_admin_bar_showing() || ! is_object( $wp_admin_bar ) ) { 82 return; 83 } 84 85 /** 86 * Loads all necessary admin bar items. 87 * 88 * This hook can add, remove, or manipulate admin bar items. The priority 89 * determines the placement for new items, and changes to existing items 90 * would require a high priority. To remove or manipulate existing nodes 91 * without a specific priority, use `wp_before_admin_bar_render`. 92 * 93 * @since 3.1.0 94 * 95 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance, passed by reference. 96 */ 97 do_action_ref_array( 'admin_bar_menu', array( &$wp_admin_bar ) ); 98 99 /** 100 * Fires before the admin bar is rendered. 101 * 102 * @since 3.1.0 103 */ 104 do_action( 'wp_before_admin_bar_render' ); 105 106 $wp_admin_bar->render(); 107 108 /** 109 * Fires after the admin bar is rendered. 110 * 111 * @since 3.1.0 112 */ 113 do_action( 'wp_after_admin_bar_render' ); 114 115 $rendered = true; 116 } 117 118 /** 119 * Adds the WordPress logo menu. 120 * 121 * @since 3.3.0 122 * 123 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 124 */ 125 function wp_admin_bar_wp_menu( $wp_admin_bar ) { 126 if ( current_user_can( 'read' ) ) { 127 $about_url = self_admin_url( 'about.php' ); 128 $contribute_url = self_admin_url( 'contribute.php' ); 129 } elseif ( is_multisite() ) { 130 $about_url = get_dashboard_url( get_current_user_id(), 'about.php' ); 131 $contribute_url = get_dashboard_url( get_current_user_id(), 'contribute.php' ); 132 } else { 133 $about_url = false; 134 $contribute_url = false; 135 } 136 137 $wp_logo_menu_args = array( 138 'id' => 'wp-logo', 139 'title' => '<span class="ab-icon" aria-hidden="true"></span><span class="screen-reader-text">' . 140 /* translators: Hidden accessibility text. */ 141 __( 'About WordPress' ) . 142 '</span>', 143 'href' => $about_url, 144 'meta' => array( 145 'menu_title' => __( 'About WordPress' ), 146 ), 147 ); 148 149 // Set tabindex="0" to make sub menus accessible when no URL is available. 150 if ( ! $about_url ) { 151 $wp_logo_menu_args['meta'] = array( 152 'tabindex' => 0, 153 ); 154 } 155 156 $wp_admin_bar->add_node( $wp_logo_menu_args ); 157 158 if ( $about_url ) { 159 // Add "About WordPress" link. 160 $wp_admin_bar->add_node( 161 array( 162 'parent' => 'wp-logo', 163 'id' => 'about', 164 'title' => __( 'About WordPress' ), 165 'href' => $about_url, 166 ) 167 ); 168 } 169 170 if ( $contribute_url ) { 171 // Add contribute link. 172 $wp_admin_bar->add_node( 173 array( 174 'parent' => 'wp-logo', 175 'id' => 'contribute', 176 'title' => __( 'Get Involved' ), 177 'href' => $contribute_url, 178 ) 179 ); 180 } 181 182 // Add WordPress.org link. 183 $wp_admin_bar->add_node( 184 array( 185 'parent' => 'wp-logo-external', 186 'id' => 'wporg', 187 'title' => __( 'WordPress.org' ), 188 'href' => __( 'https://wordpress.org/' ), 189 ) 190 ); 191 192 // Add documentation link. 193 $wp_admin_bar->add_node( 194 array( 195 'parent' => 'wp-logo-external', 196 'id' => 'documentation', 197 'title' => __( 'Documentation' ), 198 'href' => __( 'https://wordpress.org/documentation/' ), 199 ) 200 ); 201 202 // Add learn link. 203 $wp_admin_bar->add_node( 204 array( 205 'parent' => 'wp-logo-external', 206 'id' => 'learn', 207 'title' => __( 'Learn WordPress' ), 208 'href' => __( 'https://learn.wordpress.org/' ), 209 ) 210 ); 211 212 // Add forums link. 213 $wp_admin_bar->add_node( 214 array( 215 'parent' => 'wp-logo-external', 216 'id' => 'support-forums', 217 'title' => __( 'Support' ), 218 'href' => __( 'https://wordpress.org/support/forums/' ), 219 ) 220 ); 221 222 // Add feedback link. 223 $wp_admin_bar->add_node( 224 array( 225 'parent' => 'wp-logo-external', 226 'id' => 'feedback', 227 'title' => __( 'Feedback' ), 228 'href' => __( 'https://wordpress.org/support/forum/requests-and-feedback' ), 229 ) 230 ); 231 } 232 233 /** 234 * Adds the sidebar toggle button. 235 * 236 * @since 3.8.0 237 * 238 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 239 */ 240 function wp_admin_bar_sidebar_toggle( $wp_admin_bar ) { 241 if ( is_admin() ) { 242 $wp_admin_bar->add_node( 243 array( 244 'id' => 'menu-toggle', 245 'title' => '<span class="ab-icon" aria-hidden="true"></span><span class="screen-reader-text">' . 246 /* translators: Hidden accessibility text. */ 247 __( 'Menu' ) . 248 '</span>', 249 'href' => '#', 250 ) 251 ); 252 } 253 } 254 255 /** 256 * Adds the "My Account" item. 257 * 258 * @since 3.3.0 259 * 260 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 261 */ 262 function wp_admin_bar_my_account_item( $wp_admin_bar ) { 263 $user_id = get_current_user_id(); 264 $current_user = wp_get_current_user(); 265 266 if ( ! $user_id ) { 267 return; 268 } 269 270 if ( current_user_can( 'read' ) ) { 271 $profile_url = get_edit_profile_url( $user_id ); 272 } elseif ( is_multisite() ) { 273 $profile_url = get_dashboard_url( $user_id, 'profile.php' ); 274 } else { 275 $profile_url = false; 276 } 277 278 $avatar = get_avatar( $user_id, 26 ); 279 /* translators: %s: Current user's display name. */ 280 $howdy = sprintf( __( 'Howdy, %s' ), '<span class="display-name">' . $current_user->display_name . '</span>' ); 281 $class = empty( $avatar ) ? '' : 'with-avatar'; 282 283 $wp_admin_bar->add_node( 284 array( 285 'id' => 'my-account', 286 'parent' => 'top-secondary', 287 'title' => $howdy . $avatar, 288 'href' => $profile_url, 289 'meta' => array( 290 'class' => $class, 291 /* translators: %s: Current user's display name. */ 292 'menu_title' => sprintf( __( 'Howdy, %s' ), $current_user->display_name ), 293 'tabindex' => ( false !== $profile_url ) ? '' : 0, 294 ), 295 ) 296 ); 297 } 298 299 /** 300 * Adds the "My Account" submenu items. 301 * 302 * @since 3.1.0 303 * 304 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 305 */ 306 function wp_admin_bar_my_account_menu( $wp_admin_bar ) { 307 $user_id = get_current_user_id(); 308 $current_user = wp_get_current_user(); 309 310 if ( ! $user_id ) { 311 return; 312 } 313 314 if ( current_user_can( 'read' ) ) { 315 $profile_url = get_edit_profile_url( $user_id ); 316 } elseif ( is_multisite() ) { 317 $profile_url = get_dashboard_url( $user_id, 'profile.php' ); 318 } else { 319 $profile_url = false; 320 } 321 322 $wp_admin_bar->add_group( 323 array( 324 'parent' => 'my-account', 325 'id' => 'user-actions', 326 ) 327 ); 328 329 $user_info = get_avatar( $user_id, 64 ); 330 $user_info .= "<span class='display-name'>{$current_user->display_name}</span>"; 331 332 if ( $current_user->display_name !== $current_user->user_login ) { 333 $user_info .= "<span class='username'>{$current_user->user_login}</span>"; 334 } 335 336 if ( false !== $profile_url ) { 337 $user_info .= "<span class='display-name edit-profile'>" . __( 'Edit Profile' ) . '</span>'; 338 } 339 340 $wp_admin_bar->add_node( 341 array( 342 'parent' => 'user-actions', 343 'id' => 'user-info', 344 'title' => $user_info, 345 'href' => $profile_url, 346 ) 347 ); 348 349 $wp_admin_bar->add_node( 350 array( 351 'parent' => 'user-actions', 352 'id' => 'logout', 353 'title' => __( 'Log Out' ), 354 'href' => wp_logout_url(), 355 ) 356 ); 357 } 358 359 /** 360 * Adds the "Site Name" menu. 361 * 362 * @since 3.3.0 363 * 364 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 365 */ 366 function wp_admin_bar_site_menu( $wp_admin_bar ) { 367 // Don't show for logged out users. 368 if ( ! is_user_logged_in() ) { 369 return; 370 } 371 372 // Show only when the user is a member of this site, or they're a super admin. 373 if ( ! is_user_member_of_blog() && ! current_user_can( 'manage_network' ) ) { 374 return; 375 } 376 377 $blogname = get_bloginfo( 'name' ); 378 379 if ( ! $blogname ) { 380 $blogname = preg_replace( '#^(https?://)?(www.)?#', '', get_home_url() ); 381 } 382 383 if ( is_network_admin() ) { 384 /* translators: %s: Site title. */ 385 $blogname = sprintf( __( 'Network Admin: %s' ), esc_html( get_network()->site_name ) ); 386 } elseif ( is_user_admin() ) { 387 /* translators: %s: Site title. */ 388 $blogname = sprintf( __( 'User Dashboard: %s' ), esc_html( get_network()->site_name ) ); 389 } 390 391 $title = wp_html_excerpt( $blogname, 40, '…' ); 392 393 $wp_admin_bar->add_node( 394 array( 395 'id' => 'site-name', 396 'title' => $title, 397 'href' => ( is_admin() || ! current_user_can( 'read' ) ) ? home_url( '/' ) : admin_url(), 398 'meta' => array( 399 'menu_title' => $title, 400 ), 401 ) 402 ); 403 404 // Create submenu items. 405 406 if ( is_admin() ) { 407 // Add an option to visit the site. 408 $wp_admin_bar->add_node( 409 array( 410 'parent' => 'site-name', 411 'id' => 'view-site', 412 'title' => __( 'Visit Site' ), 413 'href' => home_url( '/' ), 414 ) 415 ); 416 417 if ( is_blog_admin() && is_multisite() && current_user_can( 'manage_sites' ) ) { 418 $wp_admin_bar->add_node( 419 array( 420 'parent' => 'site-name', 421 'id' => 'edit-site', 422 'title' => __( 'Manage Site' ), 423 'href' => network_admin_url( 'site-info.php?id=' . get_current_blog_id() ), 424 ) 425 ); 426 } 427 } elseif ( current_user_can( 'read' ) ) { 428 // We're on the front end, link to the Dashboard. 429 $wp_admin_bar->add_node( 430 array( 431 'parent' => 'site-name', 432 'id' => 'dashboard', 433 'title' => __( 'Dashboard' ), 434 'href' => admin_url(), 435 ) 436 ); 437 438 // Add the appearance submenu items. 439 wp_admin_bar_appearance_menu( $wp_admin_bar ); 440 441 // Add a Plugins link. 442 if ( current_user_can( 'activate_plugins' ) ) { 443 $wp_admin_bar->add_node( 444 array( 445 'parent' => 'site-name', 446 'id' => 'plugins', 447 'title' => __( 'Plugins' ), 448 'href' => admin_url( 'plugins.php' ), 449 ) 450 ); 451 } 452 } 453 } 454 455 /** 456 * Adds the "Edit Site" link to the Toolbar. 457 * 458 * @since 5.9.0 459 * @since 6.3.0 Added `$_wp_current_template_id` global for editing of current template directly from the admin bar. 460 * @since 6.6.0 Added the `canvas` query arg to the Site Editor link. 461 * @since 6.8.0 Removed the query args to ensure that the link opens the starting screen of the Site Editor. 462 * 463 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 464 */ 465 function wp_admin_bar_edit_site_menu( $wp_admin_bar ) { 466 467 // Don't show if a block theme is not activated. 468 if ( ! wp_is_block_theme() ) { 469 return; 470 } 471 472 // Don't show for users who can't edit theme options. 473 if ( ! current_user_can( 'edit_theme_options' ) ) { 474 return; 475 } 476 477 $wp_admin_bar->add_node( 478 array( 479 'id' => 'site-editor', 480 'title' => __( 'Edit Site' ), 481 'href' => admin_url( 'site-editor.php' ), 482 ) 483 ); 484 } 485 486 /** 487 * Adds the "Customize" link to the Toolbar. 488 * 489 * @since 4.3.0 490 * 491 * @global WP_Customize_Manager $wp_customize 492 * 493 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 494 */ 495 function wp_admin_bar_customize_menu( $wp_admin_bar ) { 496 global $wp_customize; 497 498 // Don't show if a block theme is activated and no plugins use the customizer. 499 if ( wp_is_block_theme() && ! has_action( 'customize_register' ) ) { 500 return; 501 } 502 503 // Don't show for users who can't access the customizer or when in the admin. 504 if ( ! current_user_can( 'customize' ) || is_admin() ) { 505 return; 506 } 507 508 // Don't show if the user cannot edit a given customize_changeset post currently being previewed. 509 if ( is_customize_preview() && $wp_customize->changeset_post_id() 510 && ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->edit_post, $wp_customize->changeset_post_id() ) 511 ) { 512 return; 513 } 514 515 $current_url = ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']; 516 if ( is_customize_preview() && $wp_customize->changeset_uuid() ) { 517 $current_url = remove_query_arg( 'customize_changeset_uuid', $current_url ); 518 } 519 520 $customize_url = add_query_arg( 'url', urlencode( $current_url ), wp_customize_url() ); 521 if ( is_customize_preview() ) { 522 $customize_url = add_query_arg( array( 'changeset_uuid' => $wp_customize->changeset_uuid() ), $customize_url ); 523 } 524 525 $wp_admin_bar->add_node( 526 array( 527 'id' => 'customize', 528 'title' => __( 'Customize' ), 529 'href' => $customize_url, 530 'meta' => array( 531 'class' => 'hide-if-no-customize', 532 ), 533 ) 534 ); 535 add_action( 'wp_before_admin_bar_render', 'wp_customize_support_script' ); 536 } 537 538 /** 539 * Adds the "My Sites/[Site Name]" menu and all submenus. 540 * 541 * @since 3.1.0 542 * 543 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 544 */ 545 function wp_admin_bar_my_sites_menu( $wp_admin_bar ) { 546 // Don't show for logged out users or single site mode. 547 if ( ! is_user_logged_in() || ! is_multisite() ) { 548 return; 549 } 550 551 // Show only when the user has at least one site, or they're a super admin. 552 if ( count( $wp_admin_bar->user->blogs ) < 1 && ! current_user_can( 'manage_network' ) ) { 553 return; 554 } 555 556 if ( $wp_admin_bar->user->active_blog ) { 557 $my_sites_url = get_admin_url( $wp_admin_bar->user->active_blog->blog_id, 'my-sites.php' ); 558 } else { 559 $my_sites_url = admin_url( 'my-sites.php' ); 560 } 561 562 $wp_admin_bar->add_node( 563 array( 564 'id' => 'my-sites', 565 'title' => __( 'My Sites' ), 566 'href' => $my_sites_url, 567 ) 568 ); 569 570 if ( current_user_can( 'manage_network' ) ) { 571 $wp_admin_bar->add_group( 572 array( 573 'parent' => 'my-sites', 574 'id' => 'my-sites-super-admin', 575 ) 576 ); 577 578 $wp_admin_bar->add_node( 579 array( 580 'parent' => 'my-sites-super-admin', 581 'id' => 'network-admin', 582 'title' => __( 'Network Admin' ), 583 'href' => network_admin_url(), 584 ) 585 ); 586 587 $wp_admin_bar->add_node( 588 array( 589 'parent' => 'network-admin', 590 'id' => 'network-admin-d', 591 'title' => __( 'Dashboard' ), 592 'href' => network_admin_url(), 593 ) 594 ); 595 596 if ( current_user_can( 'manage_sites' ) ) { 597 $wp_admin_bar->add_node( 598 array( 599 'parent' => 'network-admin', 600 'id' => 'network-admin-s', 601 'title' => __( 'Sites' ), 602 'href' => network_admin_url( 'sites.php' ), 603 ) 604 ); 605 } 606 607 if ( current_user_can( 'manage_network_users' ) ) { 608 $wp_admin_bar->add_node( 609 array( 610 'parent' => 'network-admin', 611 'id' => 'network-admin-u', 612 'title' => __( 'Users' ), 613 'href' => network_admin_url( 'users.php' ), 614 ) 615 ); 616 } 617 618 if ( current_user_can( 'manage_network_themes' ) ) { 619 $wp_admin_bar->add_node( 620 array( 621 'parent' => 'network-admin', 622 'id' => 'network-admin-t', 623 'title' => __( 'Themes' ), 624 'href' => network_admin_url( 'themes.php' ), 625 ) 626 ); 627 } 628 629 if ( current_user_can( 'manage_network_plugins' ) ) { 630 $wp_admin_bar->add_node( 631 array( 632 'parent' => 'network-admin', 633 'id' => 'network-admin-p', 634 'title' => __( 'Plugins' ), 635 'href' => network_admin_url( 'plugins.php' ), 636 ) 637 ); 638 } 639 640 if ( current_user_can( 'manage_network_options' ) ) { 641 $wp_admin_bar->add_node( 642 array( 643 'parent' => 'network-admin', 644 'id' => 'network-admin-o', 645 'title' => __( 'Settings' ), 646 'href' => network_admin_url( 'settings.php' ), 647 ) 648 ); 649 } 650 } 651 652 // Add site links. 653 $wp_admin_bar->add_group( 654 array( 655 'parent' => 'my-sites', 656 'id' => 'my-sites-list', 657 'meta' => array( 658 'class' => current_user_can( 'manage_network' ) ? 'ab-sub-secondary' : '', 659 ), 660 ) 661 ); 662 663 /** 664 * Filters whether to show the site icons in toolbar. 665 * 666 * Returning false to this hook is the recommended way to hide site icons in the toolbar. 667 * A truthy return may have negative performance impact on large multisites. 668 * 669 * @since 6.0.0 670 * 671 * @param bool $show_site_icons Whether site icons should be shown in the toolbar. Default true. 672 */ 673 $show_site_icons = apply_filters( 'wp_admin_bar_show_site_icons', true ); 674 675 foreach ( (array) $wp_admin_bar->user->blogs as $blog ) { 676 switch_to_blog( $blog->userblog_id ); 677 678 if ( true === $show_site_icons && has_site_icon() ) { 679 $blavatar = sprintf( 680 '<img class="blavatar" src="%s" srcset="%s 2x" alt="" width="16" height="16"%s />', 681 esc_url( get_site_icon_url( 16 ) ), 682 esc_url( get_site_icon_url( 32 ) ), 683 ( wp_lazy_loading_enabled( 'img', 'site_icon_in_toolbar' ) ? ' loading="lazy"' : '' ) 684 ); 685 } else { 686 $blavatar = '<div class="blavatar"></div>'; 687 } 688 689 $blogname = $blog->blogname; 690 691 if ( ! $blogname ) { 692 $blogname = preg_replace( '#^(https?://)?(www.)?#', '', get_home_url() ); 693 } 694 695 $menu_id = 'blog-' . $blog->userblog_id; 696 697 if ( current_user_can( 'read' ) ) { 698 $wp_admin_bar->add_node( 699 array( 700 'parent' => 'my-sites-list', 701 'id' => $menu_id, 702 'title' => $blavatar . $blogname, 703 'href' => admin_url(), 704 ) 705 ); 706 707 $wp_admin_bar->add_node( 708 array( 709 'parent' => $menu_id, 710 'id' => $menu_id . '-d', 711 'title' => __( 'Dashboard' ), 712 'href' => admin_url(), 713 ) 714 ); 715 } else { 716 $wp_admin_bar->add_node( 717 array( 718 'parent' => 'my-sites-list', 719 'id' => $menu_id, 720 'title' => $blavatar . $blogname, 721 'href' => home_url(), 722 ) 723 ); 724 } 725 726 if ( current_user_can( get_post_type_object( 'post' )->cap->create_posts ) ) { 727 $wp_admin_bar->add_node( 728 array( 729 'parent' => $menu_id, 730 'id' => $menu_id . '-n', 731 'title' => get_post_type_object( 'post' )->labels->new_item, 732 'href' => admin_url( 'post-new.php' ), 733 ) 734 ); 735 } 736 737 if ( current_user_can( 'edit_posts' ) ) { 738 $wp_admin_bar->add_node( 739 array( 740 'parent' => $menu_id, 741 'id' => $menu_id . '-c', 742 'title' => __( 'Manage Comments' ), 743 'href' => admin_url( 'edit-comments.php' ), 744 ) 745 ); 746 } 747 748 $wp_admin_bar->add_node( 749 array( 750 'parent' => $menu_id, 751 'id' => $menu_id . '-v', 752 'title' => __( 'Visit Site' ), 753 'href' => home_url( '/' ), 754 ) 755 ); 756 757 restore_current_blog(); 758 } 759 } 760 761 /** 762 * Provides a shortlink. 763 * 764 * @since 3.1.0 765 * 766 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 767 */ 768 function wp_admin_bar_shortlink_menu( $wp_admin_bar ) { 769 $short = wp_get_shortlink( 0, 'query' ); 770 $id = 'get-shortlink'; 771 772 if ( empty( $short ) ) { 773 return; 774 } 775 776 $html = '<input class="shortlink-input" type="text" readonly="readonly" value="' . esc_attr( $short ) . '" aria-label="' . __( 'Shortlink' ) . '" />'; 777 778 $wp_admin_bar->add_node( 779 array( 780 'id' => $id, 781 'title' => __( 'Shortlink' ), 782 'href' => $short, 783 'meta' => array( 'html' => $html ), 784 ) 785 ); 786 } 787 788 /** 789 * Provides an edit link for posts and terms. 790 * 791 * @since 3.1.0 792 * @since 5.5.0 Added a "View Post" link on Comments screen for a single post. 793 * 794 * @global WP_Term $tag 795 * @global WP_Query $wp_the_query WordPress Query object. 796 * @global int $user_id The ID of the user being edited. Not to be confused with the 797 * global $user_ID, which contains the ID of the current user. 798 * @global int $post_id The ID of the post when editing comments for a single post. 799 * 800 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 801 */ 802 function wp_admin_bar_edit_menu( $wp_admin_bar ) { 803 global $tag, $wp_the_query, $user_id, $post_id; 804 805 if ( is_admin() ) { 806 $current_screen = get_current_screen(); 807 $post = get_post(); 808 $post_type_object = null; 809 810 if ( 'post' === $current_screen->base ) { 811 $post_type_object = get_post_type_object( $post->post_type ); 812 } elseif ( 'edit' === $current_screen->base ) { 813 $post_type_object = get_post_type_object( $current_screen->post_type ); 814 } elseif ( 'edit-comments' === $current_screen->base && $post_id ) { 815 $post = get_post( $post_id ); 816 if ( $post ) { 817 $post_type_object = get_post_type_object( $post->post_type ); 818 } 819 } 820 821 if ( ( 'post' === $current_screen->base || 'edit-comments' === $current_screen->base ) 822 && 'add' !== $current_screen->action 823 && ( $post_type_object ) 824 && current_user_can( 'read_post', $post->ID ) 825 && ( $post_type_object->public ) 826 && ( $post_type_object->show_in_admin_bar ) ) { 827 if ( 'draft' === $post->post_status ) { 828 $preview_link = get_preview_post_link( $post ); 829 $wp_admin_bar->add_node( 830 array( 831 'id' => 'preview', 832 'title' => $post_type_object->labels->view_item, 833 'href' => esc_url( $preview_link ), 834 'meta' => array( 'target' => 'wp-preview-' . $post->ID ), 835 ) 836 ); 837 } else { 838 $wp_admin_bar->add_node( 839 array( 840 'id' => 'view', 841 'title' => $post_type_object->labels->view_item, 842 'href' => get_permalink( $post->ID ), 843 ) 844 ); 845 } 846 } elseif ( 'edit' === $current_screen->base 847 && ( $post_type_object ) 848 && ( $post_type_object->public ) 849 && ( $post_type_object->show_in_admin_bar ) 850 && ( get_post_type_archive_link( $post_type_object->name ) ) 851 && ! ( 'post' === $post_type_object->name && 'posts' === get_option( 'show_on_front' ) ) ) { 852 $wp_admin_bar->add_node( 853 array( 854 'id' => 'archive', 855 'title' => $post_type_object->labels->view_items, 856 'href' => get_post_type_archive_link( $current_screen->post_type ), 857 ) 858 ); 859 } elseif ( 'term' === $current_screen->base && isset( $tag ) && is_object( $tag ) && ! is_wp_error( $tag ) ) { 860 $tax = get_taxonomy( $tag->taxonomy ); 861 if ( is_term_publicly_viewable( $tag ) ) { 862 $wp_admin_bar->add_node( 863 array( 864 'id' => 'view', 865 'title' => $tax->labels->view_item, 866 'href' => get_term_link( $tag ), 867 ) 868 ); 869 } 870 } elseif ( 'user-edit' === $current_screen->base && isset( $user_id ) ) { 871 $user_object = get_userdata( $user_id ); 872 $view_link = get_author_posts_url( $user_object->ID ); 873 if ( $user_object->exists() && $view_link ) { 874 $wp_admin_bar->add_node( 875 array( 876 'id' => 'view', 877 'title' => __( 'View User' ), 878 'href' => $view_link, 879 ) 880 ); 881 } 882 } 883 } else { 884 $current_object = $wp_the_query->get_queried_object(); 885 886 if ( empty( $current_object ) ) { 887 return; 888 } 889 890 if ( ! empty( $current_object->post_type ) ) { 891 $post_type_object = get_post_type_object( $current_object->post_type ); 892 $edit_post_link = get_edit_post_link( $current_object->ID ); 893 if ( $post_type_object 894 && $edit_post_link 895 && current_user_can( 'edit_post', $current_object->ID ) 896 && $post_type_object->show_in_admin_bar ) { 897 $wp_admin_bar->add_node( 898 array( 899 'id' => 'edit', 900 'title' => $post_type_object->labels->edit_item, 901 'href' => $edit_post_link, 902 ) 903 ); 904 } 905 } elseif ( ! empty( $current_object->taxonomy ) ) { 906 $tax = get_taxonomy( $current_object->taxonomy ); 907 $edit_term_link = get_edit_term_link( $current_object->term_id, $current_object->taxonomy ); 908 if ( $tax && $edit_term_link && current_user_can( 'edit_term', $current_object->term_id ) ) { 909 $wp_admin_bar->add_node( 910 array( 911 'id' => 'edit', 912 'title' => $tax->labels->edit_item, 913 'href' => $edit_term_link, 914 ) 915 ); 916 } 917 } elseif ( $current_object instanceof WP_User && current_user_can( 'edit_user', $current_object->ID ) ) { 918 $edit_user_link = get_edit_user_link( $current_object->ID ); 919 if ( $edit_user_link ) { 920 $wp_admin_bar->add_node( 921 array( 922 'id' => 'edit', 923 'title' => __( 'Edit User' ), 924 'href' => $edit_user_link, 925 ) 926 ); 927 } 928 } 929 } 930 } 931 932 /** 933 * Adds "Add New" menu. 934 * 935 * @since 3.1.0 936 * @since 6.5.0 Added a New Site link for network installations. 937 * 938 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 939 */ 940 function wp_admin_bar_new_content_menu( $wp_admin_bar ) { 941 $actions = array(); 942 943 $cpts = (array) get_post_types( array( 'show_in_admin_bar' => true ), 'objects' ); 944 945 if ( isset( $cpts['post'] ) && current_user_can( $cpts['post']->cap->create_posts ) ) { 946 $actions['post-new.php'] = array( $cpts['post']->labels->name_admin_bar, 'new-post' ); 947 } 948 949 if ( isset( $cpts['attachment'] ) && current_user_can( 'upload_files' ) ) { 950 $actions['media-new.php'] = array( $cpts['attachment']->labels->name_admin_bar, 'new-media' ); 951 } 952 953 if ( current_user_can( 'manage_links' ) ) { 954 $actions['link-add.php'] = array( _x( 'Link', 'add new from admin bar' ), 'new-link' ); 955 } 956 957 if ( isset( $cpts['page'] ) && current_user_can( $cpts['page']->cap->create_posts ) ) { 958 $actions['post-new.php?post_type=page'] = array( $cpts['page']->labels->name_admin_bar, 'new-page' ); 959 } 960 961 unset( $cpts['post'], $cpts['page'], $cpts['attachment'] ); 962 963 // Add any additional custom post types. 964 foreach ( $cpts as $cpt ) { 965 if ( ! current_user_can( $cpt->cap->create_posts ) ) { 966 continue; 967 } 968 969 $key = 'post-new.php?post_type=' . $cpt->name; 970 $actions[ $key ] = array( $cpt->labels->name_admin_bar, 'new-' . $cpt->name ); 971 } 972 // Avoid clash with parent node and a 'content' post type. 973 if ( isset( $actions['post-new.php?post_type=content'] ) ) { 974 $actions['post-new.php?post_type=content'][1] = 'add-new-content'; 975 } 976 977 if ( current_user_can( 'create_users' ) || ( is_multisite() && current_user_can( 'promote_users' ) ) ) { 978 $actions['user-new.php'] = array( _x( 'User', 'add new from admin bar' ), 'new-user' ); 979 } 980 981 if ( ! $actions ) { 982 return; 983 } 984 985 $title = '<span class="ab-icon" aria-hidden="true"></span><span class="ab-label">' . _x( 'New', 'admin bar menu group label' ) . '</span>'; 986 987 $wp_admin_bar->add_node( 988 array( 989 'id' => 'new-content', 990 'title' => $title, 991 'href' => admin_url( current( array_keys( $actions ) ) ), 992 'meta' => array( 993 'menu_title' => _x( 'New', 'admin bar menu group label' ), 994 ), 995 ) 996 ); 997 998 foreach ( $actions as $link => $action ) { 999 list( $title, $id ) = $action; 1000 1001 $wp_admin_bar->add_node( 1002 array( 1003 'parent' => 'new-content', 1004 'id' => $id, 1005 'title' => $title, 1006 'href' => admin_url( $link ), 1007 ) 1008 ); 1009 } 1010 1011 if ( is_multisite() && current_user_can( 'create_sites' ) ) { 1012 $wp_admin_bar->add_node( 1013 array( 1014 'parent' => 'new-content', 1015 'id' => 'add-new-site', 1016 'title' => _x( 'Site', 'add new from admin bar' ), 1017 'href' => network_admin_url( 'site-new.php' ), 1018 ) 1019 ); 1020 } 1021 } 1022 1023 /** 1024 * Adds edit comments link with awaiting moderation count bubble. 1025 * 1026 * @since 3.1.0 1027 * 1028 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 1029 */ 1030 function wp_admin_bar_comments_menu( $wp_admin_bar ) { 1031 if ( ! current_user_can( 'edit_posts' ) ) { 1032 return; 1033 } 1034 1035 $awaiting_mod = wp_count_comments(); 1036 $awaiting_mod = $awaiting_mod->moderated; 1037 $awaiting_text = sprintf( 1038 /* translators: Hidden accessibility text. %s: Number of comments. */ 1039 _n( '%s Comment in moderation', '%s Comments in moderation', $awaiting_mod ), 1040 number_format_i18n( $awaiting_mod ) 1041 ); 1042 1043 $icon = '<span class="ab-icon" aria-hidden="true"></span>'; 1044 $title = '<span class="ab-label awaiting-mod pending-count count-' . $awaiting_mod . '" aria-hidden="true">' . number_format_i18n( $awaiting_mod ) . '</span>'; 1045 $title .= '<span class="screen-reader-text comments-in-moderation-text">' . $awaiting_text . '</span>'; 1046 1047 $wp_admin_bar->add_node( 1048 array( 1049 'id' => 'comments', 1050 'title' => $icon . $title, 1051 'href' => admin_url( 'edit-comments.php' ), 1052 ) 1053 ); 1054 } 1055 1056 /** 1057 * Adds appearance submenu items to the "Site Name" menu. 1058 * 1059 * @since 3.1.0 1060 * 1061 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 1062 */ 1063 function wp_admin_bar_appearance_menu( $wp_admin_bar ) { 1064 $wp_admin_bar->add_group( 1065 array( 1066 'parent' => 'site-name', 1067 'id' => 'appearance', 1068 ) 1069 ); 1070 1071 if ( current_user_can( 'switch_themes' ) ) { 1072 $wp_admin_bar->add_node( 1073 array( 1074 'parent' => 'appearance', 1075 'id' => 'themes', 1076 'title' => __( 'Themes' ), 1077 'href' => admin_url( 'themes.php' ), 1078 ) 1079 ); 1080 } 1081 1082 if ( ! current_user_can( 'edit_theme_options' ) ) { 1083 return; 1084 } 1085 1086 if ( current_theme_supports( 'widgets' ) ) { 1087 $wp_admin_bar->add_node( 1088 array( 1089 'parent' => 'appearance', 1090 'id' => 'widgets', 1091 'title' => __( 'Widgets' ), 1092 'href' => admin_url( 'widgets.php' ), 1093 ) 1094 ); 1095 } 1096 1097 if ( current_theme_supports( 'menus' ) || current_theme_supports( 'widgets' ) ) { 1098 $wp_admin_bar->add_node( 1099 array( 1100 'parent' => 'appearance', 1101 'id' => 'menus', 1102 'title' => __( 'Menus' ), 1103 'href' => admin_url( 'nav-menus.php' ), 1104 ) 1105 ); 1106 } 1107 1108 if ( current_theme_supports( 'custom-background' ) ) { 1109 $wp_admin_bar->add_node( 1110 array( 1111 'parent' => 'appearance', 1112 'id' => 'background', 1113 'title' => _x( 'Background', 'custom background' ), 1114 'href' => admin_url( 'themes.php?page=custom-background' ), 1115 'meta' => array( 1116 'class' => 'hide-if-customize', 1117 ), 1118 ) 1119 ); 1120 } 1121 1122 if ( current_theme_supports( 'custom-header' ) ) { 1123 $wp_admin_bar->add_node( 1124 array( 1125 'parent' => 'appearance', 1126 'id' => 'header', 1127 'title' => _x( 'Header', 'custom image header' ), 1128 'href' => admin_url( 'themes.php?page=custom-header' ), 1129 'meta' => array( 1130 'class' => 'hide-if-customize', 1131 ), 1132 ) 1133 ); 1134 } 1135 } 1136 1137 /** 1138 * Provides an update link if theme/plugin/core updates are available. 1139 * 1140 * @since 3.1.0 1141 * 1142 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 1143 */ 1144 function wp_admin_bar_updates_menu( $wp_admin_bar ) { 1145 1146 $update_data = wp_get_update_data(); 1147 1148 if ( ! $update_data['counts']['total'] ) { 1149 return; 1150 } 1151 1152 $updates_text = sprintf( 1153 /* translators: Hidden accessibility text. %s: Total number of updates available. */ 1154 _n( '%s update available', '%s updates available', $update_data['counts']['total'] ), 1155 number_format_i18n( $update_data['counts']['total'] ) 1156 ); 1157 1158 $icon = '<span class="ab-icon" aria-hidden="true"></span>'; 1159 $title = '<span class="ab-label" aria-hidden="true">' . number_format_i18n( $update_data['counts']['total'] ) . '</span>'; 1160 $title .= '<span class="screen-reader-text updates-available-text">' . $updates_text . '</span>'; 1161 1162 $wp_admin_bar->add_node( 1163 array( 1164 'id' => 'updates', 1165 'title' => $icon . $title, 1166 'href' => network_admin_url( 'update-core.php' ), 1167 ) 1168 ); 1169 } 1170 1171 /** 1172 * Adds search form. 1173 * 1174 * @since 3.3.0 1175 * 1176 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 1177 */ 1178 function wp_admin_bar_search_menu( $wp_admin_bar ) { 1179 if ( is_admin() ) { 1180 return; 1181 } 1182 1183 $form = '<form action="' . esc_url( home_url( '/' ) ) . '" method="get" id="adminbarsearch">'; 1184 $form .= '<input class="adminbar-input" name="s" id="adminbar-search" type="text" value="" maxlength="150" />'; 1185 $form .= '<label for="adminbar-search" class="screen-reader-text">' . 1186 /* translators: Hidden accessibility text. */ 1187 __( 'Search' ) . 1188 '</label>'; 1189 $form .= '<input type="submit" class="adminbar-button" value="' . __( 'Search' ) . '" />'; 1190 $form .= '</form>'; 1191 1192 $wp_admin_bar->add_node( 1193 array( 1194 'parent' => 'top-secondary', 1195 'id' => 'search', 1196 'title' => $form, 1197 'meta' => array( 1198 'class' => 'admin-bar-search', 1199 'tabindex' => -1, 1200 ), 1201 ) 1202 ); 1203 } 1204 1205 /** 1206 * Adds a link to exit recovery mode when Recovery Mode is active. 1207 * 1208 * @since 5.2.0 1209 * 1210 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 1211 */ 1212 function wp_admin_bar_recovery_mode_menu( $wp_admin_bar ) { 1213 if ( ! wp_is_recovery_mode() ) { 1214 return; 1215 } 1216 1217 $url = wp_login_url(); 1218 $url = add_query_arg( 'action', WP_Recovery_Mode::EXIT_ACTION, $url ); 1219 $url = wp_nonce_url( $url, WP_Recovery_Mode::EXIT_ACTION ); 1220 1221 $wp_admin_bar->add_node( 1222 array( 1223 'parent' => 'top-secondary', 1224 'id' => 'recovery-mode', 1225 'title' => __( 'Exit Recovery Mode' ), 1226 'href' => $url, 1227 ) 1228 ); 1229 } 1230 1231 /** 1232 * Adds secondary menus. 1233 * 1234 * @since 3.3.0 1235 * 1236 * @param WP_Admin_Bar $wp_admin_bar The WP_Admin_Bar instance. 1237 */ 1238 function wp_admin_bar_add_secondary_groups( $wp_admin_bar ) { 1239 $wp_admin_bar->add_group( 1240 array( 1241 'id' => 'top-secondary', 1242 'meta' => array( 1243 'class' => 'ab-top-secondary', 1244 ), 1245 ) 1246 ); 1247 1248 $wp_admin_bar->add_group( 1249 array( 1250 'parent' => 'wp-logo', 1251 'id' => 'wp-logo-external', 1252 'meta' => array( 1253 'class' => 'ab-sub-secondary', 1254 ), 1255 ) 1256 ); 1257 } 1258 1259 /** 1260 * Enqueues inline style to hide the admin bar when printing. 1261 * 1262 * @since 6.4.0 1263 */ 1264 function wp_enqueue_admin_bar_header_styles() { 1265 // Back-compat for plugins that disable functionality by unhooking this action. 1266 $action = is_admin() ? 'admin_head' : 'wp_head'; 1267 if ( ! has_action( $action, 'wp_admin_bar_header' ) ) { 1268 return; 1269 } 1270 remove_action( $action, 'wp_admin_bar_header' ); 1271 1272 wp_add_inline_style( 'admin-bar', '@media print { #wpadminbar { display:none; } }' ); 1273 } 1274 1275 /** 1276 * Enqueues inline bump styles to make room for the admin bar. 1277 * 1278 * @since 6.4.0 1279 */ 1280 function wp_enqueue_admin_bar_bump_styles() { 1281 if ( current_theme_supports( 'admin-bar' ) ) { 1282 $admin_bar_args = get_theme_support( 'admin-bar' ); 1283 $header_callback = $admin_bar_args[0]['callback']; 1284 } 1285 1286 if ( empty( $header_callback ) ) { 1287 $header_callback = '_admin_bar_bump_cb'; 1288 } 1289 1290 if ( '_admin_bar_bump_cb' !== $header_callback ) { 1291 return; 1292 } 1293 1294 // Back-compat for plugins that disable functionality by unhooking this action. 1295 if ( ! has_action( 'wp_head', $header_callback ) ) { 1296 return; 1297 } 1298 remove_action( 'wp_head', $header_callback ); 1299 1300 $css = ' 1301 @media screen { html { margin-top: 32px !important; } } 1302 @media screen and ( max-width: 782px ) { html { margin-top: 46px !important; } } 1303 '; 1304 wp_add_inline_style( 'admin-bar', $css ); 1305 } 1306 1307 /** 1308 * Sets the display status of the admin bar. 1309 * 1310 * This can be called immediately upon plugin load. It does not need to be called 1311 * from a function hooked to the {@see 'init'} action. 1312 * 1313 * @since 3.1.0 1314 * 1315 * @global bool $show_admin_bar 1316 * 1317 * @param bool $show Whether to allow the admin bar to show. 1318 */ 1319 function show_admin_bar( $show ) { 1320 global $show_admin_bar; 1321 $show_admin_bar = (bool) $show; 1322 } 1323 1324 /** 1325 * Determines whether the admin bar should be showing. 1326 * 1327 * For more information on this and similar theme functions, check out 1328 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 1329 * Conditional Tags} article in the Theme Developer Handbook. 1330 * 1331 * @since 3.1.0 1332 * 1333 * @global bool $show_admin_bar 1334 * @global string $pagenow The filename of the current screen. 1335 * 1336 * @return bool Whether the admin bar should be showing. 1337 */ 1338 function is_admin_bar_showing() { 1339 global $show_admin_bar, $pagenow; 1340 1341 // For all these types of requests, we never want an admin bar. 1342 if ( defined( 'XMLRPC_REQUEST' ) || defined( 'DOING_AJAX' ) || defined( 'IFRAME_REQUEST' ) || wp_is_json_request() ) { 1343 return false; 1344 } 1345 1346 if ( is_embed() ) { 1347 return false; 1348 } 1349 1350 // Integrated into the admin. 1351 if ( is_admin() ) { 1352 return true; 1353 } 1354 1355 if ( ! isset( $show_admin_bar ) ) { 1356 if ( ! is_user_logged_in() || 'wp-login.php' === $pagenow ) { 1357 $show_admin_bar = false; 1358 } else { 1359 $show_admin_bar = _get_admin_bar_pref(); 1360 } 1361 } 1362 1363 /** 1364 * Filters whether to show the admin bar. 1365 * 1366 * Returning false to this hook is the recommended way to hide the admin bar. 1367 * The user's display preference is used for logged in users. 1368 * 1369 * @since 3.1.0 1370 * 1371 * @param bool $show_admin_bar Whether the admin bar should be shown. Default false. 1372 */ 1373 $show_admin_bar = apply_filters( 'show_admin_bar', $show_admin_bar ); 1374 1375 return $show_admin_bar; 1376 } 1377 1378 /** 1379 * Retrieves the admin bar display preference of a user. 1380 * 1381 * @since 3.1.0 1382 * @access private 1383 * 1384 * @param string $context Context of this preference check. Defaults to 'front'. The 'admin' 1385 * preference is no longer used. 1386 * @param int $user Optional. ID of the user to check, defaults to 0 for current user. 1387 * @return bool Whether the admin bar should be showing for this user. 1388 */ 1389 function _get_admin_bar_pref( $context = 'front', $user = 0 ) { 1390 $pref = get_user_option( "show_admin_bar_{$context}", $user ); 1391 if ( false === $pref ) { 1392 return true; 1393 } 1394 1395 return 'true' === $pref; 1396 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Thu Apr 3 08:20:01 2025 | Cross-referenced by PHPXref |