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 * To hide the admin bar, you're looking in the wrong place. Unhooking this function will not
12 * properly remove the admin bar. 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 */
28 $admin_bar_class = apply_filters( 'wp_admin_bar_class', 'WP_Admin_Bar' );
29 if ( class_exists( $admin_bar_class ) )
30 $wp_admin_bar = new $admin_bar_class;
34 $wp_admin_bar->initialize();
35 $wp_admin_bar->add_menus();
39 add_action( 'init', '_wp_admin_bar_init' ); // Don't remove. Wrong way to disable.
42 * Render the admin bar to the page based on the $wp_admin_bar->menu member var.
43 * This is called very late on the footer actions so that it will render after anything else being
44 * added to the footer.
46 * It includes the action "admin_bar_menu" which should be used to hook in and
47 * add new menus to the admin bar. That way you can be sure that you are adding at most optimal point,
48 * right before the admin bar is rendered. This also gives you access to the $post global, among others.
52 function wp_admin_bar_render() {
55 if ( ! is_admin_bar_showing() || ! is_object( $wp_admin_bar ) )
58 do_action_ref_array( 'admin_bar_menu', array( &$wp_admin_bar ) );
60 do_action( 'wp_before_admin_bar_render' );
62 $wp_admin_bar->render();
64 do_action( 'wp_after_admin_bar_render' );
66 add_action( 'wp_footer', 'wp_admin_bar_render', 1000 );
67 add_action( 'admin_footer', 'wp_admin_bar_render', 1000 );
70 * Add the WordPress logo menu.
74 function wp_admin_bar_wp_menu( $wp_admin_bar ) {
75 $wp_admin_bar->add_menu( array(
77 'title' => '<span class="ab-icon"></span>',
78 'href' => admin_url( 'about.php' ),
80 'title' => __('About WordPress'),
84 if ( is_user_logged_in() ) {
85 // Add "About WordPress" link
86 $wp_admin_bar->add_menu( array(
87 'parent' => 'wp-logo',
89 'title' => __('About WordPress'),
90 'href' => admin_url('about.php'),
94 // Add WordPress.org link
95 $wp_admin_bar->add_menu( array(
96 'parent' => 'wp-logo-external',
98 'title' => __('WordPress.org'),
99 'href' => __('http://wordpress.org'),
103 $wp_admin_bar->add_menu( array(
104 'parent' => 'wp-logo-external',
105 'id' => 'documentation',
106 'title' => __('Documentation'),
107 'href' => __('http://codex.wordpress.org'),
111 $wp_admin_bar->add_menu( array(
112 'parent' => 'wp-logo-external',
113 'id' => 'support-forums',
114 'title' => __('Support Forums'),
115 'href' => __('http://wordpress.org/support/'),
119 $wp_admin_bar->add_menu( array(
120 'parent' => 'wp-logo-external',
122 'title' => __('Feedback'),
123 'href' => __('http://wordpress.org/support/forum/requests-and-feedback'),
128 * Add the "My Account" item.
132 function wp_admin_bar_my_account_item( $wp_admin_bar ) {
133 $user_id = get_current_user_id();
134 $current_user = wp_get_current_user();
135 $profile_url = get_edit_profile_url( $user_id );
140 $avatar = get_avatar( $user_id, 16 );
141 $howdy = sprintf( __('Howdy, %1$s'), $current_user->display_name );
142 $class = empty( $avatar ) ? '' : 'with-avatar';
144 $wp_admin_bar->add_menu( array(
145 'id' => 'my-account',
146 'parent' => 'top-secondary',
147 'title' => $howdy . $avatar,
148 'href' => $profile_url,
151 'title' => __('My Account'),
157 * Add the "My Account" submenu items.
161 function wp_admin_bar_my_account_menu( $wp_admin_bar ) {
162 $user_id = get_current_user_id();
163 $current_user = wp_get_current_user();
164 $profile_url = get_edit_profile_url( $user_id );
169 $wp_admin_bar->add_group( array(
170 'parent' => 'my-account',
171 'id' => 'user-actions',
174 $user_info = get_avatar( $user_id, 64 );
175 $user_info .= "<span class='display-name'>{$current_user->display_name}</span>";
177 if ( $current_user->display_name !== $current_user->user_nicename )
178 $user_info .= "<span class='username'>{$current_user->user_nicename}</span>";
180 $wp_admin_bar->add_menu( array(
181 'parent' => 'user-actions',
183 'title' => $user_info,
184 'href' => $profile_url,
189 $wp_admin_bar->add_menu( array(
190 'parent' => 'user-actions',
191 'id' => 'edit-profile',
192 'title' => __( 'Edit My Profile' ),
193 'href' => $profile_url,
195 $wp_admin_bar->add_menu( array(
196 'parent' => 'user-actions',
198 'title' => __( 'Log Out' ),
199 'href' => wp_logout_url(),
204 * Add the "Site Name" menu.
208 function wp_admin_bar_site_menu( $wp_admin_bar ) {
209 global $current_site;
211 // Don't show for logged out users.
212 if ( ! is_user_logged_in() )
215 // Show only when the user is a member of this site, or they're a super admin.
216 if ( ! is_user_member_of_blog() && ! is_super_admin() )
219 $blogname = get_bloginfo('name');
221 if ( empty( $blogname ) )
222 $blogname = preg_replace( '#^(https?://)?(www.)?#', '', get_home_url() );
224 if ( is_network_admin() ) {
225 $blogname = sprintf( __('Network Admin: %s'), esc_html( $current_site->site_name ) );
226 } elseif ( is_user_admin() ) {
227 $blogname = sprintf( __('Global Dashboard: %s'), esc_html( $current_site->site_name ) );
230 $title = wp_html_excerpt( $blogname, 40 );
231 if ( $title != $blogname )
232 $title = trim( $title ) . '…';
234 $wp_admin_bar->add_menu( array(
237 'href' => is_admin() ? home_url( '/' ) : admin_url(),
240 // Create submenu items.
243 // Add an option to visit the site.
244 $wp_admin_bar->add_menu( array(
245 'parent' => 'site-name',
247 'title' => __( 'Visit Site' ),
248 'href' => home_url( '/' ),
251 // We're on the front end, print a copy of the admin menu.
253 // Add the dashboard item.
254 $wp_admin_bar->add_menu( array(
255 'parent' => 'site-name',
257 'title' => __( 'Dashboard' ),
258 'href' => admin_url(),
261 // Add the appearance submenu items.
262 wp_admin_bar_appearance_menu( $wp_admin_bar );
267 * Add the "My Sites/[Site Name]" menu and all submenus.
271 function wp_admin_bar_my_sites_menu( $wp_admin_bar ) {
274 // Don't show for logged out users or single site mode.
275 if ( ! is_user_logged_in() || ! is_multisite() )
278 // Show only when the user has at least one site, or they're a super admin.
279 if ( count( $wp_admin_bar->user->blogs ) < 1 && ! is_super_admin() )
282 $wp_admin_bar->add_menu( array(
284 'title' => __( 'My Sites' ),
285 'href' => admin_url( 'my-sites.php' ),
288 if ( is_super_admin() ) {
289 $wp_admin_bar->add_group( array(
290 'parent' => 'my-sites',
291 'id' => 'my-sites-super-admin',
294 $wp_admin_bar->add_menu( array(
295 'parent' => 'my-sites-super-admin',
296 'id' => 'network-admin',
297 'title' => __('Network Admin'),
298 'href' => network_admin_url(),
301 $wp_admin_bar->add_menu( array(
302 'parent' => 'network-admin',
303 'id' => 'network-admin-d',
304 'title' => __( 'Dashboard' ),
305 'href' => network_admin_url(),
307 $wp_admin_bar->add_menu( array(
308 'parent' => 'network-admin',
309 'id' => 'network-admin-s',
310 'title' => __( 'Sites' ),
311 'href' => network_admin_url( 'sites.php' ),
313 $wp_admin_bar->add_menu( array(
314 'parent' => 'network-admin',
315 'id' => 'network-admin-u',
316 'title' => __( 'Users' ),
317 'href' => network_admin_url( 'users.php' ),
319 $wp_admin_bar->add_menu( array(
320 'parent' => 'network-admin',
321 'id' => 'network-admin-v',
322 'title' => __( 'Visit Network' ),
323 'href' => network_home_url(),
328 $wp_admin_bar->add_group( array(
329 'parent' => 'my-sites',
330 'id' => 'my-sites-list',
332 'class' => is_super_admin() ? 'ab-sub-secondary' : '',
336 $blue_wp_logo_url = includes_url('images/wpmini-blue.png');
338 foreach ( (array) $wp_admin_bar->user->blogs as $blog ) {
339 // @todo Replace with some favicon lookup.
340 //$blavatar = '<img src="' . esc_url( blavatar_url( blavatar_domain( $blog->siteurl ), 'img', 16, $blue_wp_logo_url ) ) . '" alt="Blavatar" width="16" height="16" />';
341 $blavatar = '<img src="' . esc_url($blue_wp_logo_url) . '" alt="' . esc_attr__( 'Blavatar' ) . '" width="16" height="16" class="blavatar"/>';
343 $blogname = empty( $blog->blogname ) ? $blog->domain : $blog->blogname;
344 $menu_id = 'blog-' . $blog->userblog_id;
346 $wp_admin_bar->add_menu( array(
347 'parent' => 'my-sites-list',
349 'title' => $blavatar . $blogname,
350 'href' => get_admin_url( $blog->userblog_id ),
353 $wp_admin_bar->add_menu( array(
354 'parent' => $menu_id,
355 'id' => $menu_id . '-d',
356 'title' => __( 'Dashboard' ),
357 'href' => get_admin_url( $blog->userblog_id ),
360 if ( current_user_can_for_blog( $blog->userblog_id, 'edit_posts' ) ) {
361 $wp_admin_bar->add_menu( array(
362 'parent' => $menu_id,
363 'id' => $menu_id . '-n',
364 'title' => __( 'New Post' ),
365 'href' => get_admin_url( $blog->userblog_id, 'post-new.php' ),
367 $wp_admin_bar->add_menu( array(
368 'parent' => $menu_id,
369 'id' => $menu_id . '-c',
370 'title' => __( 'Manage Comments' ),
371 'href' => get_admin_url( $blog->userblog_id, 'edit-comments.php' ),
375 $wp_admin_bar->add_menu( array(
376 'parent' => $menu_id,
377 'id' => $menu_id . '-v',
378 'title' => __( 'Visit Site' ),
379 'href' => get_home_url( $blog->userblog_id, '/' ),
385 * Provide a shortlink.
389 function wp_admin_bar_shortlink_menu( $wp_admin_bar ) {
390 $short = wp_get_shortlink( 0, 'query' );
391 $id = 'get-shortlink';
393 if ( empty( $short ) )
396 $html = '<input class="shortlink-input" type="text" readonly="readonly" value="' . esc_attr( $short ) . '" />';
398 $wp_admin_bar->add_menu( array(
400 'title' => __( 'Shortlink' ),
402 'meta' => array( 'html' => $html ),
407 * Provide an edit link for posts and terms.
411 function wp_admin_bar_edit_menu( $wp_admin_bar ) {
412 global $post, $tag, $wp_the_query;
415 $current_screen = get_current_screen();
417 if ( 'post' == $current_screen->base
418 && 'add' != $current_screen->action
419 && ( $post_type_object = get_post_type_object( $post->post_type ) )
420 && current_user_can( $post_type_object->cap->read_post, $post->ID )
421 && ( $post_type_object->public ) )
423 $wp_admin_bar->add_menu( array(
425 'title' => $post_type_object->labels->view_item,
426 'href' => get_permalink( $post->ID )
428 } elseif ( 'edit-tags' == $current_screen->base
429 && isset( $tag ) && is_object( $tag )
430 && ( $tax = get_taxonomy( $tag->taxonomy ) )
433 $wp_admin_bar->add_menu( array(
435 'title' => $tax->labels->view_item,
436 'href' => get_term_link( $tag )
440 $current_object = $wp_the_query->get_queried_object();
442 if ( empty( $current_object ) )
445 if ( ! empty( $current_object->post_type )
446 && ( $post_type_object = get_post_type_object( $current_object->post_type ) )
447 && current_user_can( $post_type_object->cap->edit_post, $current_object->ID )
448 && ( $post_type_object->show_ui || 'attachment' == $current_object->post_type ) )
450 $wp_admin_bar->add_menu( array(
452 'title' => $post_type_object->labels->edit_item,
453 'href' => get_edit_post_link( $current_object->ID )
455 } elseif ( ! empty( $current_object->taxonomy )
456 && ( $tax = get_taxonomy( $current_object->taxonomy ) )
457 && current_user_can( $tax->cap->edit_terms )
460 $wp_admin_bar->add_menu( array(
462 'title' => $tax->labels->edit_item,
463 'href' => get_edit_term_link( $current_object->term_id, $current_object->taxonomy )
470 * Add "Add New" menu.
474 function wp_admin_bar_new_content_menu( $wp_admin_bar ) {
477 $cpts = (array) get_post_types( array( 'show_in_admin_bar' => true ), 'objects' );
479 if ( isset( $cpts['post'] ) && current_user_can( $cpts['post']->cap->edit_posts ) ) {
480 $actions[ 'post-new.php' ] = array( $cpts['post']->labels->name_admin_bar, 'new-post' );
481 unset( $cpts['post'] );
484 if ( current_user_can( 'upload_files' ) )
485 $actions[ 'media-new.php' ] = array( _x( 'Media', 'add new from admin bar' ), 'new-media' );
487 if ( current_user_can( 'manage_links' ) )
488 $actions[ 'link-add.php' ] = array( _x( 'Link', 'add new from admin bar' ), 'new-link' );
490 if ( isset( $cpts['page'] ) && current_user_can( $cpts['page']->cap->edit_posts ) ) {
491 $actions[ 'post-new.php?post_type=page' ] = array( $cpts['page']->labels->name_admin_bar, 'new-page' );
492 unset( $cpts['page'] );
495 // Add any additional custom post types.
496 foreach ( $cpts as $cpt ) {
497 if ( ! current_user_can( $cpt->cap->edit_posts ) )
500 $key = 'post-new.php?post_type=' . $cpt->name;
501 $actions[ $key ] = array( $cpt->labels->name_admin_bar, 'new-' . $cpt->name );
504 if ( current_user_can( 'create_users' ) || current_user_can( 'promote_users' ) )
505 $actions[ 'user-new.php' ] = array( _x( 'User', 'add new from admin bar' ), 'new-user' );
510 $title = '<span class="ab-icon"></span><span class="ab-label">' . _x( 'New', 'admin bar menu group label' ) . '</span>';
512 $wp_admin_bar->add_menu( array(
513 'id' => 'new-content',
515 'href' => admin_url( current( array_keys( $actions ) ) ),
517 'title' => _x( 'Add New', 'admin bar menu group label' ),
521 foreach ( $actions as $link => $action ) {
522 list( $title, $id ) = $action;
524 $wp_admin_bar->add_menu( array(
525 'parent' => 'new-content',
528 'href' => admin_url( $link )
534 * Add edit comments link with awaiting moderation count bubble.
538 function wp_admin_bar_comments_menu( $wp_admin_bar ) {
539 if ( !current_user_can('edit_posts') )
542 $awaiting_mod = wp_count_comments();
543 $awaiting_mod = $awaiting_mod->moderated;
544 $awaiting_title = esc_attr( sprintf( _n( '%s comment awaiting moderation', '%s comments awaiting moderation', $awaiting_mod ), number_format_i18n( $awaiting_mod ) ) );
546 $icon = '<span class="ab-icon"></span>';
547 $title = '<span id="ab-awaiting-mod" class="ab-label awaiting-mod pending-count count-' . $awaiting_mod . '">' . number_format_i18n( $awaiting_mod ) . '</span>';
549 $wp_admin_bar->add_menu( array(
551 'title' => $icon . $title,
552 'href' => admin_url('edit-comments.php'),
553 'meta' => array( 'title' => $awaiting_title ),
558 * Add appearance submenu items to the "Site Name" menu.
562 function wp_admin_bar_appearance_menu( $wp_admin_bar ) {
563 $wp_admin_bar->add_group( array( 'parent' => 'site-name', 'id' => 'appearance' ) );
565 if ( current_user_can( 'switch_themes' ) || current_user_can( 'edit_theme_options' ) )
566 $wp_admin_bar->add_menu( array( 'parent' => 'appearance', 'id' => 'themes', 'title' => __('Themes'), 'href' => admin_url('themes.php') ) );
568 if ( ! current_user_can( 'edit_theme_options' ) )
571 if ( current_theme_supports( 'widgets' ) )
572 $wp_admin_bar->add_menu( array( 'parent' => 'appearance', 'id' => 'widgets', 'title' => __('Widgets'), 'href' => admin_url('widgets.php') ) );
574 if ( current_theme_supports( 'menus' ) || current_theme_supports( 'widgets' ) )
575 $wp_admin_bar->add_menu( array( 'parent' => 'appearance', 'id' => 'menus', 'title' => __('Menus'), 'href' => admin_url('nav-menus.php') ) );
577 if ( current_theme_supports( 'custom-background' ) )
578 $wp_admin_bar->add_menu( array( 'parent' => 'appearance', 'id' => 'background', 'title' => __('Background'), 'href' => admin_url('themes.php?page=custom-background') ) );
580 if ( current_theme_supports( 'custom-header' ) )
581 $wp_admin_bar->add_menu( array( 'parent' => 'appearance', 'id' => 'header', 'title' => __('Header'), 'href' => admin_url('themes.php?page=custom-header') ) );
585 * Provide an update link if theme/plugin/core updates are available.
589 function wp_admin_bar_updates_menu( $wp_admin_bar ) {
591 $update_data = wp_get_update_data();
593 if ( !$update_data['counts']['total'] )
596 $title = '<span class="ab-icon"></span><span class="ab-label">' . number_format_i18n( $update_data['counts']['total'] ) . '</span>';
598 $wp_admin_bar->add_menu( array(
601 'href' => network_admin_url( 'update-core.php' ),
603 'title' => $update_data['title'],
613 function wp_admin_bar_search_menu( $wp_admin_bar ) {
617 $form = '<form action="' . esc_url( home_url( '/' ) ) . '" method="get" id="adminbarsearch">';
618 $form .= '<input class="adminbar-input" name="s" id="adminbar-search" tabindex="10" type="text" value="" maxlength="150" />';
619 $form .= '<input type="submit" class="adminbar-button" value="' . __('Search') . '"/>';
622 $wp_admin_bar->add_menu( array(
623 'parent' => 'top-secondary',
627 'class' => 'admin-bar-search',
634 * Add secondary menus.
638 function wp_admin_bar_add_secondary_groups( $wp_admin_bar ) {
639 $wp_admin_bar->add_group( array(
640 'id' => 'top-secondary',
642 'class' => 'ab-top-secondary',
646 $wp_admin_bar->add_group( array(
647 'parent' => 'wp-logo',
648 'id' => 'wp-logo-external',
650 'class' => 'ab-sub-secondary',
656 * Style and scripts for the admin bar.
661 function wp_admin_bar_header() { ?>
662 <style type="text/css" media="print">#wpadminbar { display:none; }</style>
667 * Default admin bar callback.
672 function _admin_bar_bump_cb() { ?>
673 <style type="text/css" media="screen">
674 html { margin-top: 28px !important; }
675 * html body { margin-top: 28px !important; }
681 * Set the display status of the admin bar.
683 * This can be called immediately upon plugin load. It does not need to be called from a function hooked to the init action.
687 * @param bool $show Whether to allow the admin bar to show.
690 function show_admin_bar( $show ) {
691 global $show_admin_bar;
692 $show_admin_bar = (bool) $show;
696 * Determine whether the admin bar should be showing.
700 * @return bool Whether the admin bar should be showing.
702 function is_admin_bar_showing() {
703 global $show_admin_bar, $pagenow;
705 // For all these types of requests, we never want an admin bar.
706 if ( defined('XMLRPC_REQUEST') || defined('APP_REQUEST') || defined('DOING_AJAX') || defined('IFRAME_REQUEST') )
709 // Integrated into the admin.
713 if ( ! isset( $show_admin_bar ) ) {
714 if ( ! is_user_logged_in() || 'wp-login.php' == $pagenow ) {
715 $show_admin_bar = false;
717 $show_admin_bar = _get_admin_bar_pref();
721 $show_admin_bar = apply_filters( 'show_admin_bar', $show_admin_bar );
723 return $show_admin_bar;
727 * Retrieve the admin bar display preference of a user.
732 * @param string $context Context of this preference check. Defaults to 'front'. The 'admin'
733 * preference is no longer used.
734 * @param int $user Optional. ID of the user to check, defaults to 0 for current user.
735 * @return bool Whether the admin bar should be showing for this user.
737 function _get_admin_bar_pref( $context = 'front', $user = 0 ) {
738 $pref = get_user_option( "show_admin_bar_{$context}", $user );
739 if ( false === $pref )
742 return 'true' === $pref;