Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
06/03/2023 07:39:51 AM (3 years ago)
Author:
imath
Message:

BP Groups: inform about global variable usage in functions docblocks

Props viralsampat

Fixes #8890

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r13493 r13496  
    415415 * @since 7.0.0 Added `$status` parameter.
    416416 * @since 10.0.0 Added `$date_query` parameter.
     417 *
     418 * @global BP_Groups_Template $groups_template The Groups template loop class.
    417419 *
    418420 * @param array|string $args {
    … …  
    591593 * @since 1.0.0
    592594 *
     595 * @global BP_Groups_Template $groups_template The Groups template loop class.
     596 *
    593597 * @return bool
    594598 */
    … …  
    602606 *
    603607 * @since 1.0.0
     608 *
     609 * @global BP_Groups_Template $groups_template The Groups template loop class.
    604610 *
    605611 * @return BP_Groups_Group
    … …  
    696702         *
    697703         * @since 1.7.0
     704         *
     705         * @global BP_Groups_Template $groups_template The Groups template loop class.
    698706         *
    699707         * @param array $classes Array of custom classes.
    … …  
    20902098         * @since 1.2.0
    20912099         *
     2100         * @global BP_Groups_Template $groups_template The Groups template loop class.
     2101         *
    20922102         * @return string
    20932103         */
    … …  
    21172127         *
    21182128         * @since 1.5.0
     2129         *
     2130         * @global BP_Groups_Template $groups_template The Groups template loop class.
    21192131         *
    21202132         * @return string
    … …  
    25032515         *
    25042516         * @since 1.1.0
     2517         *
     2518         * @global BP_Groups_Template       $groups_template  The Groups template loop class.
     2519         * @global BP_Core_Members_Template $members_template The Members template loop class.
    25052520         *
    25062521         * @param array|string $args {
    … …  
    25562571         * @since 1.1.0
    25572572         *
     2573         * @global BP_Groups_Template       $groups_template  The Groups template loop class.
     2574         * @global BP_Core_Members_Template $members_template The Members template loop class.
     2575         *
    25582576         * @param array|string $args {
    25592577         *     @type int    $user_id ID of the member to promote. Default:
    … …  
    26122630         * @since 10.0.0 Updated to use `bp_get_group`.
    26132631         *
     2632         * @global BP_Core_Members_Template $members_template The Members template loop class.
     2633         *
    26142634         * @param int                              $user_id ID of the member to demote. Default: 0.
    26152635         * @param false|int|string|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object.
    … …  
    26652685         * @since 10.0.0 Updated to use `bp_get_group`.
    26662686         *
     2687         * @global BP_Core_Members_Template $members_template The Members template loop class.
     2688         *
    26672689         * @param int                              $user_id ID of the member to ban. Default: 0.
    26682690         * @param false|int|string|BP_Groups_Group $group   (Optional) The Group ID, the Group Slug or the Group object.
    … …  
    27172739         * @since 10.0.0 Updated to use `bp_get_group`.
    27182740         *
     2741         * @global BP_Core_Members_Template $members_template The Members template loop class.
     2742         *
    27192743         * @param int                              $user_id ID of the member to unban. Default: 0.
    27202744         * @param false|int|string|BP_Groups_Group $group   (Optional) The Group ID, the Group Slug or the Group object.
    … …  
    27692793         * @since 10.0.0 Updated to use `bp_get_group`.
    27702794         *
     2795         * @global BP_Core_Members_Template $members_template The Members template loop class.
     2796         *
    27712797         * @param int                              $user_id ID of the member to remove. Default: 0.
    27722798         * @param false|int|string|BP_Groups_Group $group   (Optional) The Group ID, the Group Slug or the Group object.
    … …  
    28082834 * @since 1.0.0
    28092835 *
     2836 * @global BP_Core_Members_Template $members_template The Members template loop class.
     2837 *
    28102838 * @param object|bool $group Optional. Group object.
    28112839 *                           Default: current group in the loop.
    … …  
    30343062 * @since 1.0.0
    30353063 *
    3036  * @global BP_Groups_Template $groups_template The main Groups template loop class.
     3064 * @global BP_Groups_Template $groups_template The Groups template loop class.
    30373065 *
    30383066 * @param object|bool $group Optional. Group to check is_member.
    … …  
    30683096 *
    30693097 * @since 2.1.0
     3098 *
     3099 * @global BP_Core_Members_Template $members_template The Members template loop class.
    30703100 *
    30713101 * @param object|bool $group Optional. Group data object.
    … …  
    31073137 * @since 1.5.0
    31083138 *
    3109  * @global BP_Groups_Template $groups_template The main Groups template loop class.
     3139 * @global BP_Groups_Template $groups_template The Groups template loop class.
    31103140 *
    31113141 * @param BP_Groups_Group|bool $group   Group to check if user is banned.
    … …  
    31683198         *
    31693199         * @since 1.0.0
     3200         *
     3201         * @global BP_Groups_Template $groups_template The Groups template loop class.
    31703202         *
    31713203         * @param object|bool $group Optional. Group object.
    … …  
    32203252         * @since 1.0.0
    32213253         *
     3254         * @global BP_Groups_Template $groups_template The Groups template loop class.
     3255         *
    32223256         * @param object|bool $group Optional. Group object.
    32233257         *                           Default: Current group in the loop.
    … …  
    32703304         *
    32713305         * @since 1.0.0
     3306         *
     3307         * @global BP_Groups_Template $groups_template The Groups template loop class.
    32723308         *
    32733309         * @param object|bool $group Optional. Group object.
    … …  
    33153351         * @since 1.0.0
    33163352         *
     3353         * @global BP_Groups_Template $groups_template The Groups template loop class.
     3354         *
    33173355         * @param object|bool $group Optional. Group object.
    33183356         *                           Default: Current group in the loop.
    … …  
    33503388         *
    33513389         * @since 1.0.0
     3390         *
     3391         * @global BP_Groups_Template $groups_template The Groups template loop class.
    33523392         *
    33533393         * @param object|bool $group Optional. Group object.
    … …  
    33843424 * @since 1.0.0
    33853425 *
     3426 * @global BP_Groups_Template $groups_template The Groups template loop class.
     3427 *
    33863428 * @param object|bool $group Optional. Group object.
    33873429 *                           Default: current group in the loop.
    … …  
    33913433        global $groups_template;
    33923434
    3393         if ( !bp_is_active( 'friends' ) ) {
     3435        if ( ! bp_is_active( 'friends' ) ) {
    33943436                return false;
    33953437        }
    … …  
    35843626         * @since 11.0.0 uses `bp_groups_get_group_join_button_args()`.
    35853627         *
     3628         * @global BP_Groups_Template $groups_template The Groups template loop class.
     3629         *
    35863630         * @param object|bool $group Single group object.
    35873631         * @return false|string
    … …  
    37153759 * @since 1.0.0
    37163760 *
    3717  * @global BP_Groups_Template $groups_template The main Groups template loop class.
     3761 * @global BP_Groups_Template $groups_template The Groups template loop class.
    37183762 *
    37193763 * @param object|null $group Group to get status message for. Optional; defaults to current group.
    … …  
    38643908 *
    38653909 * @since 1.0.0
     3910 *
     3911 * @global BP_Core_Members_Template $members_template The Members template loop class.
    38663912 *
    38673913 * @param array|string $args {
    … …  
    39503996
    39513997/**
    3952  * @since 1.0.0
     3998 * The list of group members.
     3999 *
     4000 * @since 1.0.0
     4001 *
     4002 * @global BP_Core_Members_Template $members_template The Members template loop class.
    39534003 *
    39544004 * @return mixed
    … …  
    39614011
    39624012/**
    3963  * @since 1.0.0
     4013 * The current Member being iterated on.
     4014 *
     4015 * @since 1.0.0
     4016 *
     4017 * @global BP_Core_Members_Template $members_template The Members template loop class.
    39644018 *
    39654019 * @return mixed
    … …  
    39854039         *
    39864040         * @since 1.0.0
     4041         *
     4042         * @global BP_Core_Members_Template $members_template The Members template loop class.
    39874043         *
    39884044         * @param array|string $args {@see bp_core_fetch_avatar()}.
    … …  
    40294085         * @since 1.0.0
    40304086         *
     4087         * @global BP_Core_Members_Template $members_template The Members template loop class.
     4088         *
    40314089         * @param array|string $args {@see bp_core_fetch_avatar()}.
    40324090         * @return string
    … …  
    40724130         *
    40734131         * @since 1.0.0
     4132         *
     4133         * @global BP_Core_Members_Template $members_template The Members template loop class.
    40744134         *
    40754135         * @param int $width  Width of avatar to fetch.
    … …  
    41054165
    41064166/**
     4167 * Outputs the group member name.
     4168 *
    41074169 * @since 1.0.0
    41084170 */
    … …  
    41114173}
    41124174        /**
     4175         * Returns the group member's name.
     4176         *
    41134177         * @since 1.0.0
     4178         *
     4179         * @global BP_Core_Members_Template $members_template The Members template loop class.
    41144180         *
    41154181         * @return mixed|void
    … …  
    41294195
    41304196/**
     4197 * Outputs the group member's URL.
     4198 *
    41314199 * @since 1.0.0
    41324200 */
    … …  
    41354203}
    41364204        /**
     4205         * Returns the group member's URL.
     4206         *
    41374207         * @since 1.0.0
     4208         *
     4209         * @global BP_Core_Members_Template $members_template The Members template loop class.
    41384210         *
    41394211         * @return mixed|void
    … …  
    41534225
    41544226/**
     4227 * Outputs the group member's link.
     4228 *
    41554229 * @since 1.0.0
    41564230 */
    … …  
    41594233}
    41604234        /**
     4235         * Returns the group member's link.
     4236         *
    41614237         * @since 1.0.0
     4238         *
     4239         * @global BP_Core_Members_Template $members_template The Members template loop class.
    41624240         *
    41634241         * @return mixed|void
    … …  
    41774255
    41784256/**
     4257 * Outputs the group member's domain.
     4258 *
    41794259 * @since 1.2.0
    41804260 */
    … …  
    41834263}
    41844264        /**
     4265         * Returns the group member's domain.
     4266         *
    41854267         * @since 1.2.0
     4268         *
     4269         * @global BP_Core_Members_Template $members_template The Members template loop class.
    41864270         *
    41874271         * @return mixed|void
    … …  
    42014285
    42024286/**
     4287 * Outputs the group member's friendship status with logged in user.
     4288 *
    42034289 * @since 1.2.0
    42044290 */
    … …  
    42074293}
    42084294        /**
     4295         * Retruns the group member's friendship status with logged in user.
     4296         *
    42094297         * @since 1.2.0
     4298         *
     4299         * @global BP_Core_Members_Template $members_template The Members template loop class.
    42104300         *
    42114301         * @return mixed|void
    … …  
    42454335         * @since 1.0.0
    42464336         *
     4337         * @global BP_Core_Members_Template $members_template The Members template loop class.
     4338         *
    42474339         * @return bool
    42484340         */
    … …  
    43014393         * @since 1.0.0
    43024394         * @since 2.7.0 Added $args as a parameter.
     4395         *
     4396         * @global BP_Core_Members_Template $members_template The Members template loop class.
    43034397         *
    43044398         * @param array|string $args {
    … …  
    43574451         * @since 1.0.0
    43584452         *
     4453         * @global BP_Core_Members_Template $members_template The Members template loop class.
     4454         *
    43594455         * @return int
    43604456         */
    … …  
    43774473
    43784474/**
    4379  * @since 1.0.0
     4475 * Do the list of group members needs a pagination?
     4476 *
     4477 * @since 1.0.0
     4478 *
     4479 * @global BP_Core_Members_Template $members_template The Members template loop class.
    43804480 *
    43814481 * @return bool
    … …  
    44114511
    44124512/**
     4513 * Outputs the group members list pagination links.
     4514 *
    44134515 * @since 1.0.0
    44144516 */
    … …  
    44184520}
    44194521        /**
    4420          * @since 1.0.0
     4522         * Returns the group members list pagination links.
     4523         *
     4524         *  @since 1.0.0
     4525         *
     4526         * @global BP_Core_Members_Template $members_template The Members template loop class.
    44214527         *
    44224528         * @return mixed|void
    … …  
    44364542
    44374543/**
     4544 * Outputs the group members list pagination count.
     4545 *
    44384546 * @since 1.0.0
    44394547 */
    … …  
    44424550}
    44434551        /**
     4552         * Returns the group members list pagination count.
     4553         *
    44444554         * @since 1.0.0
     4555         *
     4556         * @global BP_Core_Members_Template $members_template The Members template loop class.
    44454557         *
    44464558         * @return mixed|void
    … …  
    44754587
    44764588/**
     4589 * Outputs the group members list pagination links inside the Group's Manage screen.
     4590 *
    44774591 * @since 1.0.0
    44784592 */
    … …  
    44824596}
    44834597        /**
     4598         * Returns the group members list pagination links inside the Group's Manage screen.
     4599         *
    44844600         * @since 1.0.0
     4601         *
     4602         * @global BP_Core_Members_Template $members_template The Members template loop class.
    44854603         *
    44864604         * @return mixed
Note: See TracChangeset for help on using the changeset viewer.