BBP_User_Engagements_User::remove_object_from_all_users( int $object_id, string $meta_key = '', string $meta_type = 'post' )

Remove an object from all users


Description Description


Parameters Parameters

$object_id

(Required) The object id

$user_id

(Required) The user id

$meta_key

(Optional) The relationship key

Default value: ''

$meta_type

(Optional) The relationship type (usually 'post')

Default value: 'post'


Top ↑

Return Return

(bool) Returns true on success, false on failure


Top ↑

Source Source

File: includes/common/engagements.php

	public function remove_object_from_all_users( $object_id = 0, $meta_key = '', $meta_type = 'post' ) {

		// Query for users
		$user_ids = $this->get_users_for_object( $object_id, $meta_key, $meta_type );
		$u_count  = count( $user_ids );

		// Count number of removals
		$removed  = array();
		$r_count  = 0;

		// Users have engaged, so remove them
		if ( ! empty( $u_count ) ) {

			// Loop through users and remove them from the object
			foreach ( $user_ids as $user_id ) {
				$removed[] = $this->remove_user_from_object( $object_id, $user_id, $meta_key, $meta_type );
			}

			// Count the removed users
			$r_count = count( $removed );
		}

		// Return true if successfully removed from all users
		return ( $r_count === $u_count );
	}

Top ↑

Changelog Changelog

Changelog
Version Description
2.6.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.