sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

In class-wp-admin-bar.php, clarify/add some doc blocks.

Browse Source 
See #32444.


git-svn-id: https://develop.svn.wordpress.org/trunk@32534 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Scott Taylor 2015-05-21 21:38:41 +00:00
parent 4a362fdb7c
commit 369903cd85
1 changed files with 53 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
src/wp-includes/class-wp-admin-bar.php
View File

@ -12,6 +12,10 @@ class WP_Admin_Bar {
private $bound = false; private $bound = false;
public $user; public $user;
/**
* @param string $name
* @return string|array|null
*/
public function __get( $name ) { public function __get( $name ) {
switch ( $name ) { switch ( $name ) {
case 'proto' : case 'proto' :
@ -69,10 +73,16 @@ class WP_Admin_Bar {
do_action( 'admin_bar_init' ); do_action( 'admin_bar_init' );
} }
/**
* @param array $node
*/
public function add_menu( $node ) { public function add_menu( $node ) {
$this->add_node( $node ); $this->add_node( $node );
} }
/**
* @param string $id
*/
public function remove_menu( $id ) { public function remove_menu( $id ) {
$this->remove_node( $id ); $this->remove_node( $id );
} }
@ -143,6 +153,9 @@ class WP_Admin_Bar {
$this->_set_node( $args ); $this->_set_node( $args );
} }
/**
* @param array $args
*/
final protected function _set_node( $args ) { final protected function _set_node( $args ) {
$this->nodes[ $args['id'] ] = (object) $args; $this->nodes[ $args['id'] ] = (object) $args;
} }
@ -150,6 +163,7 @@ class WP_Admin_Bar {
/** /**
* Gets a node. * Gets a node.
* *
* @param string $id
* @return object Node. * @return object Node.
*/ */
final public function get_node( $id ) { final public function get_node( $id ) {
@ -157,6 +171,10 @@ class WP_Admin_Bar {
return clone $node; return clone $node;
} }
/**
* @param string $id
* @return object|null
*/
final protected function _get_node( $id ) { final protected function _get_node( $id ) {
if ( $this->bound ) if ( $this->bound )
return; return;
@ -168,6 +186,9 @@ class WP_Admin_Bar {
return $this->nodes[ $id ]; return $this->nodes[ $id ];
} }
/**
* @return array|null
*/
final public function get_nodes() { final public function get_nodes() {
if ( ! $nodes = $this->_get_nodes() ) if ( ! $nodes = $this->_get_nodes() )
return; return;
@ -178,6 +199,9 @@ class WP_Admin_Bar {
return $nodes; return $nodes;
} }
/**
* @return array|null
*/
final protected function _get_nodes() { final protected function _get_nodes() {
if ( $this->bound ) if ( $this->bound )
return; return;
@ -208,12 +232,15 @@ class WP_Admin_Bar {
/** /**
* Remove a node. * Remove a node.
* *
* @param string The ID of the item. * @param string $id The ID of the item.
*/ */
public function remove_node( $id ) { public function remove_node( $id ) {
$this->_unset_node( $id ); $this->_unset_node( $id );
} }
/**
* @param string $id
*/
final protected function _unset_node( $id ) { final protected function _unset_node( $id ) {
unset( $this->nodes[ $id ] ); unset( $this->nodes[ $id ] );
} }
@ -224,6 +251,9 @@ class WP_Admin_Bar {
$this->_render( $root ); $this->_render( $root );
} }
/**
* @return object|null
*/
final protected function _bind() { final protected function _bind() {
if ( $this->bound ) if ( $this->bound )
return; return;
@ -345,6 +375,11 @@ class WP_Admin_Bar {
return $root; return $root;
} }
/**
*
* @global bool $is_IE
* @param object $root
*/
final protected function _render( $root ) { final protected function _render( $root ) {
global $is_IE; global $is_IE;
@ -380,6 +415,9 @@ class WP_Admin_Bar {
<?php <?php
} }
/**
* @param object $node
*/
final protected function _render_container( $node ) { final protected function _render_container( $node ) {
if ( $node->type != 'container' || empty( $node->children ) ) if ( $node->type != 'container' || empty( $node->children ) )
return; return;
@ -391,10 +429,14 @@ class WP_Admin_Bar {
?></div><?php ?></div><?php
} }
/**
* @param object $node
*/
final protected function _render_group( $node ) { final protected function _render_group( $node ) {
if ( $node->type == 'container' ) if ( $node->type == 'container' ) {
return $this->_render_container( $node ); $this->_render_container( $node );
return;
}
if ( $node->type != 'group' || empty( $node->children ) ) if ( $node->type != 'group' || empty( $node->children ) )
return; return;
@ -410,6 +452,9 @@ class WP_Admin_Bar {
?></ul><?php ?></ul><?php
} }
/**
* @param object $node
*/
final protected function _render_item( $node ) { final protected function _render_item( $node ) {
if ( $node->type != 'item' ) if ( $node->type != 'item' )
return; return;
@ -482,6 +527,10 @@ class WP_Admin_Bar {
</li><?php </li><?php
} }
/**
* @param string $id Unused.
* @param object $node
*/
public function recursive_render( $id, $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', 'WP_Admin_bar::render(), WP_Admin_Bar::_render_item()' );
$this->_render_item( $node ); $this->_render_item( $node );