bp_stop_following( array $args = '' )

Stop following a user’s activity.

Description

Parameters

$args

(Optional) Array of arguments.

'leader_id'
(int) The user ID of the person we want to follow.
'follower_id'
(int) The user ID initiating the follow request.

Default value: ''

Return

(bool)

Source

File: bp-activity/bp-activity-functions.php

function bp_stop_following( $args = '' ) {
 
    $r = wp_parse_args( $args, array(
        'leader_id'   => bp_displayed_user_id(),
        'follower_id' => bp_loggedin_user_id()
    ) );
 
    $follow = new BP_Activity_Follow( $r['leader_id'], $r['follower_id'] );
 
    if ( empty( $follow->id ) || ! $follow->delete() ) {
        return false;
    }
 
    /**
     * @todo add title/description
     *
     * @since BuddyBoss 1.0.0
     */
    do_action_ref_array( 'bp_stop_following', array( &$follow ) );
 
    return true;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyBoss 1.0.0	Introduced.

Uses

Uses
Uses	Description
bp-core/bp-core-template.php: bp_loggedin_user_id()	Get the ID of the currently logged-in user.
bp-core/bp-core-template.php: bp_displayed_user_id()	Get the ID of the currently displayed user.
bp-activity/classes/class-bp-activity-follow.php: BP_Activity_Follow::__construct()	Constructor.

Used By
Used By	Description
bp-members/classes/class-bp-rest-members-actions-endpoint.php: BP_REST_Members_Actions_Endpoint::bp_rest_follow_stop_following()	Stop Following the member.
bp-templates/bp-nouveau/includes/follow/ajax.php: bp_nouveau_ajax_followunfollow_member()	Follow/Unfollow a user via a POST request.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents