Changeset 13395 for trunk/src/bp-groups/bp-groups-functions.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-groups/bp-groups-functions.php (modified) (2 diffs)

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

@@ -108 +108 @@
  * @since 10.0.0
  *
- * @global BP_Groups_Template $groups_template Groups template object.
+ * @global BP_Groups_Template $groups_template The main Groups template loop class.
  *
  * @param false|int|string|object|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
@@ -1258 +1258 @@
  *
  * @since 1.5.0
- *
- * @global BuddyPress $bp The one true BuddyPress instance.
  *
  * @return BP_Groups_Group|bool The current group object or false.