menu property.' );
return array(); // Sorry, folks.
- break;
}
}
+ /**
+ * @access public
+ */
public function initialize() {
$this->user = new stdClass;
@@ -38,7 +57,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,27 +73,46 @@ 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' );
}
+ /**
+ * @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 - 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', 'lang', 'dir',
+ * 'onclick', 'target', 'title', 'tabindex'. Default empty.
+ * }
*/
public function add_node( $args ) {
// Shim for old method signature: add_node( $parent_id, $menu_obj, $args )
@@ -85,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'] ) ) );
}
@@ -104,7 +146,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 );
@@ -123,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;
}
@@ -130,6 +175,7 @@ class WP_Admin_Bar {
/**
* Gets a node.
*
+ * @param string $id
* @return object Node.
*/
final public function get_node( $id ) {
@@ -137,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;
@@ -148,16 +198,22 @@ class WP_Admin_Bar {
return $this->nodes[ $id ];
}
+ /**
+ * @return array|void
+ */
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;
}
+ /**
+ * @return array|void
+ */
final protected function _get_nodes() {
if ( $this->bound )
return;
@@ -170,10 +226,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,21 +244,31 @@ class WP_Admin_Bar {
/**
* Remove a node.
*
- * @return object The removed node.
+ * @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();
- $this->_render( $root );
+ if ( $root )
+ $this->_render( $root );
}
+ /**
+ * @return object|void
+ */
final protected function _bind() {
if ( $this->bound )
return;
@@ -236,8 +306,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.
@@ -319,8 +390,13 @@ class WP_Admin_Bar {
return $root;
}
+ /**
+ *
+ * @global bool $is_IE
+ * @param object $root
+ */
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,22 +408,31 @@ 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';
}
?>
-