WordPress.org

Make WordPress Core

Ticket #19371: 19371.3.diff

File 19371.3.diff, 8.3 KB (added by nacin, 2 years ago)

Refreshed after [19484]

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

     
    11<?php 
    22class WP_Admin_Bar { 
    33        private $nodes = array(); 
    4         private $root = array(); 
    5  
    6         public $proto = 'http://'; 
    74        public $user; 
    85 
     6        protected $_bound = false; 
     7 
     8        final public function __get( $name ) { 
     9                switch ( $name ) { 
     10                        case 'proto' : 
     11                                return is_ssl() ? 'https://' : 'http://'; 
     12                                break; 
     13                        case 'menu' : 
     14                                if ( ! $this->_bound ) 
     15                                        $this->_bind(); 
     16                                return $this->get_nodes(); 
     17                                break; 
     18                } 
     19        } 
     20 
    921        function initialize() { 
    10                 /* Set the protocol used throughout this code */ 
    11                 if ( is_ssl() ) 
    12                         $this->proto = 'https://'; 
     22                $this->user = new stdClass; 
    1323 
    14                 $this->user = new stdClass; 
    15                 $this->root = (object) array( 
     24                $this->add_node( array( 
    1625                        'id'       => 'root', 
    1726                        'group'    => false, 
    18                         'children' => array(), 
    19                 ); 
     27                ) ); 
    2028 
    2129                if ( is_user_logged_in() ) { 
    2230                        /* Populate settings we need for the menu based on the current user. */ 
     
    6977         * - parent     - string    - The ID of the parent node. Optional. 
    7078         * - href       - string    - The link for the item. Optional. 
    7179         * - group      - boolean   - If the node is a group. Optional. Default false. 
    72          * - meta       - array     - Meta data including the following keys: html, class, onclick, target, title. 
     80         * - meta       - array     - Meta data including the following keys: html, class, onclick, target, title, tabindex. 
    7381         */ 
    7482        public function add_node( $args ) { 
    7583                // Shim for old method signature: add_node( $parent_id, $menu_obj, $args ) 
    7684                if ( func_num_args() >= 3 && is_string( func_get_arg(0) ) ) 
    7785                        $args = array_merge( array( 'parent' => func_get_arg(0) ), func_get_arg(2) ); 
    7886 
     87                if ( is_object( $args ) ) 
     88                        $args = get_object_vars( $args ); 
     89 
    7990                // Ensure we have a valid title. 
    8091                if ( empty( $args['id'] ) ) { 
    8192                        if ( empty( $args['title'] ) ) 
     
    96107                ); 
    97108 
    98109                // If the node already exists, keep any data that isn't provided. 
    99                 if ( isset( $this->nodes[ $args['id'] ] ) ) 
    100                         $defaults = (array) $this->nodes[ $args['id'] ]; 
     110                if ( $this->get_node( $args['id'] ) ) 
     111                        $defaults = get_object_vars( $this->get_node( $args['id'] ) ); 
    101112 
     113                // Do the same for 'meta' items. 
     114                if ( ! empty( $defaults['meta'] ) && empty( $args['meta'] ) ) 
     115                        $args['meta'] = wp_parse_args( $args['meta'], $defaults['meta'] ); 
     116 
    102117                $args = wp_parse_args( $args, $defaults ); 
    103                 $args['children'] = array(); 
    104118 
     119                $this->_add_node( $args ); 
     120        } 
     121 
     122        final protected function _add_node( $args ) { 
    105123                $this->nodes[ $args['id'] ] = (object) $args; 
    106124        } 
    107125 
    108126        /** 
     127         * Gets a node. 
     128         * 
     129         * @return object Node. 
     130         */ 
     131        final public function get_node( $id ) { 
     132                if ( isset( $this->nodes[ $id ] ) ) 
     133                        return $this->nodes[ $id ]; 
     134        } 
     135 
     136        final protected function get_nodes() { 
     137                return $this->nodes; 
     138        } 
     139 
     140        /** 
    109141         * Add a group to a menu node. 
    110142         * 
     143         * @since 3.3.0 
     144         * 
    111145         * @param array $args - The arguments for each node. 
    112146         * - id         - string    - The ID of the item. 
    113147         * - parent     - string    - The ID of the parent node. Optional. Default root. 
     
    119153                $this->add_node( $args ); 
    120154        } 
    121155 
     156        /** 
     157         * Remove a node. 
     158         * 
     159         * @since 3.3.0 
     160         * @return object The removed node. 
     161         */ 
    122162        public function remove_node( $id ) { 
     163                $node = $this->get_node( $id ); 
    123164                unset( $this->nodes[ $id ] ); 
     165                return $node; 
    124166        } 
    125167 
    126         public function render() { 
    127                 global $is_IE, $is_iphone; 
     168        final public function render() { 
     169                $this->_bind(); 
     170                $this->_render(); 
     171        } 
    128172 
    129                 // Link nodes to parents. 
    130                 foreach ( $this->nodes as $node ) { 
     173        protected function _bind() { 
     174                if ( $this->_bound ) 
     175                        return; 
    131176 
     177                $this->_bound = true; 
     178 
     179                foreach ( $this->get_nodes() as $node ) { 
     180                        if ( 'root' == $node->id ) 
     181                                continue; 
     182 
    132183                        // Handle root menu items 
    133184                        if ( empty( $node->parent ) ) { 
    134                                 $parent = $this->root; 
    135  
    136                         // If the parent node isn't registered, ignore the node. 
    137                         } elseif ( ! isset( $this->nodes[ $node->parent ] ) ) { 
     185                                $parent = $this->get_node( 'root' ); 
     186                        } elseif ( ! $parent = $this->get_node( $node->parent ) ) { 
     187                                // If the parent node isn't registered, ignore the node. 
    138188                                continue; 
    139  
    140                         } else { 
    141                                 $parent = $this->nodes[ $node->parent ]; 
    142189                        } 
    143190 
    144  
    145191                        // Ensure that our tree is of the form "item -> group -> item -> group -> ..." 
    146192                        if ( ! $parent->group && ! $node->group ) { // Both are items. 
    147193                                // The default group is added here to allow groups that are 
     
    160206                        // Update the parent ID (it might have changed). 
    161207                        $node->parent = $parent->id; 
    162208 
     209                        if ( ! isset( $parent->children ) ) 
     210                                $parent->children = array(); 
     211 
    163212                        // Add the node to the tree. 
    164213                        $parent->children[] = $node; 
    165214                } 
     215        } 
    166216 
     217        protected function _render() { 
     218                global $is_IE, $is_iphone; 
     219 
    167220                // Add browser classes. 
    168221                // We have to do this here since admin bar shows on the front end. 
    169222                $class = 'nojq nojs'; 
     
    181234                ?> 
    182235                <div id="wpadminbar" class="<?php echo $class; ?>" role="navigation"> 
    183236                        <div class="quicklinks" role="menubar"> 
    184                                 <?php foreach ( $this->root->children as $group ) { 
    185                                         $this->render_group( $group, 'ab-top-menu' ); 
     237                                <?php foreach ( $this->get_node( 'root' )->children as $group ) { 
     238                                        $this->_render_group( $group, 'ab-top-menu' ); 
    186239                                } ?> 
    187240                        </div> 
    188241                </div> 
     
    190243                <?php 
    191244        } 
    192245 
    193         private function render_group( $node, $class = '' ) { 
     246        private function _render_group( $node, $class = '' ) { 
    194247                if ( ! $node->group ) 
    195248                        return; 
    196249 
     250                $this->render_group( $node, $class ); 
     251        } 
     252 
     253        protected function render_group( $node, $class = '' ) { 
    197254                // Check for groups within groups. 
    198255                $groups = array(); 
    199256                foreach ( $node->children as $child ) { 
     
    211268 
    212269                $is_single_group = count( $groups ) === 1; 
    213270 
    214  
    215271                // If we don't have any subgroups, render the group. 
    216                 if ( $is_single_group && ! empty( $node->children ) ): 
     272                if ( $is_single_group && ! empty( $node->children ) ) : 
    217273 
    218274                        if ( ! empty( $node->meta['class'] ) ) 
    219275                                $class .= ' ' . $node->meta['class']; 
    220276 
    221277                        ?><ul id="<?php echo esc_attr( "wp-admin-bar-{$node->id}" ); ?>" class="<?php echo esc_attr( $class ); ?>" role="menu"><?php 
    222278                                foreach ( $node->children as $item ) { 
    223                                         $this->render_item( $item ); 
     279                                        $this->_render_item( $item ); 
    224280                                } 
    225281                        ?></ul><?php 
    226282 
    227283                // Wrap the subgroups in a div and render each individual subgroup. 
    228                 elseif ( ! $is_single_group ): 
     284                elseif ( ! $is_single_group ) : 
    229285                        ?><div id="<?php echo esc_attr( "wp-admin-bar-{$node->id}-container" ); ?>" class="ab-group-container" role="menu"><?php 
    230286                                foreach ( $groups as $group ) { 
    231                                         $this->render_group( $group, $class ); 
     287                                        $this->_render_group( $group, $class ); 
    232288                                } 
    233289                        ?></div><?php 
    234290                endif; 
    235291        } 
    236292 
    237         private function render_item( $node ) { 
     293        private function _render_item( $node ) { 
    238294                if ( $node->group ) 
    239295                        return; 
    240296 
    241                 $is_parent = (bool) $node->children; 
    242                 $has_link  = (bool) $node->href; 
    243                 $tabindex = isset($node->meta['tabindex']) ? (int) $node->meta['tabindex'] : 10; 
     297                $this->render_item( $node ); 
     298        } 
    244299 
     300        protected function render_item( $node ) { 
     301                $is_parent = ! empty( $node->children ); 
     302                $has_link  = ! empty( $node->href ); 
     303 
     304                $tabindex = isset( $node->meta['tabindex'] ) ? (int) $node->meta['tabindex'] : 10; 
     305 
    245306                $menuclass = ''; 
    246307                $aria_attributes = 'tabindex="' . $tabindex . '" role="menuitem"'; 
    247308 
     
    269330                                endif; 
    270331                                ?>><?php 
    271332                        else: 
    272                                 ?><div class="ab-item ab-empty-item" <?php echo $aria_attributes; ?>><?php 
     333                                ?><div class="ab-item ab-empty-item" <?php echo $aria_attributes; ?>"><?php 
    273334                        endif; 
    274335 
    275336                        echo $node->title; 
     
    283344                        if ( $is_parent ) : 
    284345                                ?><div class="ab-sub-wrapper"><?php 
    285346                                        foreach ( $node->children as $group ) { 
    286                                                 $this->render_group( $group, 'ab-submenu' ); 
     347                                                $this->_render_group( $group, 'ab-submenu' ); 
    287348                                        } 
    288349                                ?></div><?php 
    289350                        endif; 
     
    295356                </li><?php 
    296357        } 
    297358 
    298         function recursive_render( $node ) { 
    299                 $this->render_item( $node ); 
     359        public function recursive_render( $id, $node ) { 
     360                _deprecated_function( __METHOD__, '3.3', 'WP_Admin_Bar::render_item()' ); 
     361                $this->_render_item( $node ); 
    300362        } 
    301363 
    302         function add_menus() { 
     364        public function add_menus() { 
    303365                // User related, aligned right. 
    304366                add_action( 'admin_bar_menu', 'wp_admin_bar_my_account_menu', 10 ); 
    305367