Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
06/02/2015 05:21:07 AM (10 years ago)
Author:
tw2113
Message:

Initial documentation cleanup for the BP Groups component.

See #6401.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r9819 r9906  
    22
    33/**
    4  * BuddyPress Groups Caching
     4 * BuddyPress Groups Caching.
    55 *
    66 * Caching functions handle the clearing of cached objects and pages on specific
    … …  
    2525 * groupmeta within a loop context.
    2626 *
    27  * @param int|str|array $group_ids Accepts a single group_id, or a
    28  *        comma-separated list or array of group ids.
     27 *
     28 * @param int|string|array|bool $group_ids Accepts a single group_id, or a
     29 *                                         comma-separated list or array of
     30 *                                         group ids.
    2931 */
    3032function bp_groups_update_meta_cache( $group_ids = false ) {
    … …  
    4648 * Clear the cached group count.
    4749 *
    48  * @param $group_id Not used.
     50 * @param int $group_id Not used.
    4951 */
    5052function groups_clear_group_object_cache( $group_id ) {
    … …  
    7678 *
    7779 * @since BuddyPress (2.0.0)
     80 *
     81 * @param int $meta_id
     82 * @param int $group_id
    7883 */
    7984function bp_groups_delete_group_cache_on_metadata_change( $meta_id, $group_id ) {
    … …  
    8893 * @since BuddyPress (1.6.0)
    8994 *
    90  * @param int $group_id ID of the group.
     95 * @param int             $group_id ID of the group.
    9196 * @param BP_Groups_Group $group_obj Group object.
    9297 */
    … …  
    98103
    99104/**
    100  * Clears caches for all members in a group when a group is deleted
     105 * Clears caches for all members in a group when a group is deleted.
    101106 *
    102107 * @since BuddyPress (1.6.0)
    103108 *
    104109 * @param BP_Groups_Group $group_obj Group object.
    105  * @param array User IDs who were in this group.
     110 * @param array           $user_ids  User IDs who were in this group.
    106111 */
    107112function bp_groups_clear_group_members_caches( $group_obj, $user_ids ) {
    … …  
    136141 *
    137142 * @param int $group_id The group ID. Not used in this function.
    138  * @param int $user_id The user ID.
     143 * @param int $user_id  The user ID.
    139144 */
    140145function bp_groups_clear_invite_count_on_uninvite( $group_id, $user_id ) {
    … …  
    148153 * @since BuddyPress (2.0.0)
    149154 *
    150  * @param int $group_id The group ID. Not used in this function.
     155 * @param int   $group_id      The group ID. Not used in this function.
    151156 * @param array $invited_users Array of invited user IDs.
    152157 */
    … …  
    162167 *
    163168 * @param int $group_id The group ID. Not used in this function.
    164  * @param int $user_id The user ID.
     169 * @param int $user_id  The user ID.
    165170 */
    166171function groups_clear_group_user_object_cache( $group_id, $user_id ) {
Note: See TracChangeset for help on using the changeset viewer.