Changeset 13927

Timestamp:

06/13/2024 07:39:42 PM (2 years ago)

Author:

johnjamesjacoby

Message:

WPCS: param & global docs corrections.

Some were missing, out-of-order, or potentially wrong based on conditional logic (I.E. when specific class names are juggled based on Site/Network admin area contexts). For those, I opted just to use "object" rather than the exact class names, because they're lengthy & ugly & make the docs more difficult to read. Feel free to override that decision later!

See: #9174.

Location:

trunk/src

Files:

• bp-activity/bp-activity-functions.php (modified) (1 diff)
• bp-core/admin/bp-core-admin-functions.php (modified) (2 diffs)
• bp-core/admin/bp-core-admin-optouts.php (modified) (2 diffs)
• bp-core/bp-core-avatars.php (modified) (1 diff)
• bp-members/classes/class-bp-members-admin.php (modified) (4 diffs)
• bp-templates/bp-legacy/buddypress/groups/single/admin/manage-members.php (modified) (6 diffs)

trunk/src/bp-activity/bp-activity-functions.php

@@ -403 +403 @@
  * @since 2.2.0
  *
- * @global $wp_post_types
+ * @global array $wp_post_types
  *
  * @param string $post_type The name of the post type, as registered with WordPress. Eg 'post' or 'page'.

trunk/src/bp-core/admin/bp-core-admin-functions.php

@@ -27 +27 @@
  * The old "bp-general-settings" page was renamed "bp-components".
  *
- * @since 1.6.0 
+ * @since 1.6.0
  *
  * @global array $_parent_pages
@@ -1131 +1131 @@
  * @since 7.0.0 Uses wp_nav_menu_item_post_type_meta_box()
  *
- * @global $nav_menu_selected_id
+ * @global int|string $nav_menu_selected_id
  *
  * @param WP_Post $post The current post object.

trunk/src/bp-core/admin/bp-core-admin-optouts.php

@@ -20 +20 @@
  * @since 8.0.0
  *
- * @global $bp_optouts_list_table BP_Optouts_List_Table List table instance for nonmember opt-outs admin page.
+ * @global object $bp_optouts_list_table List table instance for nonmember opt-outs admin page.
  */
 function bp_core_optouts_admin_load() {
@@ -291 +291 @@
  * @since 8.0.0
  *
- * @global $plugin_page
- * @global $bp_optouts_list_table BP_Optouts_List_Table List table instance for nonmember opt-outs admin page.
+ * @global string $plugin_page
+ * @global object $bp_optouts_list_table List table instance for nonmember opt-outs admin page.
  */
 function bp_core_optouts_admin_index() {

trunk/src/bp-core/bp-core-avatars.php

@@ -2132 +2132 @@
  * @since 2.3.0
  *
- * @global $is_safari
- * @global $is_IE
+ * @global bool $is_safari
+ * @global bool $is_IE
  *
  * @return bool True to load the Webcam Avatar UI part. False otherwise.

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

@@ -1819 +1819 @@
          * @since 2.0.0
          *
-         * @global $bp_members_signup_list_table
+         * @global object $bp_members_signup_list_table
          */
         public function signups_admin_load() {
@@ -2287 +2287 @@
          * @since 2.0.0
          *
-         * @global $plugin_page
-         * @global $bp_members_signup_list_table
+         * @global string $plugin_page
+         * @global object $bp_members_signup_list_table
          */
         public function signups_admin_index() {
@@ -2868 +2868 @@
          * @since 8.0.0
          *
-         * @global $bp_members_invitations_list_table
+         * @global object $bp_members_invitations_list_table
          */
         public function members_invitations_admin_load() {
@@ -3195 +3195 @@
          * @since 8.0.0
          *
-         * @global $plugin_page
-         * @global $bp_members_invitations_list_table
+         * @global string $plugin_page
+         * @global object $bp_members_invitations_list_table
          */
         public function invitations_admin_index() {

trunk/src/bp-templates/bp-legacy/buddypress/groups/single/admin/manage-members.php

@@ -66 +66 @@
                                                          * @since 2.7.0 Added $section parameter.
                                                          *
-                                                         * @param $section Which list contains this item.
+                                                         * @param string $section Which list contains this item.
                                                          */
                                                         do_action( 'bp_group_manage_members_admin_item', 'admins-list' ); ?>
@@ -83 +83 @@
                                                          * @since 2.7.0
                                                          *
-                                                         * @param $section Which list contains this item.
+                                                         * @param string $section Which list contains this item.
                                                          */
                                                         do_action( 'bp_group_manage_members_admin_actions', 'admins-list' ); ?>
@@ -160 +160 @@
                                                          * @since 2.7.0 Added $section parameter.
                                                          *
-                                                         * @param $section Which list contains this item.
+                                                         * @param string $section Which list contains this item.
                                                          */
                                                         do_action( 'bp_group_manage_members_admin_item', 'admins-list' ); ?>
@@ -176 +176 @@
                                                          * @since 2.7.0
                                                          *
-                                                         * @param $section Which list contains this item.
+                                                         * @param string $section Which list contains this item.
                                                          */
                                                         do_action( 'bp_group_manage_members_admin_actions', 'mods-list' ); ?>
@@ -261 +261 @@
                                                          * @since 2.7.0 Added $section parameter.
                                                          *
-                                                         * @param $section Which list contains this item.
+                                                         * @param string $section Which list contains this item.
                                                          */
                                                         do_action( 'bp_group_manage_members_admin_item', 'admins-list' ); ?>
@@ -288 +288 @@
                                                          * @since 2.7.0
                                                          *
-                                                         * @param $section Which list contains this item.
+                                                         * @param string $section Which list contains this item.
                                                          */
                                                         do_action( 'bp_group_manage_members_admin_actions', 'members-list' ); ?>