From f7098c8c2e18cde7a5febe4db1107bb1a615c0ed Mon Sep 17 00:00:00 2001 From: Scott Taylor Date: Thu, 21 May 2015 21:39:24 +0000 Subject: [PATCH] In `class-wp-admin-bar.php`, clarify/add some doc blocks. See #32444. Built from https://develop.svn.wordpress.org/trunk@32534 git-svn-id: http://core.svn.wordpress.org/trunk@32504 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/class-wp-admin-bar.php | 57 +++++++++++++++++++++++++++--- wp-includes/version.php | 2 +- 2 files changed, 54 insertions(+), 5 deletions(-) diff --git a/wp-includes/class-wp-admin-bar.php b/wp-includes/class-wp-admin-bar.php index 8bfc2d49ba..352c0e24a2 100644 --- a/wp-includes/class-wp-admin-bar.php +++ b/wp-includes/class-wp-admin-bar.php @@ -12,6 +12,10 @@ class WP_Admin_Bar { private $bound = false; public $user; + /** + * @param string $name + * @return string|array|null + */ public function __get( $name ) { switch ( $name ) { case 'proto' : @@ -69,10 +73,16 @@ 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 ); } @@ -143,6 +153,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 +163,7 @@ class WP_Admin_Bar { /** * Gets a node. * + * @param string $id * @return object Node. */ final public function get_node( $id ) { @@ -157,6 +171,10 @@ class WP_Admin_Bar { return clone $node; } + /** + * @param string $id + * @return object|null + */ final protected function _get_node( $id ) { if ( $this->bound ) return; @@ -168,6 +186,9 @@ class WP_Admin_Bar { return $this->nodes[ $id ]; } + /** + * @return array|null + */ final public function get_nodes() { if ( ! $nodes = $this->_get_nodes() ) return; @@ -178,6 +199,9 @@ class WP_Admin_Bar { return $nodes; } + /** + * @return array|null + */ final protected function _get_nodes() { if ( $this->bound ) return; @@ -208,12 +232,15 @@ 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 ] ); } @@ -224,6 +251,9 @@ class WP_Admin_Bar { $this->_render( $root ); } + /** + * @return object|null + */ final protected function _bind() { if ( $this->bound ) return; @@ -345,6 +375,11 @@ class WP_Admin_Bar { return $root; } + /** + * + * @global bool $is_IE + * @param object $root + */ final protected function _render( $root ) { global $is_IE; @@ -380,6 +415,9 @@ class WP_Admin_Bar { type != 'container' || empty( $node->children ) ) return; @@ -391,10 +429,14 @@ class WP_Admin_Bar { ?>type == 'container' ) - return $this->_render_container( $node ); - + if ( $node->type == 'container' ) { + $this->_render_container( $node ); + return; + } if ( $node->type != 'group' || empty( $node->children ) ) return; @@ -410,6 +452,9 @@ class WP_Admin_Bar { ?>type != 'item' ) return; @@ -482,6 +527,10 @@ class WP_Admin_Bar { _render_item( $node ); diff --git a/wp-includes/version.php b/wp-includes/version.php index eca6d1bb6c..2a5bc0b35e 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.3-alpha-32533'; +$wp_version = '4.3-alpha-32534'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.