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-activity/bp-activity-template.php

    r13345 r13395  
    108108 * @since 2.4.0 Introduced the `$fields` parameter.
    109109 *
    110  * @global object $activities_template {@link BP_Activity_Template}
     110 * @global BP_Activity_Template $activities_template The main activity template loop class.
    111111 *
    112112 * @param array|string $args {
    … …  
    372372 * @since 1.0.0
    373373 *
    374  * @global object $activities_template {@link BP_Activity_Template}
     374 * @global BP_Activity_Template $activities_template The main activity template loop class.
    375375 *
    376376 * @return bool Returns true when activities are found.
    … …  
    386386 * @since 1.0.0
    387387 *
    388  * @global object $activities_template {@link BP_Activity_Template}
     388 * @global BP_Activity_Template $activities_template The main activity template loop class.
    389389 *
    390390 * @return object The current activity within the loop.
    … …  
    443443 *
    444444 * @since 1.0.0
    445  *
    446  * @global object $activities_template {@link BP_Activity_Template}
    447445 */
    448446function bp_activity_pagination_count() {
    … …  
    455453     * @since 1.2.0
    456454     *
    457      * @global object $activities_template {@link BP_Activity_Template}
     455     * @global BP_Activity_Template $activities_template The main activity template loop class.
    458456     *
    459457     * @return string The pagination text.
    … …  
    492490     * @since 1.0.0
    493491     *
    494      * @global object $activities_template {@link BP_Activity_Template}
     492     * @global BP_Activity_Template $activities_template The main activity template loop class.
    495493     *
    496494     * @return string The pagination links.
    … …  
    514512 * @since 1.5.0
    515513 *
    516  * @global object $activities_template {@link BP_Activity_Template}
     514 * @global BP_Activity_Template $activities_template The main activity template loop class.
    517515 *
    518516 * @return bool $has_more_items True if more items, false if not.
    … …  
    558556     * @since 1.2.0
    559557     *
    560      * @global object $activities_template {@link BP_Activity_Template}
     558     * @global BP_Activity_Template $activities_template The main activity template loop class.
    561559     *
    562560     * @return int The activity count.
    … …  
    590588     * @since 1.2.0
    591589     *
    592      * @global object $activities_template {@link BP_Activity_Template}
     590     * @global BP_Activity_Template $activities_template The main activity template loop class.
    593591     *
    594592     * @return int The activities per page.
    … …  
    690688     * @since 1.2.0
    691689     *
    692      * @global object $activities_template {@link BP_Activity_Template}
     690     * @global BP_Activity_Template $activities_template The main activity template loop class.
    693691     *
    694692     * @return int The activity ID.
    … …  
    722720     * @since 1.2.0
    723721     *
    724      * @global object $activities_template {@link BP_Activity_Template}
     722     * @global BP_Activity_Template $activities_template The main activity template loop class.
    725723     *
    726724     * @return int The activity item ID.
    … …  
    754752     * @since 1.2.0
    755753     *
    756      * @global object $activities_template {@link BP_Activity_Template}
     754     * @global BP_Activity_Template $activities_template The main activity template loop class.
    757755     *
    758756     * @return int The activity secondary item ID.
    … …  
    786784     * @since 1.2.0
    787785     *
    788      * @global object $activities_template {@link BP_Activity_Template}
     786     * @global BP_Activity_Template $activities_template The main activity template loop class.
    789787     *
    790788     * @return string The date the activity was recorded.
    … …  
    818816     * @since 2.1.0
    819817     *
    820      * @global object $activities_template {@link BP_Activity_Template}
     818     * @global BP_Activity_Template $activities_template The main activity template loop class.
    821819     *
    822820     * @return string The date the activity was recorded.
    … …  
    854852     * @since 1.2.0
    855853     *
    856      * @global object $activities_template {@link BP_Activity_Template}
     854     * @global BP_Activity_Template $activities_template The main activity template loop class.
    857855     *
    858856     * @return string The activity object name.
    … …  
    886884     * @since 1.2.0
    887885     *
    888      * @global object $activities_template {@link BP_Activity_Template}
     886     * @global BP_Activity_Template $activities_template The main activity template loop class.
    889887     *
    890888     * @return string The activity type.
    … …  
    908906 * @since 10.0.0
    909907 *
    910  * @global object $activities_template {@link BP_Activity_Template}
     908 * @global BP_Activity_Template $activities_template The main activity template loop class.
    911909 *
    912910 * @return string The activity type template part name.
    … …  
    967965     * @since 1.1.0
    968966     *
    969      * @global object $activities_template {@link BP_Activity_Template}
     967     * @global BP_Activity_Template $activities_template The main activity template loop class.
    970968     *
    971969     * @return int The activity user ID.
    … …  
    999997     * @since 1.2.0
    1000998     *
    1001      * @global object $activities_template {@link BP_Activity_Template}
     999     * @global BP_Activity_Template $activities_template The main activity template loop class.
    10021000     *
    10031001     * @return string $link The activity user link.
    … …  
    10401038     *
    10411039     * @see bp_core_fetch_avatar() For a description of the arguments.
    1042      * @global object $activities_template {@link BP_Activity_Template}
     1040     * @global BP_Activity_Template $activities_template The main activity template loop class.
    10431041     *
    10441042     * @param array|string $args  {
    … …  
    11771175     *
    11781176     * @see bp_core_fetch_avatar() for description of arguments.
    1179      * @global object $activities_template {@link BP_Activity_Template}
     1177     * @global BP_Activity_Template $activities_template The main activity template loop class.
    11801178     *
    11811179     * @param array|string $args  {
    … …  
    13631361     * @since 1.7.0 Introduce function parameter, $args.
    13641362     *
    1365      * @global object $activities_template {@link BP_Activity_Template}
     1363     * @global BP_Activity_Template $activities_template The main activity template loop class.
    13661364     *
    13671365     * @param array $args {
    … …  
    14281426     * @since 1.2.0
    14291427     *
    1430      * @global object $activities_template {@link BP_Activity_Template}
     1428     * @global BP_Activity_Template $activities_template The main activity template loop class.
    14311429     *
    14321430     * @return string The activity content body.
    … …  
    14571455 * @since 10.0.0 Generate a richer content for activity types supporting the feature.
    14581456 *
    1459  * @global object $activities_template {@link BP_Activity_Template}
     1457 * @global BP_Activity_Template $activities_template The main activity template loop class.
    14601458 *
    14611459 * @return bool True if activity has content, false otherwise.
    … …  
    17551753 * @since 1.2.0
    17561754 *
    1757  * @global object $activities_template {@link BP_Activity_Template}
     1755 * @global BP_Activity_Template $activities_template The main activity template loop class.
    17581756 *
    17591757 * @param string $content The activity content.
    … …  
    18311829 * @since 1.2.0
    18321830 *
    1833  * @global object $activities_template {@link BP_Activity_Template}
     1831 * @global BP_Activity_Template $activities_template The main activity template loop class.
    18341832 *
    18351833 * @param false|BP_Activity_Activity $activity Optional. Falls back on the current item in the loop.
    … …  
    19071905     * @since 1.2.0
    19081906     *
    1909      * @global object $activities_template {@link BP_Activity_Template}
     1907     * @global BP_Activity_Template $activities_template The main activity template loop class.
    19101908     *
    19111909     * @param string $args Unused. Left over from an earlier implementation.
    … …  
    19711969     * @since 1.7.0
    19721970     *
    1973      * @global BP_Activity_Template $activities_template
     1971     * @global BP_Activity_Template $activities_template The main activity template loop class.
    19741972     *
    19751973     * @return bool|int False if parent activity can't be found, otherwise
    … …  
    20242022     * @since 1.2.0
    20252023     *
    2026      * @global object $activities_template {@link BP_Activity_Template}
     2024     * @global BP_Activity_Template $activities_template The main activity template loop class.
    20272025     *
    20282026     * @return bool True if user favorite, false otherwise.
    … …  
    20632061     *       this function can probably be streamlined or removed.
    20642062     *
    2065      * @global object $activities_template {@link BP_Activity_Template}
     2063     * @global BP_Activity_Template $activities_template The main activity template loop class.
    20662064     *
    20672065     * @param string $args Unused. Left over from an earlier implementation.
    … …  
    20862084         * @since 1.2.0
    20872085         *
    2088          * @global object $activities_template {@link BP_Activity_Template}
     2086         * @global BP_Activity_Template $activities_template The main activity template loop class.
    20892087         *
    20902088         * @param object $comment The activity object currently being recursed.
    … …  
    21452143 * @since 1.5.0
    21462144 *
    2147  * @global object $activities_template {@link BP_Activity_Template}
     2145 * @global BP_Activity_Template $activities_template The main activity template loop class.
    21482146 *
    21492147 * @return object|bool $current_comment The activity comment currently being
    … …  
    21832181     * @since 1.5.0
    21842182     *
    2185      * @global object $activities_template {@link BP_Activity_Template}
     2183     * @global BP_Activity_Template $activities_template The main activity template loop class.
    21862184     *
    21872185     * @return int|bool $comment_id The ID of the activity comment currently
    … …  
    22182216     * @since 1.5.0
    22192217     *
    2220      * @global object $activities_template {@link BP_Activity_Template}
     2218     * @global BP_Activity_Template $activities_template The main activity template loop class.
    22212219     *
    22222220     * @return int|bool $user_id The user_id of the author of the displayed
    … …  
    22872285     * @since 1.5.0
    22882286     *
    2289      * @global object $activities_template {@link BP_Activity_Template}
     2287     * @global BP_Activity_Template $activities_template The main activity template loop class.
    22902288     *
    22912289     * @return string $name The full name of the activity comment author.
    … …  
    23572355     * @since 2.3.0
    23582356     *
    2359      * @global object $activities_template {@link BP_Activity_Template}
     2357     * @global BP_Activity_Template $activities_template The main activity template loop class.
    23602358     *
    23612359     * @return string|bool $date_recorded Time since the activity was recorded,
    … …  
    24272425     * @since 1.5.0
    24282426     *
    2429      * @global object $activities_template {@link BP_Activity_Template}
     2427     * @global BP_Activity_Template $activities_template The main activity template loop class.
    24302428     *
    24312429     * @return string $content The content of the current activity comment.
    … …  
    24642462     * @since 1.2.0
    24652463     *
    2466      * @global object $activities_template {@link BP_Activity_Template}
     2464     * @global BP_Activity_Template $activities_template The main activity template loop class.
    24672465     *
    24682466     * @param array|null $deprecated Deprecated.
    … …  
    26242622     * @since 1.2.0
    26252623     *
    2626      * @global object $activities_template {@link BP_Activity_Template}
     2624     * @global BP_Activity_Template $activities_template The main activity template loop class.
    26272625     *
    26282626     * @return string The activity comment link.
    … …  
    26562654     * @since 1.2.0
    26572655     *
    2658      * @global object $activities_template {@link BP_Activity_Template}
     2656     * @global BP_Activity_Template $activities_template The main activity template loop class.
    26592657     *
    26602658     * @return string|false The activity comment form no JavaScript
    … …  
    28162814     * @since 1.2.0
    28172815     *
    2818      * @global object $activities_template {@link BP_Activity_Template}
     2816     * @global BP_Activity_Template $activities_template The main activity template loop class.
    28192817     *
    28202818     * @return string The activity favorite link.
    … …  
    28482846     * @since 1.2.0
    28492847     *
    2850      * @global object $activities_template {@link BP_Activity_Template}
     2848     * @global BP_Activity_Template $activities_template The main activity template loop class.
    28512849     *
    28522850     * @return string The activity unfavorite link.
    … …  
    28802878     * @since 1.0.0
    28812879     *
    2882      * @global object $activities_template {@link BP_Activity_Template}
     2880     * @global BP_Activity_Template $activities_template The main activity template loop class.
    28832881     *
    28842882     * @return string The activity item's CSS class.
    … …  
    29382936     * @since 1.1.0
    29392937     *
    2940      * @global object $activities_template {@link BP_Activity_Template}
     2938     * @global BP_Activity_Template $activities_template The main activity template loop class.
    29412939     *
    29422940     * @return string $link Activity delete link. Contains $redirect_to arg
    … …  
    29812979     * @since 2.1.0
    29822980     *
    2983      * @global object $activities_template {@link BP_Activity_Template}
     2981     * @global BP_Activity_Template $activities_template The main activity template loop class.
    29842982     *
    29852983     * @return string $link Activity delete link. Contains $redirect_to arg
    … …  
    31993197 * @since 1.2.0
    32003198 *
    3201  * @global object $activities_template {@link BP_Activity_Template}
     3199 * @global BP_Activity_Template $activities_template The main activity template loop class.
    32023200 *
    32033201 * @return bool $can_comment True if item can receive comments.
    … …  
    39803978     * @since 1.2.0
    39813979     *
    3982      * @global object $activities_template {@link BP_Activity_Template}
     3980     * @global BP_Activity_Template $activities_template The main activity template loop class.
    39833981     *
    39843982     * @return string The activity feed item guid.
    … …  
    40124010     * @since 1.0.0
    40134011     *
    4014      * @global object $activities_template {@link BP_Activity_Template}
     4012     * @global BP_Activity_Template $activities_template The main activity template loop class.
    40154013     *
    40164014     * @return string $title The activity feed item title.
    … …  
    40614059     * @since 1.0.0
    40624060     *
    4063      * @global object $activities_template {@link BP_Activity_Template}
     4061     * @global BP_Activity_Template $activities_template The main activity template loop class.
    40644062     *
    40654063     * @return string The activity feed item link.
    … …  
    40974095     * @since 1.0.0
    40984096     *
    4099      * @global object $activities_template {@link BP_Activity_Template}
     4097     * @global BP_Activity_Template $activities_template The main activity template loop class.
    41004098     *
    41014099     * @return string The activity feed item date.
    … …  
    41334131     * @since 1.0.0
    41344132     *
    4135      * @global object $activities_template {@link BP_Activity_Template}
     4133     * @global BP_Activity_Template $activities_template The main activity template loop class.
    41364134     *
    41374135     * @return string The activity feed item description.
Note: See TracChangeset for help on using the changeset viewer.