[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-friends/ -> bp-friends-cache.php (summary)

BuddyPress Friends Caching. Caching functions handle the clearing of cached objects and pages on specific actions throughout BuddyPress.

File Size: 148 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 7 functions

  friends_clear_friend_object_cache()
  bp_friends_clear_bp_friends_friendships_cache()
  bp_friends_clear_bp_friends_friendships_cache_remove()
  bp_friends_clear_request_cache()
  bp_friends_clear_request_cache_on_save()
  bp_friends_clear_request_cache_on_remove()
  bp_friends_delete_cached_friendships_on_friendship_save()

Functions
Functions that are not part of a class:

friends_clear_friend_object_cache( $friendship_id )   X-Ref
Clear friends-related cache for members of a specific friendship.

since: 1.0.0
param: int $friendship_id ID of the friendship whose two members should
return: bool

bp_friends_clear_bp_friends_friendships_cache( $friendship_id, $initiator_user_id, $friend_user_id )   X-Ref
Clear friendship caches on friendship changes.

since: 2.7.0
param: int $friendship_id     ID of the friendship that has changed.
param: int $initiator_user_id ID of the first user.
param: int $friend_user_id    ID of the second user.
return: bool

bp_friends_clear_bp_friends_friendships_cache_remove( $friendship_id, BP_Friends_Friendship $friendship )   X-Ref
Clear friendship caches on friendship changes.

since: 2.7.0
param: int                   $friendship_id The friendship ID.
param: BP_Friends_Friendship $friendship Friendship object.

bp_friends_clear_request_cache( $friend_user_id )   X-Ref
Clear the friend request cache for the user not initiating the friendship.

since: 2.0.0
param: int $friend_user_id The user ID not initiating the friendship.

bp_friends_clear_request_cache_on_save( $friendship_id, $initiator_user_id, $friend_user_id )   X-Ref
Clear the friend request cache when a friendship is saved.

A friendship is deemed saved when a friendship is requested or accepted.

since: 2.0.0
param: int $friendship_id     The friendship ID.
param: int $initiator_user_id The user ID initiating the friendship.
param: int $friend_user_id    The user ID not initiating the friendship.

bp_friends_clear_request_cache_on_remove( $friendship_id, BP_Friends_Friendship $friendship )   X-Ref
Clear the friend request cache when a friendship is removed.

A friendship is deemed removed when a friendship is withdrawn or rejected.

since: 2.0.0
param: int                   $friendship_id The friendship ID.
param: BP_Friends_Friendship $friendship Friendship object.

bp_friends_delete_cached_friendships_on_friendship_save( $friendship )   X-Ref
Delete individual friendships from the cache when they are changed.

since: 3.0.0
param: BP_Friends_Friendship $friendship Friendship object.



Generated: Fri Sep 25 01:01:33 2020 Cross-referenced by PHPXref 0.7.1