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-functions.php

    r13312 r13395  
    3838 *
    3939 * @since 1.5.0
    40  *
    41  * @global BuddyPress $bp The one true BuddyPress instance.
    4240 */
    4341function bp_core_define_slugs() {
    … …  
    880878 * @since 1.6.0
    881879 *
    882  * @global BuddyPress $bp The one true BuddyPress instance.
    883  *
    884880 * @param int $user_id The ID for the user.
    885881 * @return bool True if spammer, otherwise false.
    … …  
    953949 *
    954950 * @since 1.6.0
    955  *
    956  * @global BuddyPress $bp The one true BuddyPress instance.
    957951 *
    958952 * @param int $user_id The ID for the user.
    … …  
    12161210 *
    12171211 * @since 2.0.0
    1218  *
    1219  * @global BuddyPress $bp The one true BuddyPress instance.
    12201212 * @global wpdb $wpdb WordPress database object.
    12211213 *
    … …  
    18691861 * @since 1.2.0
    18701862 *
    1871  * @global BuddyPress $bp The one true BuddyPress instance.
    1872  *
    18731863 * @todo There appears to be a bug in the return value on success.
    18741864 *
    … …  
    23292319 * @since 1.1.0
    23302320 *
    2331  * @global BuddyPress $bp The one true BuddyPress instance.
    2332  *
    23332321 * @return string|bool Directory path on success, false on failure.
    23342322 */
    … …  
    26742662 *
    26752663 * @since 2.6.0
    2676  *
    2677  * @global BuddyPress $bp The one true BuddyPress instance.
    26782664 *
    26792665 * @return object The displayed user object, null otherwise.
    … …  
    28602846 * @since 2.2.0
    28612847 *
    2862  * @global BuddyPress $bp The one true BuddyPress instance.
    2863  *
    28642848 * @param string $member_type Unique string identifier for the member type.
    28652849 * @param array  $args {
    … …  
    29882972 * @since 2.2.0
    29892973 *
    2990  * @global BuddyPress $bp The one true BuddyPress instance.
    2991  *
    29922974 * @see bp_register_member_type() for accepted arguments.
    29932975 *
    … …  
    33173299 *
    33183300 * @since 2.3.0
    3319  *
    3320  * @global BuddyPress $bp The one true BuddyPress instance.
    33213301 *
    33223302 * @return string
Note: See TracChangeset for help on using the changeset viewer.