Function __global->cns_field_editable

Definitions

sources/cns_field_editability.php

  • Find is a field is editable.Called for fields that have a fair chance of being set to auto-sync, and hence be locked to local edits.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$field_name ID_TEXT No No required parameter N/A N/A Field name
$special_type ID_TEXT No No required parameter N/A N/A The special type of the user (built-in types are: <blank>, ldap, httpauth, <name of import source>)

Returns

  • Whether the field is editable
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find is a field is editable.Called for fields that have a fair chance of being set to auto-sync, and hence be locked to local edits.
 *
 * @param  ID_TEXT $field_name Field name
 * @param  ID_TEXT $special_type The special type of the user (built-in types are: <blank>, ldap, httpauth, <name of import source>)
 * @return boolean Whether the field is editable
 */
function cns_field_editable(string $field_name, string $special_type) : bool