Home › API reference › field.module

field_access

  1. drupal
    1. 7
Versions
7 field_access($op, $field, $entity_type, $entity = NULL, $account = NULL)

Determine whether the user has access to a given field.

Parameters

$op The operation to be performed. Possible values:

  • "edit"
  • "view"

$field The field on which the operation is to be performed.

$entity_type The type of $entity; e.g. 'node' or 'user'.

$entity (optional) The entity for the operation.

$account (optional) The account to check, if not given use currently logged in user.

Return value

TRUE if the operation is allowed; FALSE if the operation is denied.

Related topics

Field API
Attach custom data fields to Drupal entities.

▸ 3 functions call field_access()

▾ 3 functions call field_access()

field_default_form in drupal/modules/field/field.form.inc
Create a separate form element for each field.
field_default_view in drupal/modules/field/field.default.inc
Builds a renderable array for field values.
file_file_download in drupal/modules/file/file.module
Implements hook_file_download().

Code

drupal/modules/field/field.module, line 974

<?php
function field_access($op, $field, $entity_type, $entity = NULL, $account = NULL) {
  global $user;

  if (!isset($account)) {
    $account = $user;
  }

  foreach (module_implements('field_access') as $module) {
    $function = $module . '_field_access';
    $access = $function($op, $field, $entity_type, $entity, $account);
    if ($access === FALSE) {
      return FALSE;
    }
  }
  return TRUE;
}
?>