Changeset 13499 for trunk/src/bp-members/classes/class-bp-members-admin.php

Timestamp:

06/09/2023 12:52:29 AM (18 months ago)

Author:

imath

Message:

Improve inline doc, informing about global variable usage in functions

These improvements are about various BP Members, BP Messages & BP Notifications files.

Props viralsampat

Fixes #8890

File:

• trunk/src/bp-members/classes/class-bp-members-admin.php (modified) (4 diffs)

trunk/src/bp-members/classes/class-bp-members-admin.php

@@ -723 +723 @@
      *
      * @since 2.1.0
+     *
+     * @global string $submenu_file The name of the submenu file.
+     * @global string $parent_file  The name of the parent file.
      */
     public function profile_admin_head() {
@@ -1684 +1687 @@
      * @since 2.0.0
      *
+     * @global wpdb $wpdb The WordPress database object.
+     *
      * @param WP_User_Query|null $query The users query.
      * @return WP_User_Query|null The users query without the signups.
@@ -1725 +1730 @@
      *
      * @since 2.0.0
+     *
+     * @global string $role The name of the WP Role.
      *
      * @param array $views WP List Table views.
@@ -2763 +2770 @@
      * Filter WP Admin users list table to include users of the specified type.
      *
-     * @param WP_Query $query
-     *
      * @since 2.7.0
+     *
+     * @global string $pagenow The filename of the current screen.
+     *
+     * @param WP_Query $query The WordPress Query object.
      */
     public function users_table_filter_by_type( $query ) {