Changeset 13395 for trunk/src/bp-core/classes/class-bp-component.php

Timestamp:

01/07/2023 12:18:55 AM (2 years ago)

Author:

espellcaste

Message:

PHPDoc: adding improvements to the @global tag definition.

The @global tag is used to inform PHPDoc of a global variable or its usage. The tag was updated where necessary and invalid examples were removed.

Closes ​https://github.com/buddypress/buddypress/pull/53
Fixes #8786

File:

• trunk/src/bp-core/classes/class-bp-component.php (modified) (3 diffs)

trunk/src/bp-core/classes/class-bp-component.php

@@ -580 +580 @@
      * @see WP_Admin_Bar::add_menu() for a description of the syntax
      *      required by each item in the $wp_admin_nav parameter array.
-     * @global object $wp_admin_bar
+     *
+     * @global WP_Admin_Bar $wp_admin_bar WordPress object implementing a Toolbar API.
      *
      * @param array $wp_admin_nav An array of nav item arguments. Each item in this parameter
@@ -588 +589 @@
      */
     public function setup_admin_bar( $wp_admin_nav = array() ) {
+        global $wp_admin_bar;
 
         // Bail if this is an ajax request.
@@ -638 +640 @@
             $this->admin_menu = $wp_admin_nav;
 
-            // Define the WordPress global.
-            global $wp_admin_bar;
-
             // Add each admin menu.
             foreach( $this->admin_menu as $admin_menu ) {