X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f..607b7e02d77e7326161e8ec15639052d2040f745:/wp-includes/class-wp-admin-bar.php

diff --git a/wp-includes/class-wp-admin-bar.php b/wp-includes/class-wp-admin-bar.php
index 749e48de..49986ac2 100644
--- a/wp-includes/class-wp-admin-bar.php
+++ b/wp-includes/class-wp-admin-bar.php
@@ -1,28 +1,40 @@
 <?php
 /**
- * The WordPress Toolbar
- *
- * @since 3.1.0
+ * Toolbar API: WP_Admin_Bar class
  *
  * @package WordPress
  * @subpackage Toolbar
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement the Toolbar API.
+ *
+ * @since 3.1.0
  */
 class WP_Admin_Bar {
 	private $nodes = array();
 	private $bound = false;
 	public $user;
 
+	/**
+	 * @param string $name
+	 * @return string|array|void
+	 */
 	public function __get( $name ) {
 		switch ( $name ) {
 			case 'proto' :
 				return is_ssl() ? 'https://' : 'http://';
 
 			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.' );
+				_deprecated_argument( 'WP_Admin_Bar', '3.3.0', '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.
 		}
 	}
 
+	/**
+	 * @access public
+	 */
 	public function initialize() {
 		$this->user = new stdClass;
 
@@ -69,16 +81,26 @@ class WP_Admin_Bar {
 		do_action( 'admin_bar_init' );
 	}
 
+	/**
+	 * @param array $node
+	 */
 	public function add_menu( $node ) {
 		$this->add_node( $node );
 	}
 
+	/**
+	 * @param string $id
+	 */
 	public function remove_menu( $id ) {
 		$this->remove_node( $id );
 	}
 
 	/**
-	 * Add a node to the menu.
+	 * Adds a node to the menu.
+	 *
+	 * @since 3.1.0
+	 * @since 4.5.0 Added the ability to pass 'lang' and 'dir' meta data.
+	 * @access public
 	 *
 	 * @param array $args {
 	 *     Arguments for adding a node.
@@ -88,7 +110,7 @@ class WP_Admin_Bar {
 	 *     @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',
+	 *     @type array  $meta   Meta data including the following keys: 'html', 'class', 'rel', 'lang', 'dir',
 	 *                          'onclick', 'target', 'title', 'tabindex'. Default empty.
 	 * }
 	 */
@@ -105,7 +127,7 @@ class WP_Admin_Bar {
 			if ( empty( $args['title'] ) )
 				return;
 
-			_doing_it_wrong( __METHOD__, __( 'The menu ID should not be empty.' ), '3.3' );
+			_doing_it_wrong( __METHOD__, __( 'The menu ID should not be empty.' ), '3.3.0' );
 			// Deprecated: Generate an ID from the title.
 			$args['id'] = esc_attr( sanitize_title( trim( $args['title'] ) ) );
 		}
@@ -143,6 +165,9 @@ class WP_Admin_Bar {
 		$this->_set_node( $args );
 	}
 
+	/**
+	 * @param array $args
+	 */
 	final protected function _set_node( $args ) {
 		$this->nodes[ $args['id'] ] = (object) $args;
 	}
@@ -150,6 +175,7 @@ class WP_Admin_Bar {
 	/**
 	 * Gets a node.
 	 *
+	 * @param string $id
 	 * @return object Node.
 	 */
 	final public function get_node( $id ) {
@@ -157,6 +183,10 @@ class WP_Admin_Bar {
 			return clone $node;
 	}
 
+	/**
+	 * @param string $id
+	 * @return object|void
+	 */
 	final protected function _get_node( $id ) {
 		if ( $this->bound )
 			return;
@@ -168,6 +198,9 @@ class WP_Admin_Bar {
 			return $this->nodes[ $id ];
 	}
 
+	/**
+	 * @return array|void
+	 */
 	final public function get_nodes() {
 		if ( ! $nodes = $this->_get_nodes() )
 			return;
@@ -178,6 +211,9 @@ class WP_Admin_Bar {
 		return $nodes;
 	}
 
+	/**
+	 * @return array|void
+	 */
 	final protected function _get_nodes() {
 		if ( $this->bound )
 			return;
@@ -208,22 +244,31 @@ class WP_Admin_Bar {
 	/**
 	 * Remove a node.
 	 *
-	 * @param string The ID of the item.
+	 * @param string $id The ID of the item.
 	 */
 	public function remove_node( $id ) {
 		$this->_unset_node( $id );
 	}
 
+	/**
+	 * @param string $id
+	 */
 	final protected function _unset_node( $id ) {
 		unset( $this->nodes[ $id ] );
 	}
 
+	/**
+	 * @access public
+	 */
 	public function render() {
 		$root = $this->_bind();
 		if ( $root )
 			$this->_render( $root );
 	}
 
+	/**
+	 * @return object|void
+	 */
 	final protected function _bind() {
 		if ( $this->bound )
 			return;
@@ -345,6 +390,11 @@ class WP_Admin_Bar {
 		return $root;
 	}
 
+	/**
+	 *
+	 * @global bool $is_IE
+	 * @param object $root
+	 */
 	final protected function _render( $root ) {
 		global $is_IE;
 
@@ -363,9 +413,11 @@ class WP_Admin_Bar {
 		}
 
 		?>
-		<div id="wpadminbar" class="<?php echo $class; ?>" role="navigation">
-			<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">
+		<div id="wpadminbar" class="<?php echo $class; ?>">
+			<?php if ( ! is_admin() ) { ?>
+				<a class="screen-reader-shortcut" href="#wp-toolbar" tabindex="1"><?php _e( 'Skip to toolbar' ); ?></a>
+			<?php } ?>
+			<div class="quicklinks" id="wp-toolbar" role="navigation" aria-label="<?php esc_attr_e( 'Toolbar' ); ?>" tabindex="0">
 				<?php foreach ( $root->children as $group ) {
 					$this->_render_group( $group );
 				} ?>
@@ -378,6 +430,9 @@ class WP_Admin_Bar {
 		<?php
 	}
 
+	/**
+	 * @param object $node
+	 */
 	final protected function _render_container( $node ) {
 		if ( $node->type != 'container' || empty( $node->children ) )
 			return;
@@ -389,10 +444,14 @@ class WP_Admin_Bar {
 		?></div><?php
 	}
 
+	/**
+	 * @param object $node
+	 */
 	final protected function _render_group( $node ) {
-		if ( $node->type == 'container' )
-			return $this->_render_container( $node );
-
+		if ( $node->type == 'container' ) {
+			$this->_render_container( $node );
+			return;
+		}
 		if ( $node->type != 'group' || empty( $node->children ) )
 			return;
 
@@ -408,6 +467,9 @@ class WP_Admin_Bar {
 		?></ul><?php
 	}
 
+	/**
+	 * @param object $node
+	 */
 	final protected function _render_item( $node ) {
 		if ( $node->type != 'item' )
 			return;
@@ -415,8 +477,9 @@ class WP_Admin_Bar {
 		$is_parent = ! empty( $node->children );
 		$has_link  = ! empty( $node->href );
 
-		$tabindex = isset( $node->meta['tabindex'] ) ? (int) $node->meta['tabindex'] : '';
-		$aria_attributes = $tabindex ? 'tabindex="' . $tabindex . '"' : '';
+		// Allow only numeric values, then casted to integers, and allow a tabindex value of `0` for a11y.
+		$tabindex = ( isset( $node->meta['tabindex'] ) && is_numeric( $node->meta['tabindex'] ) ) ? (int) $node->meta['tabindex'] : '';
+		$aria_attributes = ( '' !== $tabindex ) ? ' tabindex="' . $tabindex . '"' : '';
 
 		$menuclass = '';
 
@@ -435,7 +498,7 @@ class WP_Admin_Bar {
 
 		<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
+				?><a class="ab-item"<?php echo $aria_attributes; ?> href="<?php echo esc_url( $node->href ) ?>"<?php
 					if ( ! empty( $node->meta['onclick'] ) ) :
 						?> onclick="<?php echo esc_js( $node->meta['onclick'] ); ?>"<?php
 					endif;
@@ -448,12 +511,24 @@ class WP_Admin_Bar {
 				if ( ! empty( $node->meta['rel'] ) ) :
 					?> rel="<?php echo esc_attr( $node->meta['rel'] ); ?>"<?php
 				endif;
+				if ( ! empty( $node->meta['lang'] ) ) :
+					?> lang="<?php echo esc_attr( $node->meta['lang'] ); ?>"<?php
+				endif;
+				if ( ! empty( $node->meta['dir'] ) ) :
+					?> dir="<?php echo esc_attr( $node->meta['dir'] ); ?>"<?php
+				endif;
 				?>><?php
 			else:
-				?><div class="ab-item ab-empty-item" <?php echo $aria_attributes;
+				?><div class="ab-item ab-empty-item"<?php echo $aria_attributes;
 				if ( ! empty( $node->meta['title'] ) ) :
 					?> title="<?php echo esc_attr( $node->meta['title'] ); ?>"<?php
 				endif;
+				if ( ! empty( $node->meta['lang'] ) ) :
+					?> lang="<?php echo esc_attr( $node->meta['lang'] ); ?>"<?php
+				endif;
+				if ( ! empty( $node->meta['dir'] ) ) :
+					?> dir="<?php echo esc_attr( $node->meta['dir'] ); ?>"<?php
+				endif;
 				?>><?php
 			endif;
 
@@ -480,11 +555,18 @@ class WP_Admin_Bar {
 		</li><?php
 	}
 
+	/**
+	 * @param string $id    Unused.
+	 * @param object $node
+	 */
 	public function recursive_render( $id, $node ) {
-		_deprecated_function( __METHOD__, '3.3', 'WP_Admin_bar::render(), WP_Admin_Bar::_render_item()' );
+		_deprecated_function( __METHOD__, '3.3.0', 'WP_Admin_bar::render(), WP_Admin_Bar::_render_item()' );
 		$this->_render_item( $node );
 	}
 
+	/**
+	 * @access public
+	 */
 	public function add_menus() {
 		// User related, aligned right.
 		add_action( 'admin_bar_menu', 'wp_admin_bar_my_account_menu', 0 );
@@ -496,7 +578,8 @@ class WP_Admin_Bar {
 		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 );
-		add_action( 'admin_bar_menu', 'wp_admin_bar_updates_menu', 40 );
+		add_action( 'admin_bar_menu', 'wp_admin_bar_customize_menu', 40 );
+		add_action( 'admin_bar_menu', 'wp_admin_bar_updates_menu', 50 );
 
 		// Content related.
 		if ( ! is_network_admin() && ! is_user_admin() ) {