Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
01/18/2016 05:18:23 AM (11 years ago)
Author:
tw2113
Message:

Some more docs cleanup and plenty of @since tag additions for Groups Component.

See #6401.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-groups/classes/class-bp-groups-group.php

    r10417 r10454  
    1313/**
    1414 * BuddyPress Group object.
     15 *
     16 * @since 1.6.0
    1517 */
    1618class BP_Groups_Group {
    … …  
    1921         * ID of the group.
    2022         *
     23         * @since 1.6.0
    2124         * @var int
    2225         */
    … …  
    2629         * User ID of the group's creator.
    2730         *
     31         * @since 1.6.0
    2832         * @var int
    2933         */
    … …  
    3337         * Name of the group.
    3438         *
     39         * @since 1.6.0
    3540         * @var string
    3641         */
    … …  
    4045         * Group slug.
    4146         *
     47         * @since 1.6.0
    4248         * @var string
    4349         */
    … …  
    4753         * Group description.
    4854         *
     55         * @since 1.6.0
    4956         * @var string
    5057         */
    … …  
    5663         * Core statuses are 'public', 'private', and 'hidden'.
    5764         *
     65         * @since 1.6.0
    5866         * @var string
    5967         */
    … …  
    6371         * Should (legacy) bbPress forums be enabled for this group?
    6472         *
     73         * @since 1.6.0
    6574         * @var int
    6675         */
    … …  
    7079         * Date the group was created.
    7180         *
     81         * @since 1.6.0
    7282         * @var string
    7383         */
    … …  
    7787         * Data about the group's admins.
    7888         *
     89         * @since 1.6.0
    7990         * @var array
    8091         */
    … …  
    8495         * Data about the group's moderators.
    8596         *
     97         * @since 1.6.0
    8698         * @var array
    8799         */
    … …  
    91103         * Total count of group members.
    92104         *
     105         * @since 1.6.0
    93106         * @var int
    94107         */
    … …  
    145158        /**
    146159         * Constructor method.
     160         *
     161         * @since 1.6.0
    147162         *
    148163         * @param int|null $id   Optional. If the ID of an existing group is provided,
    … …  
    168183        /**
    169184         * Set up data about the current group.
     185         *
     186         * @since 1.6.0
    170187         */
    171188        public function populate() {
    … …  
    251268        /**
    252269         * Save the current group to the database.
     270         *
     271         * @since 1.6.0
    253272         *
    254273         * @return bool True on success, false on failure.
    … …  
    366385         * Delete the current group.
    367386         *
     387         * @since 1.6.0
     388         *
    368389         * @return bool True on success, false on failure.
    369390         */
    … …  
    410431         * Get whether a group exists for a given slug.
    411432         *
     433         * @since 1.6.0
     434         *
    412435         * @param string      $slug       Slug to check.
    413436         * @param string|bool $table_name Optional. Name of the table to check
    … …  
    432455         * Alias of {@link BP_Groups_Group::group_exists()}.
    433456         *
     457         * @since 1.6.0
     458         *
    434459         * @param string $slug See {@link BP_Groups_Group::group_exists()}.
    435460         * @return string|null See {@link BP_Groups_Group::group_exists()}.
    … …  
    441466        /**
    442467         * Get IDs of users with outstanding invites to a given group from a specified user.
     468         *
     469         * @since 1.6.0
    443470         *
    444471         * @param int $user_id ID of the inviting user.
    … …  
    457484        /**
    458485         * Get a list of a user's groups, filtered by a search string.
     486         *
     487         * @since 1.6.0
    459488         *
    460489         * @param string   $filter  Search term. Matches against 'name' and
    … …  
    504533         * Get a list of groups, filtered by a search string.
    505534         *
     535         * @since 1.6.0
     536         *
    506537         * @param string      $filter  Search term. Matches against 'name' and
    507538         *                             'description' fields.
    … …  
    548579         * Check for the existence of a slug.
    549580         *
     581         * @since 1.6.0
     582         *
    550583         * @param string $slug Slug to check.
    551584         * @return string|null The slug, if found. Otherwise null.
    … …  
    562595         * Get the slug for a given group ID.
    563596         *
     597         * @since 1.6.0
     598         *
    564599         * @param int $group_id ID of the group.
    565600         * @return string|null The slug, if found. Otherwise null.
    … …  
    576611         * Check whether a given group has any members.
    577612         *
     613         * @since 1.6.0
     614         *
    578615         * @param int $group_id ID of the group.
    579616         * @return bool True if the group has members, otherwise false.
    … …  
    594631        /**
    595632         * Check whether a group has outstanding membership requests.
     633         *
     634         * @since 1.6.0
    596635         *
    597636         * @param int $group_id ID of the group.
    … …  
    609648        /**
    610649         * Get outstanding membership requests for a group.
     650         *
     651         * @since 1.6.0
    611652         *
    612653         * @param int      $group_id ID of the group.
    … …  
    641682         * @see WP_Meta_Query::queries for a description of the 'meta_query'
    642683         *      parameter format.
     684         *
     685         * @since 1.6.0
    643686         *
    644687         * @param array $args {
    … …  
    10241067         * Get a list of groups, sorted by those that have the most legacy forum topics.
    10251068         *
     1069         * @since 1.6.0
     1070         *
    10261071         * @param int|null          $limit           Optional. The max number of results to return.
    10271072         *                                           Default: null (no limit).
    … …  
    11301175         * Get a list of groups, sorted by those that have the most legacy forum posts.
    11311176         *
     1177         * @since 1.6.0
     1178         *
    11321179         * @param int|null          $limit           Optional. The max number of results to return.
    11331180         *                                           Default: null (no limit).
    … …  
    11971244         * Get a list of groups whose names start with a given letter.
    11981245         *
     1246         * @since 1.6.0
     1247         *
    11991248         * @param string            $letter          The letter.
    12001249         * @param int|null          $limit           Optional. The max number of results to return.
    … …  
    12631312         *
    12641313         * Use BP_Groups_Group::get() with 'type' = 'random' instead.
     1314         *
     1315         * @since 1.6.0
    12651316         *
    12661317         * @param int|null          $limit           Optional. The max number of results to return.
    … …  
    13361387         *       is_confirmed, is_pending, is_banned)
    13371388         *
     1389         * @since 1.6.0
     1390         *
    13381391         * @param array        $paged_groups Array of groups.
    13391392         * @param string|array $group_ids    Array or comma-separated list of IDs matching
    … …  
    14131466         * Delete all invitations to a given group.
    14141467         *
     1468         * @since 1.6.0
     1469         *
    14151470         * @param int $group_id ID of the group whose invitations are being deleted.
    14161471         * @return int|null Number of rows records deleted on success, null on
    … …  
    14311486         * current_user_can( 'bp_moderate' ).
    14321487         *
     1488         * @since 1.6.0
     1489         *
    14331490         * @return int Group count.
    14341491         */
    … …  
    14471504        /**
    14481505         * Get global count of forum topics in public groups (legacy forums).
     1506         *
     1507         * @since 1.6.0
    14491508         *
    14501509         * @param string $type Optional. If 'unreplied', count will be limited to
    … …  
    14821541         * Get the member count for a group.
    14831542         *
     1543         * @since 1.6.0
     1544         *
    14841545         * @param int $group_id Group ID.
    14851546         * @return int Count of confirmed members for the group.
Note: See TracChangeset for help on using the changeset viewer.