Changeset 13395 for trunk/src/bp-groups/bp-groups-template.php

Timestamp:

01/07/2023 12:18:55 AM (4 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-template.php (modified) (3 diffs)

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

@@ -3215 +3215 @@
  * @since 1.0.0
  *
- * @global object $groups_template
+ * @global BP_Groups_Template $groups_template The main Groups template loop class.
  *
  * @param object|bool $group Optional. Group to check is_member.
@@ -3288 +3288 @@
  * @since 1.5.0
  *
- * @global BP_Groups_Template $groups_template Group template loop object.
+ * @global BP_Groups_Template $groups_template The main Groups template loop class.
  *
  * @param BP_Groups_Group|bool $group   Group to check if user is banned.
@@ -3839 +3839 @@
  * @since 1.0.0
  *
- * @global BP_Groups_Template $groups_template Groups template object.
+ * @global BP_Groups_Template $groups_template The main Groups template loop class.
  *
  * @param object|null $group Group to get status message for. Optional; defaults to current group.