fetchUserPermissions (function)

Last updated: Mon, Apr 17, 2023 9:47 am
Return to Knowledgebase

Purpose

Retrieve the permissions assigned to a user with the given user ID.

Location

users/helpers/permissions.php

Parameters

# Parameter Data Type Required Description
1 $user_id integer Yes representing the ID of the user whose permissions need to be fetched

Returns

Data Type Description of Returned Data
array of objects It returns an array of permission objects, where each object contains information about a permission assigned to the user.

Example

fetchUserPermissions(2)

Further Documentation:


/**
* Fetches the permissions assigned to a given user.
*
* @param int $user_id The ID of the user whose permissions need to be fetched.
* @return array An array of permission objects containing information about the user's permissions.
*/
function fetchUserPermissions($user_id)
{
// ...
}



And here is an example usage of the fetchUserPermissions() function:


// Assume the user ID is 1
$user_id = 1;

// Call the function to fetch the permissions assigned to the user
$user_permissions = fetchUserPermissions($user_id);

// Display the permissions in a list
echo "
    ";
    foreach($user_permissions as $permission) {
    echo "
  • " . $permission->permission_name . "
  • ";
    }
    echo "
";

In this example, the function fetches the permissions assigned to the user with the ID 1 and displays them in an HTML list. Note that the DB class and query() method referenced in the function should be defined elsewhere in your code.

So, if you have a user with 10 permission levels, you will get an array of 10 objects.