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

Finalize the WP_Admin_Bar architecture for 3.3.

Browse Source 
* Introduce a get_node() method for plugins.
 * Deprecate $wp_admin_bar->menu. Plugins will need to use get_node(), remove_node(), add_node() to make modifications. This finalizes a backwards incompatible change made earlier in the cycle.
 * Allow add_node() to take a node object (which could come from get_node(), then be modified).
 * Ensure that our underlying storage (the nodes property) is private to core. Introduce _set_node, _unset_node, _get_nodes, get_nodes as the only ways to interface with this.
 * Protect and finalize _render_item, and _render_group. render() remains public and technically overridable, though I would discourage this of plugin authors.
 * Deprecate recursive_render(). Use render() or _render_item().

More about the internals:
 * Late-binds a node's 'children' array.
 * Eliminates the root property, leverages a 'root' node.
 * Splits render() into _bind() and _render(), both protected and finalized.

Fixes #19371.


git-svn-id: https://develop.svn.wordpress.org/trunk@19501 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Andrew Nacin 2011-12-01 00:25:04 +00:00
parent cc83fb57bc
commit d36315ee66
1 changed files with 90 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

123
wp-includes/class-wp-admin-bar.php
View File

@ -1,22 +1,27 @@
<?php <?php
class WP_Admin_Bar { class WP_Admin_Bar {
private $nodes = array(); private $nodes = array();
private $root = array();
public $proto = 'http://';
public $user; public $user;
function initialize() { public function __get( $name ) {
/* Set the protocol used throughout this code */ switch ( $name ) {
if ( is_ssl() ) case 'proto' :
$this->proto = 'https://'; 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;
}
}
public function initialize() {
$this->user = new stdClass; $this->user = new stdClass;
$this->root = (object) array(
$this->add_node( array(
'id' => 'root', 'id' => 'root',
'group' => false, 'group' => false,
'children' => array(), ) );
);
if ( is_user_logged_in() ) { if ( is_user_logged_in() ) {
/* Populate settings we need for the menu based on the current user. */ /* Populate settings we need for the menu based on the current user. */
@ -69,13 +74,16 @@ class WP_Admin_Bar {
* - parent - string - The ID of the parent node. Optional. * - parent - string - The ID of the parent node. Optional.
* - href - string - The link for the item. Optional. * - href - string - The link for the item. Optional.
* - group - boolean - If the node is a group. Optional. Default false. * - group - boolean - If the node is a group. Optional. Default false.
* - meta - array - Meta data including the following keys: html, class, onclick, target, title. * - meta - array - Meta data including the following keys: html, class, onclick, target, title, tabindex.
*/ */
public function add_node( $args ) { public function add_node( $args ) {
// Shim for old method signature: add_node( $parent_id, $menu_obj, $args ) // Shim for old method signature: add_node( $parent_id, $menu_obj, $args )
if ( func_num_args() >= 3 && is_string( func_get_arg(0) ) ) if ( func_num_args() >= 3 && is_string( func_get_arg(0) ) )
$args = array_merge( array( 'parent' => func_get_arg(0) ), func_get_arg(2) ); $args = array_merge( array( 'parent' => func_get_arg(0) ), func_get_arg(2) );
if ( is_object( $args ) )
$args = get_object_vars( $args );
// Ensure we have a valid title. // Ensure we have a valid title.
if ( empty( $args['id'] ) ) { if ( empty( $args['id'] ) ) {
if ( empty( $args['title'] ) ) if ( empty( $args['title'] ) )
@ -96,52 +104,83 @@ class WP_Admin_Bar {
); );
// If the node already exists, keep any data that isn't provided. // If the node already exists, keep any data that isn't provided.
if ( isset( $this->nodes[ $args['id'] ] ) ) if ( $this->get_node( $args['id'] ) )
$defaults = (array) $this->nodes[ $args['id'] ]; $defaults = get_object_vars( $this->get_node( $args['id'] ) );
// Do the same for 'meta' items.
if ( ! empty( $defaults['meta'] ) && empty( $args['meta'] ) )
$args['meta'] = wp_parse_args( $args['meta'], $defaults['meta'] );
$args = wp_parse_args( $args, $defaults ); $args = wp_parse_args( $args, $defaults );
$args['children'] = array();
$this->_set_node( $args );
}
final protected function _set_node( $args ) {
$this->nodes[ $args['id'] ] = (object) $args; $this->nodes[ $args['id'] ] = (object) $args;
} }
/**
* Gets a node.
*
* @return object Node.
*/
final public function get_node( $id ) {
if ( isset( $this->nodes[ $id ] ) )
return $this->nodes[ $id ];
}
final protected function _get_nodes() {
return $this->nodes;
}
/** /**
* Add a group to a menu node. * Add a group to a menu node.
* *
* @since 3.3.0
*
* @param array $args - The arguments for each node. * @param array $args - The arguments for each node.
* - id - string - The ID of the item. * - id - string - The ID of the item.
* - parent - string - The ID of the parent node. Optional. Default root. * - parent - string - The ID of the parent node. Optional. Default root.
* - meta - array - Meta data including the following keys: class, onclick, target, title. * - meta - array - Meta data including the following keys: class, onclick, target, title.
*/ */
public function add_group( $args ) { final public function add_group( $args ) {
$args['group'] = true; $args['group'] = true;
$this->add_node( $args ); $this->add_node( $args );
} }
/**
* Remove a node.
*
* @return object The removed node.
*/
public function remove_node( $id ) { public function remove_node( $id ) {
$this->_unset_node( $id );
}
final protected function _unset_node( $id ) {
unset( $this->nodes[ $id ] ); unset( $this->nodes[ $id ] );
} }
public function render() { public function render() {
global $is_IE, $is_iphone; $this->_bind();
$this->_render();
}
// Link nodes to parents. final protected function _bind() {
foreach ( $this->nodes as $node ) { foreach ( $this->_get_nodes() as $node ) {
if ( 'root' == $node->id )
continue;
// Handle root menu items // Handle root menu items
if ( empty( $node->parent ) ) { if ( empty( $node->parent ) ) {
$parent = $this->root; $parent = $this->get_node( 'root' );
} elseif ( ! $parent = $this->get_node( $node->parent ) ) {
// If the parent node isn't registered, ignore the node. // If the parent node isn't registered, ignore the node.
} elseif ( ! isset( $this->nodes[ $node->parent ] ) ) {
continue; continue;
} else {
$parent = $this->nodes[ $node->parent ];
} }
// Ensure that our tree is of the form "item -> group -> item -> group -> ..." // Ensure that our tree is of the form "item -> group -> item -> group -> ..."
if ( ! $parent->group && ! $node->group ) { // Both are items. if ( ! $parent->group && ! $node->group ) { // Both are items.
// The default group is added here to allow groups that are // The default group is added here to allow groups that are
@ -160,9 +199,16 @@ class WP_Admin_Bar {
// Update the parent ID (it might have changed). // Update the parent ID (it might have changed).
$node->parent = $parent->id; $node->parent = $parent->id;
if ( ! isset( $parent->children ) )
$parent->children = array();
// Add the node to the tree. // Add the node to the tree.
$parent->children[] = $node; $parent->children[] = $node;
} }
}
final protected function _render() {
global $is_IE, $is_iphone;
// Add browser classes. // Add browser classes.
// We have to do this here since admin bar shows on the front end. // We have to do this here since admin bar shows on the front end.
@ -181,8 +227,8 @@ class WP_Admin_Bar {
?> ?>
<div id="wpadminbar" class="<?php echo $class; ?>" role="navigation"> <div id="wpadminbar" class="<?php echo $class; ?>" role="navigation">
<div class="quicklinks" role="menubar"> <div class="quicklinks" role="menubar">
<?php foreach ( $this->root->children as $group ) { <?php foreach ( $this->get_node( 'root' )->children as $group ) {
$this->render_group( $group, 'ab-top-menu' ); $this->_render_group( $group, 'ab-top-menu' );
} ?> } ?>
</div> </div>
</div> </div>
@ -190,7 +236,7 @@ class WP_Admin_Bar {
<?php <?php
} }
private function render_group( $node, $class = '' ) { final protected function _render_group( $node, $class = '' ) {
if ( ! $node->group ) if ( ! $node->group )
return; return;
@ -211,7 +257,6 @@ class WP_Admin_Bar {
$is_single_group = count( $groups ) === 1; $is_single_group = count( $groups ) === 1;
// If we don't have any subgroups, render the group. // If we don't have any subgroups, render the group.
if ( $is_single_group && ! empty( $node->children ) ) : if ( $is_single_group && ! empty( $node->children ) ) :
@ -220,7 +265,7 @@ class WP_Admin_Bar {
?><ul id="<?php echo esc_attr( "wp-admin-bar-{$node->id}" ); ?>" class="<?php echo esc_attr( $class ); ?>" role="menu"><?php ?><ul id="<?php echo esc_attr( "wp-admin-bar-{$node->id}" ); ?>" class="<?php echo esc_attr( $class ); ?>" role="menu"><?php
foreach ( $node->children as $item ) { foreach ( $node->children as $item ) {
$this->render_item( $item ); $this->_render_item( $item );
} }
?></ul><?php ?></ul><?php
@ -228,18 +273,19 @@ class WP_Admin_Bar {
elseif ( ! $is_single_group ) : elseif ( ! $is_single_group ) :
?><div id="<?php echo esc_attr( "wp-admin-bar-{$node->id}-container" ); ?>" class="ab-group-container" role="menu"><?php ?><div id="<?php echo esc_attr( "wp-admin-bar-{$node->id}-container" ); ?>" class="ab-group-container" role="menu"><?php
foreach ( $groups as $group ) { foreach ( $groups as $group ) {
$this->render_group( $group, $class ); $this->_render_group( $group, $class );
} }
?></div><?php ?></div><?php
endif; endif;
} }
private function render_item( $node ) { final protected function _render_item( $node ) {
if ( $node->group ) if ( $node->group )
return; return;
$is_parent = (bool) $node->children; $is_parent = ! empty( $node->children );
$has_link = (bool) $node->href; $has_link = ! empty( $node->href );
$tabindex = isset( $node->meta['tabindex'] ) ? (int) $node->meta['tabindex'] : 10; $tabindex = isset( $node->meta['tabindex'] ) ? (int) $node->meta['tabindex'] : 10;
$menuclass = ''; $menuclass = '';
@ -287,7 +333,7 @@ class WP_Admin_Bar {
if ( $is_parent ) : if ( $is_parent ) :
?><div class="ab-sub-wrapper"><?php ?><div class="ab-sub-wrapper"><?php
foreach ( $node->children as $group ) { foreach ( $node->children as $group ) {
$this->render_group( $group, 'ab-submenu' ); $this->_render_group( $group, 'ab-submenu' );
} }
?></div><?php ?></div><?php
endif; endif;
@ -299,11 +345,12 @@ class WP_Admin_Bar {
</li><?php </li><?php
} }
function recursive_render( $node ) { public function recursive_render( $id, $node ) {
$this->render_item( $node ); _deprecated_function( __METHOD__, '3.3', 'WP_Admin_bar::render(), WP_Admin_Bar::_render_item()' );
$this->_render_item( $node );
} }
function add_menus() { public function add_menus() {
// User related, aligned right. // User related, aligned right.
add_action( 'admin_bar_menu', 'wp_admin_bar_my_account_menu', 10 ); add_action( 'admin_bar_menu', 'wp_admin_bar_my_account_menu', 10 );