5 * This code handles the building and rendering of the press bar.
9 * Instantiate the admin bar object and set it up as a global for access elsewhere.
11 * UNHOOKING THIS FUNCTION WILL NOT PROPERLY REMOVE THE ADMIN BAR.
12 * For that, use show_admin_bar(false) or the 'show_admin_bar' filter.
16 * @return bool Whether the admin bar was successfully initialized.
18 function _wp_admin_bar_init() {
21 if ( ! is_admin_bar_showing() )
24 /* Load the admin bar class code ready for instantiation */
25 require( ABSPATH . WPINC . '/class-wp-admin-bar.php' );
27 /* Instantiate the admin bar */
30 * Filter the admin bar class to instantiate.
34 * @param string $wp_admin_bar_class Admin bar class to use. Default 'WP_Admin_Bar'.
36 $admin_bar_class = apply_filters( 'wp_admin_bar_class', 'WP_Admin_Bar' );
37 if ( class_exists( $admin_bar_class ) )
38 $wp_admin_bar = new $admin_bar_class;
42 $wp_admin_bar->initialize();
43 $wp_admin_bar->add_menus();
47 // Don't remove. Wrong way to disable.
48 add_action( 'template_redirect', '_wp_admin_bar_init', 0 );
49 add_action( 'admin_init', '_wp_admin_bar_init' );
52 * Render the admin bar to the page based on the $wp_admin_bar->menu member var.
53 * This is called very late on the footer actions so that it will render after anything else being
54 * added to the footer.
56 * It includes the action "admin_bar_menu" which should be used to hook in and
57 * add new menus to the admin bar. That way you can be sure that you are adding at most optimal point,
58 * right before the admin bar is rendered. This also gives you access to the $post global, among others.
62 function wp_admin_bar_render() {
65 if ( ! is_admin_bar_showing() || ! is_object( $wp_admin_bar ) )
69 * Load all necessary admin bar items.
71 * This is the hook used to add, remove, or manipulate admin bar items.
75 * @param WP_Admin_Bar $wp_admin_bar WP_Admin_Bar instance, passed by reference
77 do_action_ref_array( 'admin_bar_menu', array( &$wp_admin_bar ) );
80 * Fires before the admin bar is rendered.
84 do_action( 'wp_before_admin_bar_render' );
86 $wp_admin_bar->render();
89 * Fires after the admin bar is rendered.
93 do_action( 'wp_after_admin_bar_render' );
95 add_action( 'wp_footer', 'wp_admin_bar_render', 1000 );
96 add_action( 'in_admin_header', 'wp_admin_bar_render', 0 );
99 * Add the WordPress logo menu.
103 * @param WP_Admin_Bar $wp_admin_bar
105 function wp_admin_bar_wp_menu( $wp_admin_bar ) {
106 $wp_admin_bar->add_menu( array(
108 'title' => '<span class="ab-icon"></span>',
109 'href' => self_admin_url( 'about.php' ),
111 'title' => __('About WordPress'),
115 if ( is_user_logged_in() ) {
116 // Add "About WordPress" link
117 $wp_admin_bar->add_menu( array(
118 'parent' => 'wp-logo',
120 'title' => __('About WordPress'),
121 'href' => self_admin_url( 'about.php' ),
125 // Add WordPress.org link
126 $wp_admin_bar->add_menu( array(
127 'parent' => 'wp-logo-external',
129 'title' => __('WordPress.org'),
130 'href' => __('https://wordpress.org/'),
134 $wp_admin_bar->add_menu( array(
135 'parent' => 'wp-logo-external',
136 'id' => 'documentation',
137 'title' => __('Documentation'),
138 'href' => __('http://codex.wordpress.org/'),
142 $wp_admin_bar->add_menu( array(
143 'parent' => 'wp-logo-external',
144 'id' => 'support-forums',
145 'title' => __('Support Forums'),
146 'href' => __('https://wordpress.org/support/'),
150 $wp_admin_bar->add_menu( array(
151 'parent' => 'wp-logo-external',
153 'title' => __('Feedback'),
154 'href' => __('https://wordpress.org/support/forum/requests-and-feedback'),
159 * Add the sidebar toggle button.
163 * @param WP_Admin_Bar $wp_admin_bar
165 function wp_admin_bar_sidebar_toggle( $wp_admin_bar ) {
167 $wp_admin_bar->add_menu( array(
168 'id' => 'menu-toggle',
169 'title' => '<span class="ab-icon"></span><span class="screen-reader-text">' . __( 'Menu' ) . '</span>',
176 * Add the "My Account" item.
180 * @param WP_Admin_Bar $wp_admin_bar
182 function wp_admin_bar_my_account_item( $wp_admin_bar ) {
183 $user_id = get_current_user_id();
184 $current_user = wp_get_current_user();
185 $profile_url = get_edit_profile_url( $user_id );
190 $avatar = get_avatar( $user_id, 26 );
191 $howdy = sprintf( __('Howdy, %1$s'), $current_user->display_name );
192 $class = empty( $avatar ) ? '' : 'with-avatar';
194 $wp_admin_bar->add_menu( array(
195 'id' => 'my-account',
196 'parent' => 'top-secondary',
197 'title' => $howdy . $avatar,
198 'href' => $profile_url,
201 'title' => __('My Account'),
207 * Add the "My Account" submenu items.
211 * @param WP_Admin_Bar $wp_admin_bar
213 function wp_admin_bar_my_account_menu( $wp_admin_bar ) {
214 $user_id = get_current_user_id();
215 $current_user = wp_get_current_user();
216 $profile_url = get_edit_profile_url( $user_id );
221 $wp_admin_bar->add_group( array(
222 'parent' => 'my-account',
223 'id' => 'user-actions',
226 $user_info = get_avatar( $user_id, 64 );
227 $user_info .= "<span class='display-name'>{$current_user->display_name}</span>";
229 if ( $current_user->display_name !== $current_user->user_login )
230 $user_info .= "<span class='username'>{$current_user->user_login}</span>";
232 $wp_admin_bar->add_menu( array(
233 'parent' => 'user-actions',
235 'title' => $user_info,
236 'href' => $profile_url,
241 $wp_admin_bar->add_menu( array(
242 'parent' => 'user-actions',
243 'id' => 'edit-profile',
244 'title' => __( 'Edit My Profile' ),
245 'href' => $profile_url,
247 $wp_admin_bar->add_menu( array(
248 'parent' => 'user-actions',
250 'title' => __( 'Log Out' ),
251 'href' => wp_logout_url(),
256 * Add the "Site Name" menu.
260 * @param WP_Admin_Bar $wp_admin_bar
262 function wp_admin_bar_site_menu( $wp_admin_bar ) {
263 // Don't show for logged out users.
264 if ( ! is_user_logged_in() )
267 // Show only when the user is a member of this site, or they're a super admin.
268 if ( ! is_user_member_of_blog() && ! is_super_admin() )
271 $blogname = get_bloginfo('name');
273 if ( empty( $blogname ) )
274 $blogname = preg_replace( '#^(https?://)?(www.)?#', '', get_home_url() );
276 if ( is_network_admin() ) {
277 $blogname = sprintf( __('Network Admin: %s'), esc_html( get_current_site()->site_name ) );
278 } elseif ( is_user_admin() ) {
279 $blogname = sprintf( __('Global Dashboard: %s'), esc_html( get_current_site()->site_name ) );
282 $title = wp_html_excerpt( $blogname, 40, '…' );
284 $wp_admin_bar->add_menu( array(
287 'href' => is_admin() ? home_url( '/' ) : admin_url(),
290 // Create submenu items.
293 // Add an option to visit the site.
294 $wp_admin_bar->add_menu( array(
295 'parent' => 'site-name',
297 'title' => __( 'Visit Site' ),
298 'href' => home_url( '/' ),
301 if ( is_blog_admin() && is_multisite() && current_user_can( 'manage_sites' ) ) {
302 $wp_admin_bar->add_menu( array(
303 'parent' => 'site-name',
305 'title' => __( 'Edit Site' ),
306 'href' => network_admin_url( 'site-info.php?id=' . get_current_blog_id() ),
311 // We're on the front end, link to the Dashboard.
312 $wp_admin_bar->add_menu( array(
313 'parent' => 'site-name',
315 'title' => __( 'Dashboard' ),
316 'href' => admin_url(),
319 // Add the appearance submenu items.
320 wp_admin_bar_appearance_menu( $wp_admin_bar );
325 * Add the "My Sites/[Site Name]" menu and all submenus.
329 * @param WP_Admin_Bar $wp_admin_bar
331 function wp_admin_bar_my_sites_menu( $wp_admin_bar ) {
332 // Don't show for logged out users or single site mode.
333 if ( ! is_user_logged_in() || ! is_multisite() )
336 // Show only when the user has at least one site, or they're a super admin.
337 if ( count( $wp_admin_bar->user->blogs ) < 1 && ! is_super_admin() )
340 $wp_admin_bar->add_menu( array(
342 'title' => __( 'My Sites' ),
343 'href' => admin_url( 'my-sites.php' ),
346 if ( is_super_admin() ) {
347 $wp_admin_bar->add_group( array(
348 'parent' => 'my-sites',
349 'id' => 'my-sites-super-admin',
352 $wp_admin_bar->add_menu( array(
353 'parent' => 'my-sites-super-admin',
354 'id' => 'network-admin',
355 'title' => __('Network Admin'),
356 'href' => network_admin_url(),
359 $wp_admin_bar->add_menu( array(
360 'parent' => 'network-admin',
361 'id' => 'network-admin-d',
362 'title' => __( 'Dashboard' ),
363 'href' => network_admin_url(),
365 $wp_admin_bar->add_menu( array(
366 'parent' => 'network-admin',
367 'id' => 'network-admin-s',
368 'title' => __( 'Sites' ),
369 'href' => network_admin_url( 'sites.php' ),
371 $wp_admin_bar->add_menu( array(
372 'parent' => 'network-admin',
373 'id' => 'network-admin-u',
374 'title' => __( 'Users' ),
375 'href' => network_admin_url( 'users.php' ),
377 $wp_admin_bar->add_menu( array(
378 'parent' => 'network-admin',
379 'id' => 'network-admin-t',
380 'title' => __( 'Themes' ),
381 'href' => network_admin_url( 'themes.php' ),
383 $wp_admin_bar->add_menu( array(
384 'parent' => 'network-admin',
385 'id' => 'network-admin-p',
386 'title' => __( 'Plugins' ),
387 'href' => network_admin_url( 'plugins.php' ),
392 $wp_admin_bar->add_group( array(
393 'parent' => 'my-sites',
394 'id' => 'my-sites-list',
396 'class' => is_super_admin() ? 'ab-sub-secondary' : '',
400 foreach ( (array) $wp_admin_bar->user->blogs as $blog ) {
401 switch_to_blog( $blog->userblog_id );
403 $blavatar = '<div class="blavatar"></div>';
405 $blogname = empty( $blog->blogname ) ? $blog->domain : $blog->blogname;
406 $menu_id = 'blog-' . $blog->userblog_id;
408 $wp_admin_bar->add_menu( array(
409 'parent' => 'my-sites-list',
411 'title' => $blavatar . $blogname,
412 'href' => admin_url(),
415 $wp_admin_bar->add_menu( array(
416 'parent' => $menu_id,
417 'id' => $menu_id . '-d',
418 'title' => __( 'Dashboard' ),
419 'href' => admin_url(),
422 if ( current_user_can( get_post_type_object( 'post' )->cap->create_posts ) ) {
423 $wp_admin_bar->add_menu( array(
424 'parent' => $menu_id,
425 'id' => $menu_id . '-n',
426 'title' => __( 'New Post' ),
427 'href' => admin_url( 'post-new.php' ),
431 if ( current_user_can( 'edit_posts' ) ) {
432 $wp_admin_bar->add_menu( array(
433 'parent' => $menu_id,
434 'id' => $menu_id . '-c',
435 'title' => __( 'Manage Comments' ),
436 'href' => admin_url( 'edit-comments.php' ),
440 $wp_admin_bar->add_menu( array(
441 'parent' => $menu_id,
442 'id' => $menu_id . '-v',
443 'title' => __( 'Visit Site' ),
444 'href' => home_url( '/' ),
447 restore_current_blog();
452 * Provide a shortlink.
456 * @param WP_Admin_Bar $wp_admin_bar
458 function wp_admin_bar_shortlink_menu( $wp_admin_bar ) {
459 $short = wp_get_shortlink( 0, 'query' );
460 $id = 'get-shortlink';
462 if ( empty( $short ) )
465 $html = '<input class="shortlink-input" type="text" readonly="readonly" value="' . esc_attr( $short ) . '" />';
467 $wp_admin_bar->add_menu( array(
469 'title' => __( 'Shortlink' ),
471 'meta' => array( 'html' => $html ),
476 * Provide an edit link for posts and terms.
480 * @param WP_Admin_Bar $wp_admin_bar
482 function wp_admin_bar_edit_menu( $wp_admin_bar ) {
483 global $tag, $wp_the_query;
486 $current_screen = get_current_screen();
489 if ( 'post' == $current_screen->base
490 && 'add' != $current_screen->action
491 && ( $post_type_object = get_post_type_object( $post->post_type ) )
492 && current_user_can( 'read_post', $post->ID )
493 && ( $post_type_object->public )
494 && ( $post_type_object->show_in_admin_bar ) )
496 $wp_admin_bar->add_menu( array(
498 'title' => $post_type_object->labels->view_item,
499 'href' => get_permalink( $post->ID )
501 } elseif ( 'edit-tags' == $current_screen->base
502 && isset( $tag ) && is_object( $tag )
503 && ( $tax = get_taxonomy( $tag->taxonomy ) )
506 $wp_admin_bar->add_menu( array(
508 'title' => $tax->labels->view_item,
509 'href' => get_term_link( $tag )
513 $current_object = $wp_the_query->get_queried_object();
515 if ( empty( $current_object ) )
518 if ( ! empty( $current_object->post_type )
519 && ( $post_type_object = get_post_type_object( $current_object->post_type ) )
520 && current_user_can( 'edit_post', $current_object->ID )
521 && $post_type_object->show_ui && $post_type_object->show_in_admin_bar )
523 $wp_admin_bar->add_menu( array(
525 'title' => $post_type_object->labels->edit_item,
526 'href' => get_edit_post_link( $current_object->ID )
528 } elseif ( ! empty( $current_object->taxonomy )
529 && ( $tax = get_taxonomy( $current_object->taxonomy ) )
530 && current_user_can( $tax->cap->edit_terms )
533 $wp_admin_bar->add_menu( array(
535 'title' => $tax->labels->edit_item,
536 'href' => get_edit_term_link( $current_object->term_id, $current_object->taxonomy )
543 * Add "Add New" menu.
547 * @param WP_Admin_Bar $wp_admin_bar
549 function wp_admin_bar_new_content_menu( $wp_admin_bar ) {
552 $cpts = (array) get_post_types( array( 'show_in_admin_bar' => true ), 'objects' );
554 if ( isset( $cpts['post'] ) && current_user_can( $cpts['post']->cap->create_posts ) )
555 $actions[ 'post-new.php' ] = array( $cpts['post']->labels->name_admin_bar, 'new-post' );
557 if ( isset( $cpts['attachment'] ) && current_user_can( 'upload_files' ) )
558 $actions[ 'media-new.php' ] = array( $cpts['attachment']->labels->name_admin_bar, 'new-media' );
560 if ( current_user_can( 'manage_links' ) )
561 $actions[ 'link-add.php' ] = array( _x( 'Link', 'add new from admin bar' ), 'new-link' );
563 if ( isset( $cpts['page'] ) && current_user_can( $cpts['page']->cap->create_posts ) )
564 $actions[ 'post-new.php?post_type=page' ] = array( $cpts['page']->labels->name_admin_bar, 'new-page' );
566 unset( $cpts['post'], $cpts['page'], $cpts['attachment'] );
568 // Add any additional custom post types.
569 foreach ( $cpts as $cpt ) {
570 if ( ! current_user_can( $cpt->cap->create_posts ) )
573 $key = 'post-new.php?post_type=' . $cpt->name;
574 $actions[ $key ] = array( $cpt->labels->name_admin_bar, 'new-' . $cpt->name );
576 // Avoid clash with parent node and a 'content' post type.
577 if ( isset( $actions['post-new.php?post_type=content'] ) )
578 $actions['post-new.php?post_type=content'][1] = 'add-new-content';
580 if ( current_user_can( 'create_users' ) || current_user_can( 'promote_users' ) )
581 $actions[ 'user-new.php' ] = array( _x( 'User', 'add new from admin bar' ), 'new-user' );
586 $title = '<span class="ab-icon"></span><span class="ab-label">' . _x( 'New', 'admin bar menu group label' ) . '</span>';
588 $wp_admin_bar->add_menu( array(
589 'id' => 'new-content',
591 'href' => admin_url( current( array_keys( $actions ) ) ),
593 'title' => _x( 'Add New', 'admin bar menu group label' ),
597 foreach ( $actions as $link => $action ) {
598 list( $title, $id ) = $action;
600 $wp_admin_bar->add_menu( array(
601 'parent' => 'new-content',
604 'href' => admin_url( $link )
610 * Add edit comments link with awaiting moderation count bubble.
614 * @param WP_Admin_Bar $wp_admin_bar
616 function wp_admin_bar_comments_menu( $wp_admin_bar ) {
617 if ( !current_user_can('edit_posts') )
620 $awaiting_mod = wp_count_comments();
621 $awaiting_mod = $awaiting_mod->moderated;
622 $awaiting_title = esc_attr( sprintf( _n( '%s comment awaiting moderation', '%s comments awaiting moderation', $awaiting_mod ), number_format_i18n( $awaiting_mod ) ) );
624 $icon = '<span class="ab-icon"></span>';
625 $title = '<span id="ab-awaiting-mod" class="ab-label awaiting-mod pending-count count-' . $awaiting_mod . '">' . number_format_i18n( $awaiting_mod ) . '</span>';
627 $wp_admin_bar->add_menu( array(
629 'title' => $icon . $title,
630 'href' => admin_url('edit-comments.php'),
631 'meta' => array( 'title' => $awaiting_title ),
636 * Add appearance submenu items to the "Site Name" menu.
640 * @param WP_Admin_Bar $wp_admin_bar
642 function wp_admin_bar_appearance_menu( $wp_admin_bar ) {
643 $wp_admin_bar->add_group( array( 'parent' => 'site-name', 'id' => 'appearance' ) );
645 if ( current_user_can( 'switch_themes' ) || current_user_can( 'edit_theme_options' ) )
646 $wp_admin_bar->add_menu( array( 'parent' => 'appearance', 'id' => 'themes', 'title' => __('Themes'), 'href' => admin_url('themes.php') ) );
648 if ( ! current_user_can( 'edit_theme_options' ) )
651 $current_url = ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
652 $wp_admin_bar->add_menu( array(
653 'parent' => 'appearance',
655 'title' => __('Customize'),
656 'href' => add_query_arg( 'url', urlencode( $current_url ), wp_customize_url() ),
658 'class' => 'hide-if-no-customize',
661 add_action( 'wp_before_admin_bar_render', 'wp_customize_support_script' );
663 if ( current_theme_supports( 'widgets' ) )
664 $wp_admin_bar->add_menu( array( 'parent' => 'appearance', 'id' => 'widgets', 'title' => __('Widgets'), 'href' => admin_url('widgets.php') ) );
666 if ( current_theme_supports( 'menus' ) || current_theme_supports( 'widgets' ) )
667 $wp_admin_bar->add_menu( array( 'parent' => 'appearance', 'id' => 'menus', 'title' => __('Menus'), 'href' => admin_url('nav-menus.php') ) );
669 if ( current_theme_supports( 'custom-background' ) )
670 $wp_admin_bar->add_menu( array( 'parent' => 'appearance', 'id' => 'background', 'title' => __('Background'), 'href' => admin_url('themes.php?page=custom-background') ) );
672 if ( current_theme_supports( 'custom-header' ) )
673 $wp_admin_bar->add_menu( array( 'parent' => 'appearance', 'id' => 'header', 'title' => __('Header'), 'href' => admin_url('themes.php?page=custom-header') ) );
677 * Provide an update link if theme/plugin/core updates are available.
681 * @param WP_Admin_Bar $wp_admin_bar
683 function wp_admin_bar_updates_menu( $wp_admin_bar ) {
685 $update_data = wp_get_update_data();
687 if ( !$update_data['counts']['total'] )
690 $title = '<span class="ab-icon"></span><span class="ab-label">' . number_format_i18n( $update_data['counts']['total'] ) . '</span>';
691 $title .= '<span class="screen-reader-text">' . $update_data['title'] . '</span>';
693 $wp_admin_bar->add_menu( array(
696 'href' => network_admin_url( 'update-core.php' ),
698 'title' => $update_data['title'],
708 * @param WP_Admin_Bar $wp_admin_bar
710 function wp_admin_bar_search_menu( $wp_admin_bar ) {
714 $form = '<form action="' . esc_url( home_url( '/' ) ) . '" method="get" id="adminbarsearch">';
715 $form .= '<input class="adminbar-input" name="s" id="adminbar-search" type="text" value="" maxlength="150" />';
716 $form .= '<input type="submit" class="adminbar-button" value="' . __('Search') . '"/>';
719 $wp_admin_bar->add_menu( array(
720 'parent' => 'top-secondary',
724 'class' => 'admin-bar-search',
731 * Add secondary menus.
735 * @param WP_Admin_Bar $wp_admin_bar
737 function wp_admin_bar_add_secondary_groups( $wp_admin_bar ) {
738 $wp_admin_bar->add_group( array(
739 'id' => 'top-secondary',
741 'class' => 'ab-top-secondary',
745 $wp_admin_bar->add_group( array(
746 'parent' => 'wp-logo',
747 'id' => 'wp-logo-external',
749 'class' => 'ab-sub-secondary',
755 * Style and scripts for the admin bar.
759 function wp_admin_bar_header() { ?>
760 <style type="text/css" media="print">#wpadminbar { display:none; }</style>
765 * Default admin bar callback.
769 function _admin_bar_bump_cb() { ?>
770 <style type="text/css" media="screen">
771 html { margin-top: 32px !important; }
772 * html body { margin-top: 32px !important; }
773 @media screen and ( max-width: 782px ) {
774 html { margin-top: 46px !important; }
775 * html body { margin-top: 46px !important; }
782 * Set the display status of the admin bar.
784 * This can be called immediately upon plugin load. It does not need to be called from a function hooked to the init action.
788 * @param bool $show Whether to allow the admin bar to show.
791 function show_admin_bar( $show ) {
792 global $show_admin_bar;
793 $show_admin_bar = (bool) $show;
797 * Determine whether the admin bar should be showing.
801 * @return bool Whether the admin bar should be showing.
803 function is_admin_bar_showing() {
804 global $show_admin_bar, $pagenow;
806 // For all these types of requests, we never want an admin bar.
807 if ( defined('XMLRPC_REQUEST') || defined('DOING_AJAX') || defined('IFRAME_REQUEST') )
810 // Integrated into the admin.
814 if ( ! isset( $show_admin_bar ) ) {
815 if ( ! is_user_logged_in() || 'wp-login.php' == $pagenow ) {
816 $show_admin_bar = false;
818 $show_admin_bar = _get_admin_bar_pref();
823 * Filter whether to show the admin bar.
825 * Returning false to this hook is the recommended way to hide the admin bar.
826 * The user's display preference is used for logged in users.
830 * @param bool $show_admin_bar Whether the admin bar should be shown. Default false.
832 $show_admin_bar = apply_filters( 'show_admin_bar', $show_admin_bar );
834 return $show_admin_bar;
838 * Retrieve the admin bar display preference of a user.
843 * @param string $context Context of this preference check. Defaults to 'front'. The 'admin'
844 * preference is no longer used.
845 * @param int $user Optional. ID of the user to check, defaults to 0 for current user.
846 * @return bool Whether the admin bar should be showing for this user.
848 function _get_admin_bar_pref( $context = 'front', $user = 0 ) {
849 $pref = get_user_option( "show_admin_bar_{$context}", $user );
850 if ( false === $pref )
853 return 'true' === $pref;