Changeset 19429 for trunk/wp-includes/class-wp-admin-bar.php

Timestamp:

11/23/2011 09:46:47 PM (14 years ago)

Author:

koopersmith

Message:

Admin Bar: Secondary is so passé. Groups are the new black. fixes #19136.

File:

• trunk/wp-includes/class-wp-admin-bar.php (modified) (10 diffs)

trunk/wp-includes/class-wp-admin-bar.php

@@ -13 +13 @@
 
         $this->user = new stdClass;
-        $this->root = new stdClass;
-        $this->root->children  = (object) array(
-            'primary'   => array(),
-            'secondary' => array(),
+        $this->root = (object) array(
+            'id'       => 'root',
+            'group'    => false,
+            'children' => array(),
         );
 
@@ -69 +69 @@
      * - parent     - string    - The ID of the parent node. Optional.
      * - href       - string    - The link for the item. Optional.
-     * - secondary  - boolean   - If the item should be part of a secondary menu. 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.
      */
@@ -78 +78 @@
 
         // Ensure we have a valid title.
-        if ( empty( $args['title'] ) )
-            return false;
-
         if ( empty( $args['id'] ) ) {
+            if ( empty( $args['title'] ) )
+                return;
+
             _doing_it_wrong( __METHOD__, __( 'The menu ID should not be empty.' ), '3.3' );
+            // Deprecated: Generate an ID from the title.
             $args['id'] = esc_attr( sanitize_title( trim( $args['title'] ) ) );
         }
 
         $defaults = array(
-            'id'        => false,
-            'title'     => false,
-            'parent'    => false,
-            'href'      => false,
-            'secondary' => false,
-            'meta'      => array(),
+            'id'     => false,
+            'title'  => false,
+            'parent' => false,
+            'href'   => false,
+            'group'  => false,
+            'meta'   => array(),
         );
 
@@ -100 +101 @@
 
         $args = wp_parse_args( $args, $defaults );
-        $args['children'] = (object) array(
-            'primary'   => array(),
-            'secondary' => array(),
-        );
+        $args['children'] = array();
 
         $this->nodes[ $args['id'] ] = (object) $args;
+    }
+
+    /**
+     * Add a group to a menu node.
+     *
+     * @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.
+     */
+    public function add_group( $args ) {
+        $args['group'] = true;
+
+        $this->add_node( $args );
     }
 
@@ -137 +149 @@
             }
 
-            if ( $node->secondary )
-                $parent->children->secondary[] = $node;
-            else
-                $parent->children->primary[] = $node;
+
+            // Ensure that our tree is of the form "item -> group -> item -> group -> ..."
+            if ( ! $parent->group && ! $node->group ) { // Both are items.
+                // The default group is added here to allow groups that are
+                // added before standard menu items to render first.
+                if ( ! isset( $parent->children['default'] ) ) {
+                    $parent->children['default'] = (object) array(
+                        'id'       => "{$parent->id}-default",
+                        'parent'   => $parent->id,
+                        'group'    => true,
+                        'children' => array(),
+                    );
+                }
+                $parent = $parent->children['default'];
+            }
+
+            // Update the parent ID (it might have changed).
+            $node->parent = $parent->id;
+
+            // Add the node to the tree.
+            $parent->children[] = $node;
         }
 
@@ -160 +189 @@
         <div id="wpadminbar" class="<?php echo $class; ?>">
             <div class="quicklinks">
-                <ul class="ab-top-menu"><?php
-
-                    foreach ( $this->root->children->primary as $node ) {
-                        $this->recursive_render( $node );
-                    }
-
-                ?></ul>
-                <ul class="ab-top-menu ab-top-secondary"><?php
-
-                    foreach ( $this->root->children->secondary as $node ) {
-                        $this->recursive_render( $node );
-                    }
-
-                ?></ul>
+                <?php foreach ( $this->root->children as $group ) {
+                    $this->render_group( $group, 'ab-top-menu' );
+                } ?>
             </div>
         </div>
@@ -180 +198 @@
     }
 
-    function recursive_render( $node ) {
-        if ( ! $node->children->primary && $node->children->secondary ) {
-            $node->children->primary = $node->children->secondary;
-            $node->children->secondary = array();
-        }
-
-        $is_parent = (bool) $node->children->primary;
+    private function render_group( $node, $class = '' ) {
+        if ( ! $node->group )
+            return;
+
+        // Check for groups within groups.
+        $groups = array();
+        foreach ( $node->children as $child ) {
+            if ( $child->group ) {
+                $groups[] = $child;
+            } else {
+                if ( ! isset( $default ) ) {
+                    // Create a default proxy item to be used in the case of nested groups.
+                    $default  = (object) wp_parse_args( array( 'children' => array() ), (array) $node );
+                    $groups[] = $default;
+                }
+                $default->children[] = $child;
+            }
+        }
+
+        $is_single_group = count( $groups ) === 1;
+
+
+        // If we don't have any subgroups, render the group.
+        if ( $is_single_group && ! empty( $node->children ) ):
+
+            if ( ! empty( $node->meta['class'] ) )
+                $class .= ' ' . $node->meta['class'];
+
+            ?><ul id="<?php echo esc_attr( "wp-admin-bar-{$node->id}" ); ?>" class="<?php echo esc_attr( $class ); ?>"><?php
+                foreach ( $node->children as $item ) {
+                    $this->render_item( $item );
+                }
+            ?></ul><?php
+
+        // Wrap the subgroups in a div and render each individual subgroup.
+        elseif ( ! $is_single_group ):
+            ?><div id="<?php echo esc_attr( "wp-admin-bar-{$node->id}-container" ); ?>" class="ab-group-container"><?php
+                foreach ( $groups as $group ) {
+                    $this->render_group( $group, $class );
+                }
+            ?></div><?php
+        endif;
+    }
+
+    private function render_item( $node ) {
+        if ( $node->group )
+            return;
+
+        $is_parent = (bool) $node->children;
         $has_link  = (bool) $node->href;
 
@@ -223 +283 @@
             if ( $is_parent ) :
                 ?><div class="ab-sub-wrapper"><?php
-
-                    // Render primary submenu
-                    ?><ul class="ab-submenu"><?php
-                    foreach ( $node->children->primary as $child_node ) {
-                        $this->recursive_render( $child_node );
+                    foreach ( $node->children as $group ) {
+                        $this->render_group( $group, 'ab-submenu' );
                     }
-                    ?></ul><?php
-
-                    // Render secondary submenu
-                    if ( ! empty( $node->children->secondary ) ):
-                        ?><ul class="ab-submenu ab-sub-secondary"><?php
-                        foreach ( $node->children->secondary as $child_node ) {
-                            $this->recursive_render( $child_node );
-                        }
-                        ?></ul><?php
-                    endif;
-
                 ?></div><?php
             endif;
@@ -248 +294 @@
             ?>
         </li><?php
-
+    }
+
+    function recursive_render( $node ) {
+        $this->render_item( $node );
     }
 
@@ -272 +321 @@
             add_action( 'admin_bar_menu', 'wp_admin_bar_search_menu', 100 );
 
+        add_action( 'admin_bar_menu', 'wp_admin_bar_add_secondary_groups', 200 );
+
         do_action( 'add_admin_bar_menus' );
     }