4.6.x filter.module filter_access($format)
4.7.x filter.module filter_access($format)
5.x filter.module filter_access($format)
6.x filter.module filter_access($format)
7.x filter.module filter_access($format, $account = NULL)

Checks if a user has access to a particular text format.


$format: An object representing the text format.

$account: (optional) The user account to check access for; if omitted, the currently logged-in user is used. Defaults to NULL.

Return value

Boolean TRUE if the user is allowed to access the given format.

2 calls to filter_access()
FilterAdminTestCase::testFilterAdmin in modules/filter/filter.test
Tests filter administration functionality.
FilterFormatAccessTestCase::testFormatPermissions in modules/filter/filter.test
Tests the Filter format access permissions functionality.
1 string reference to 'filter_access'
filter_menu in modules/filter/filter.module
Implements hook_menu().


modules/filter/filter.module, line 1029
Framework for handling the filtering of content.


function filter_access($format, $account = NULL) {
  global $user;
  if (!isset($account)) {
    $account = $user;

  // Handle special cases up front. All users have access to the fallback
  // format.
  if ($format->format == filter_fallback_format()) {
    return TRUE;

  // Check the permission if one exists; otherwise, we have a non-existent
  // format so we return FALSE.
  $permission = filter_permission_name($format);
  return !empty($permission) && user_access($permission, $account);