Function __global->check_privilege

Definitions

sources/permissions.php

  • Require presence of a privilege for the current member; otherwise exit.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$privilege ID_TEXT No No required parameter N/A N/A The privilege to require
$cats ?array No No Null N/A N/A A list of cat details to require access to (c-type-1,c-id-1,c-type-2,c-d-2,...) (null: N/A)
$member_id ?MEMBER No No Null N/A N/A Member to check for (null: current user)
$page_name ?ID_TEXT No No Null N/A N/A Page name to check for (null: current page)

Preview

Code (PHP)

/**
 * Require presence of a privilege for the current member; otherwise exit.
 *
 * @param  ID_TEXT $privilege The privilege to require
 * @param  ?array $cats A list of cat details to require access to (c-type-1,c-id-1,c-type-2,c-d-2,...) (null: N/A)
 * @param  ?MEMBER $member_id Member to check for (null: current user)
 * @param  ?ID_TEXT $page_name Page name to check for (null: current page)
 */
function check_privilege(string $privilege, ?array $cats = null, ?int $member_id = null, ?string $page_name = null)