Skip to:
Content

BuddyPress.org


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed

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

    r13185 r13395  
    210210     *
    211211     * @since 1.5.0
    212      *
    213      * @global BuddyPress $bp The one true BuddyPress instance.
    214212     *
    215213     * @return string
    … …  
    249247     * @since 1.5.0
    250248     *
    251      * @global BuddyPress $bp The one true BuddyPress instance.
    252      *
    253249     * @return string
    254250     */
    … …  
    312308 * @since 10.0.0 Added `date_query` parameter.
    313309 *
    314  * @global BP_Core_Members_Template $members_template
     310 * @global BP_Core_Members_Template $members_template The main member template loop class.
    315311 *
    316312 * @param array|string $args {
    … …  
    459455 * @since 1.2.0
    460456 *
    461  * @global BP_Core_Members_Template $members_template
     457 * @global BP_Core_Members_Template $members_template The main member template loop class.
    462458 *
    463459 * @return object
    … …  
    473469 * @since 1.2.0
    474470 *
    475  * @global BP_Core_Members_Template $members_template
     471 * @global BP_Core_Members_Template $members_template The main member template loop class.
    476472 *
    477473 * @return bool
    … …  
    495491     * @since 1.5.0
    496492     *
    497      * @global BP_Core_Members_Template $members_template
     493     * @global BP_Core_Members_Template $members_template The main member template loop class.
    498494     *
    499495     * @return string
    … …  
    564560     * @since 1.2.0
    565561     *
    566      * @global BP_Core_Members_Template $members_template
     562     * @global BP_Core_Members_Template $members_template The main member template loop class.
    567563     *
    568564     * @return string
    … …  
    594590     * @since 1.2.0
    595591     *
    596      * @global BP_Core_Members_Template $members_template
     592     * @global BP_Core_Members_Template $members_template The main member template loop class.
    597593     *
    598594     * @return int Member ID.
    … …  
    630626     * @since 1.7.0
    631627     *
    632      * @global BP_Core_Members_Template $members_template
     628     * @global BP_Core_Members_Template $members_template The main member template loop class.
    633629     *
    634630     * @param array $classes Array of custom classes.
    … …  
    702698     * @since 1.2.5
    703699     *
    704      * @global BP_Core_Members_Template $members_template
     700     * @global BP_Core_Members_Template $members_template The main member template loop class.
    705701     *
    706702     * @return string Members nicename.
    … …  
    732728     * @since 1.2.5
    733729     *
    734      * @global BP_Core_Members_Template $members_template
     730     * @global BP_Core_Members_Template $members_template The main member template loop class.
    735731     *
    736732     * @return string Member's login.
    … …  
    762758     * @since 1.2.5
    763759     *
    764      * @global BP_Core_Members_Template $members_template
     760     * @global BP_Core_Members_Template $members_template The main member template loop class.
    765761     *
    766762     * @return string Member's email address.
    … …  
    826822     * @since 1.2.0
    827823     *
    828      * @global BP_Core_Members_Template $members_template
     824     * @global BP_Core_Members_Template $members_template The main member template loop class.
    829825     *
    830826     * @see bp_core_fetch_avatar() For a description of arguments and
    … …  
    905901     * @since 1.2.0
    906902     *
    907      * @global BP_Core_Members_Template $members_template
     903     * @global BP_Core_Members_Template $members_template The main member template loop class.
    908904     *
    909905     * @return string
    … …  
    972968     * @since 1.2.0
    973969     *
    974      * @global BP_Core_Members_Template $members_template
     970     * @global BP_Core_Members_Template $members_template The main member template loop class.
    975971     *
    976972     * @return string The user's fullname for display.
    … …  
    10271023     * @since 2.7.0 Added 'relative' as a parameter to $args.
    10281024     *
    1029      * @global BP_Core_Members_Template $members_template
     1025     * @global BP_Core_Members_Template $members_template The main member template loop class.
    10301026     *
    10311027     * @param array $args {
    … …  
    11001096     * @since 1.2.0
    11011097     *
    1102      * @global BP_Core_Members_Template $members_template
     1098     * @global BP_Core_Members_Template $members_template The main member template loop class.
    11031099     *
    11041100     * @param array|string $args {
    … …  
    11831179     * @since 1.2.0
    11841180     *
    1185      * @global BP_Core_Members_Template $members_template
     1181     * @global BP_Core_Members_Template $members_template The main member template loop class.
    11861182     *
    11871183     * @param array|string $args {
    … …  
    12881284     * @since 2.7.0 Added `$args` as a parameter.
    12891285     *
    1290      * @global BP_Core_Members_Template $members_template
     1286     * @global BP_Core_Members_Template $members_template The main member template loop class.
    12911287     *
    12921288     * @param array $args {
    … …  
    14341430 *
    14351431 * @since 1.1.0
    1436  *
    1437  * @global BuddyPress $bp The one true BuddyPress instance.
    14381432 *
    14391433 * @todo Move to a back-compat file?
    … …  
    15771571 *
    15781572 * @since 1.1.0
    1579  *
    1580  * @global BuddyPress $bp The one true BuddyPress instance.
    15811573 */
    15821574function bp_get_displayed_user_nav() {
    … …  
    17611753     * @since 1.5.0
    17621754     *
    1763      * @global BuddyPress $bp The one true BuddyPress instance.
    1764      *
    17651755     * @return string
    17661756     */
    … …  
    19481938 * @since 1.0.0
    19491939 *
    1950  * @global BuddyPress $bp The one true BuddyPress instance.
    1951  *
    19521940 * @return string
    19531941 */
    … …  
    19701958 * @since 1.0.0
    19711959 *
    1972  * @global BuddyPress $bp The one true BuddyPress instance.
    1973  *
    19741960 * @return string
    19751961 */
    … …  
    20001986     * @since 1.2.0
    20011987     *
    2002      * @global BuddyPress $bp The one true BuddyPress instance.
    2003      *
    20041988     * @return string
    20051989     */
    … …  
    20382022     * @since 1.0.0
    20392023     *
    2040      * @global BuddyPress $bp The one true BuddyPress instance.
    2041      *
    20422024     * @return string
    20432025     */
    … …  
    20672049     *
    20682050     * @since 1.2.0
    2069      *
    2070      * @global BuddyPress $bp The one true BuddyPress instance.
    20712051     *
    20722052     * @return string
    … …  
    21032083     *
    21042084     * @since 1.2.0
    2105      *
    2106      * @global BuddyPress $bp The one true BuddyPress instance.
    21072085     *
    21082086     * @return string
    … …  
    27162694     * @since 1.1.0
    27172695     *
    2718      * @global BuddyPress $bp The one true BuddyPress instance.
    2719      *
    27202696     * @return string
    27212697     */
    … …  
    27812757     * @since 1.1.0
    27822758     *
    2783      * @global BuddyPress $bp The one true BuddyPress instance.
    2784      *
    27852759     * @return string
    27862760     */
    … …  
    28052779     *
    28062780     * @since 1.1.0
    2807      *
    2808      * @global BuddyPress $bp The one true BuddyPress instance.
    28092781     *
    28102782     * @see bp_core_fetch_avatar() for description of arguments.
    … …  
    30162988     * @since 1.5.0
    30172989     *
    3018      * @global BuddyPress $bp The one true BuddyPress instance.
    3019      *
    30202990     * @param string       $component  ID of the component (eg 'friends').
    30212991     * @param string       $action     Optional. 'action' slug (eg 'invites').
    … …  
    31083078 *
    31093079 * @since 8.0.0
    3110  *
    3111  * @global BuddyPress $bp The one true BuddyPress instance.
    31123080 *
    31133081 * @param array|string $args {
    … …  
    31893157 * @since 8.0.0
    31903158 *
    3191  * @global BuddyPress $bp The one true BuddyPress instance.
    3192  *
    31933159 * @return array List of network invitations.
    31943160 */
    … …  
    32023168 * @since 8.0.0
    32033169 *
    3204  * @global BuddyPress $bp The one true BuddyPress instance.
    3205  *
    32063170 * @return object The current network invitation within the loop.
    32073171 */
    … …  
    32223186     *
    32233187     * @since 8.0.0
    3224      *
    3225      * @global BuddyPress $bp The one true BuddyPress instance.
    32263188     *
    32273189     * @return string HTML for the pagination count.
    … …  
    32643226     *
    32653227     * @since 8.0.0
    3266      *
    3267      * @global BuddyPress $bp The one true BuddyPress instance.
    32683228     *
    32693229     * @return string HTML for the pagination links.
Note: See TracChangeset for help on using the changeset viewer.