]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/class-wp-admin-bar.php
WordPress 4.1.4-scripts
[autoinstalls/wordpress.git] / wp-includes / class-wp-admin-bar.php
index 8ee6d1cf207349af36d9737674ae0cdbed77f161..749e48de7599ff92579f9545e02ace1f7e48f840 100644 (file)
@@ -1,4 +1,12 @@
 <?php
+/**
+ * The WordPress Toolbar
+ *
+ * @since 3.1.0
+ *
+ * @package WordPress
+ * @subpackage Toolbar
+ */
 class WP_Admin_Bar {
        private $nodes = array();
        private $bound = false;
@@ -8,11 +16,10 @@ class WP_Admin_Bar {
                switch ( $name ) {
                        case 'proto' :
                                return is_ssl() ? 'https://' : 'http://';
-                               break;
+
                        case 'menu' :
                                _deprecated_argument( 'WP_Admin_Bar', '3.3', 'Modify admin bar nodes with WP_Admin_Bar::get_node(), WP_Admin_Bar::add_node(), and WP_Admin_Bar::remove_node(), not the <code>menu</code> property.' );
                                return array(); // Sorry, folks.
-                               break;
                }
        }
 
@@ -38,7 +45,11 @@ class WP_Admin_Bar {
                add_action( 'admin_head', 'wp_admin_bar_header' );
 
                if ( current_theme_supports( 'admin-bar' ) ) {
-                       $admin_bar_args = get_theme_support( 'admin-bar' ); // add_theme_support( 'admin-bar', array( 'callback' => '__return_false') );
+                       /**
+                        * To remove the default padding styles from WordPress for the Toolbar, use the following code:
+                        * add_theme_support( 'admin-bar', array( 'callback' => '__return_false' ) );
+                        */
+                       $admin_bar_args = get_theme_support( 'admin-bar' );
                        $header_callback = $admin_bar_args[0]['callback'];
                }
 
@@ -50,6 +61,11 @@ class WP_Admin_Bar {
                wp_enqueue_script( 'admin-bar' );
                wp_enqueue_style( 'admin-bar' );
 
+               /**
+                * Fires after WP_Admin_Bar is initialized.
+                *
+                * @since 3.1.0
+                */
                do_action( 'admin_bar_init' );
        }
 
@@ -64,13 +80,17 @@ class WP_Admin_Bar {
        /**
         * Add a node to the menu.
         *
-        * @param array $args - The arguments for each node.
-        * - id         - string    - The ID of the item.
-        * - title      - string    - The title of the node.
-        * - parent     - string    - The ID of the parent node. Optional.
-        * - href       - string    - The link for the item. Optional.
-        * - group      - boolean   - If the node is a group. Optional. Default false.
-        * - meta       - array     - Meta data including the following keys: html, class, onclick, target, title, tabindex.
+        * @param array $args {
+        *     Arguments for adding a node.
+        *
+        *     @type string $id     ID of the item.
+        *     @type string $title  Title of the node.
+        *     @type string $parent Optional. ID of the parent node.
+        *     @type string $href   Optional. Link for the item.
+        *     @type bool   $group  Optional. Whether or not the node is a group. Default false.
+        *     @type array  $meta   Meta data including the following keys: 'html', 'class', 'rel',
+        *                          'onclick', 'target', 'title', 'tabindex'. Default empty.
+        * }
         */
        public function add_node( $args ) {
                // Shim for old method signature: add_node( $parent_id, $menu_obj, $args )
@@ -104,7 +124,7 @@ class WP_Admin_Bar {
                        $defaults = get_object_vars( $maybe_defaults );
 
                // Do the same for 'meta' items.
-               if ( ! empty( $defaults['meta'] ) && empty( $args['meta'] ) )
+               if ( ! empty( $defaults['meta'] ) && empty( $args['meta'] ) )
                        $args['meta'] = wp_parse_args( $args['meta'], $defaults['meta'] );
 
                $args = wp_parse_args( $args, $defaults );
@@ -149,13 +169,13 @@ class WP_Admin_Bar {
        }
 
        final public function get_nodes() {
-          if ( ! $nodes = $this->_get_nodes() )
-             return;
+               if ( ! $nodes = $this->_get_nodes() )
+                       return;
 
-          foreach ( $nodes as &$node ) {
-              $node = clone $node;
-          }
-          return $nodes;
+               foreach ( $nodes as &$node ) {
+                       $node = clone $node;
+               }
+               return $nodes;
        }
 
        final protected function _get_nodes() {
@@ -170,10 +190,14 @@ class WP_Admin_Bar {
         *
         * @since 3.3.0
         *
-        * @param array $args - The arguments for each node.
-        * - id         - string    - The ID of the item.
-        * - parent     - string    - The ID of the parent node. Optional. Default root.
-        * - meta       - array     - Meta data including the following keys: class, onclick, target, title.
+        * @param array $args {
+        *     Array of arguments for adding a group.
+        *
+        *     @type string $id     ID of the item.
+        *     @type string $parent Optional. ID of the parent node. Default 'root'.
+        *     @type array  $meta   Meta data for the group including the following keys:
+        *                         'class', 'onclick', 'target', and 'title'.
+        * }
         */
        final public function add_group( $args ) {
                $args['group'] = true;
@@ -184,7 +208,7 @@ class WP_Admin_Bar {
        /**
         * Remove a node.
         *
-        * @return object The removed node.
+        * @param string The ID of the item.
         */
        public function remove_node( $id ) {
                $this->_unset_node( $id );
@@ -196,7 +220,8 @@ class WP_Admin_Bar {
 
        public function render() {
                $root = $this->_bind();
-               $this->_render( $root );
+               if ( $root )
+                       $this->_render( $root );
        }
 
        final protected function _bind() {
@@ -236,8 +261,9 @@ class WP_Admin_Bar {
 
                        if ( $node->type == 'group' ) {
                                if ( empty( $node->meta['class'] ) )
-                                       $node->meta['class'] = '';
-                               $node->meta['class'] .= ' ' . $group_class;
+                                       $node->meta['class'] = $group_class;
+                               else
+                                       $node->meta['class'] .= ' ' . $group_class;
                        }
 
                        // Items in items aren't allowed. Wrap nested items in 'default' groups.
@@ -320,7 +346,7 @@ class WP_Admin_Bar {
        }
 
        final protected function _render( $root ) {
-               global $is_IE, $is_iphone;
+               global $is_IE;
 
                // Add browser classes.
                // We have to do this here since admin bar shows on the front end.
@@ -332,17 +358,21 @@ class WP_Admin_Bar {
                                $class .= ' ie8';
                        elseif ( strpos( $_SERVER['HTTP_USER_AGENT'], 'MSIE 9' ) )
                                $class .= ' ie9';
-               } elseif ( $is_iphone ) {
+               } elseif ( wp_is_mobile() ) {
                        $class .= ' mobile';
                }
 
                ?>
                <div id="wpadminbar" class="<?php echo $class; ?>" role="navigation">
-                       <div class="quicklinks">
+                       <a class="screen-reader-shortcut" href="#wp-toolbar" tabindex="1"><?php _e('Skip to toolbar'); ?></a>
+                       <div class="quicklinks" id="wp-toolbar" role="navigation" aria-label="<?php esc_attr_e('Top navigation toolbar.'); ?>" tabindex="0">
                                <?php foreach ( $root->children as $group ) {
                                        $this->_render_group( $group );
                                } ?>
                        </div>
+                       <?php if ( is_user_logged_in() ) : ?>
+                       <a class="screen-reader-shortcut" href="<?php echo esc_url( wp_logout_url() ); ?>"><?php _e('Log Out'); ?></a>
+                       <?php endif; ?>
                </div>
 
                <?php
@@ -366,9 +396,12 @@ class WP_Admin_Bar {
                if ( $node->type != 'group' || empty( $node->children ) )
                        return;
 
-               $class = empty( $node->meta['class'] ) ? '' : $node->meta['class'];
+               if ( ! empty( $node->meta['class'] ) )
+                       $class = ' class="' . esc_attr( trim( $node->meta['class'] ) ) . '"';
+               else
+                       $class = '';
 
-               ?><ul id="<?php echo esc_attr( 'wp-admin-bar-' . $node->id ); ?>" class="<?php echo esc_attr( $class ); ?>"><?php
+               ?><ul id="<?php echo esc_attr( 'wp-admin-bar-' . $node->id ); ?>"<?php echo $class; ?>><?php
                        foreach ( $node->children as $item ) {
                                $this->_render_item( $item );
                        }
@@ -382,22 +415,25 @@ class WP_Admin_Bar {
                $is_parent = ! empty( $node->children );
                $has_link  = ! empty( $node->href );
 
-               $tabindex = isset( $node->meta['tabindex'] ) ? (int) $node->meta['tabindex'] : 10;
+               $tabindex = isset( $node->meta['tabindex'] ) ? (int) $node->meta['tabindex'] : '';
+               $aria_attributes = $tabindex ? 'tabindex="' . $tabindex . '"' : '';
 
                $menuclass = '';
-               $aria_attributes = 'tabindex="' . $tabindex . '"';
 
                if ( $is_parent ) {
-                       $menuclass = 'menupop';
+                       $menuclass = 'menupop ';
                        $aria_attributes .= ' aria-haspopup="true"';
                }
 
                if ( ! empty( $node->meta['class'] ) )
-                       $menuclass .= ' ' . $node->meta['class'];
+                       $menuclass .= $node->meta['class'];
+
+               if ( $menuclass )
+                       $menuclass = ' class="' . esc_attr( trim( $menuclass ) ) . '"';
 
                ?>
 
-               <li id="<?php echo esc_attr( 'wp-admin-bar-' . $node->id ); ?>" class="<?php echo esc_attr( $menuclass ); ?>"><?php
+               <li id="<?php echo esc_attr( 'wp-admin-bar-' . $node->id ); ?>"<?php echo $menuclass; ?>><?php
                        if ( $has_link ):
                                ?><a class="ab-item" <?php echo $aria_attributes; ?> href="<?php echo esc_url( $node->href ) ?>"<?php
                                        if ( ! empty( $node->meta['onclick'] ) ) :
@@ -409,6 +445,9 @@ class WP_Admin_Bar {
                                if ( ! empty( $node->meta['title'] ) ) :
                                        ?> title="<?php echo esc_attr( $node->meta['title'] ); ?>"<?php
                                endif;
+                               if ( ! empty( $node->meta['rel'] ) ) :
+                                       ?> rel="<?php echo esc_attr( $node->meta['rel'] ); ?>"<?php
+                               endif;
                                ?>><?php
                        else:
                                ?><div class="ab-item ab-empty-item" <?php echo $aria_attributes;
@@ -453,6 +492,7 @@ class WP_Admin_Bar {
                add_action( 'admin_bar_menu', 'wp_admin_bar_my_account_item', 7 );
 
                // Site related.
+               add_action( 'admin_bar_menu', 'wp_admin_bar_sidebar_toggle', 0 );
                add_action( 'admin_bar_menu', 'wp_admin_bar_wp_menu', 10 );
                add_action( 'admin_bar_menu', 'wp_admin_bar_my_sites_menu', 20 );
                add_action( 'admin_bar_menu', 'wp_admin_bar_site_menu', 30 );
@@ -467,7 +507,11 @@ class WP_Admin_Bar {
 
                add_action( 'admin_bar_menu', 'wp_admin_bar_add_secondary_groups', 200 );
 
+               /**
+                * Fires after menus are added to the menu bar.
+                *
+                * @since 3.1.0
+                */
                do_action( 'add_admin_bar_menus' );
        }
 }
-?>