function editor_process_format in Editor 7

A copy of filter_process_format() which adds support for editors.

Expands an element into a base element with text format selector attached.

The form element will be expanded into two separate form elements, one holding the original element, and the other holding the text format selector:

• value: Holds the original element, having its #type changed to the value of #base_type or 'textarea' by default.
• format: Holds the text format fieldset and the text format selection, using the text format id specified in #format or the user's default format by default, if NULL.

The resulting value for the element will be an array holding the value and the format. For example, the value for the body element will be:

$form_state['values']['body']['value'] = 'foo';
$form_state['values']['body']['format'] = 'foo';

Parameters

array $element: The form element to process. Properties used:

• #base_type: The form element #type to use for the 'value' element. 'textarea' by default.
• #format: (optional) The text format ID to preselect. If NULL or not set, the default format for the current user will be used.

Return value

array The expanded element.

See also

filter_process_format()

1 string reference to 'editor_process_format'

editor_element_info_alter in ./editor.module

Implements hook_element_info_alter().

File

./editor.module, line 274

Allows rich text fields to be edited using WYSIWYG client-side editors.

Code

function editor_process_format($element) {
  global $user;

  // Ensure that children appear as subkeys of this element.
  $element['#tree'] = TRUE;
  $blacklist = array(
    // Make form_builder() regenerate child properties.
    '#parents',
    '#id',
    '#name',
    // Do not copy this #process function to prevent form_builder() from
    // recursing infinitely.
    '#process',
    // Description is handled by theme_text_format_wrapper().
    '#description',
    // Ensure proper ordering of children.
    '#weight',
    // Properties already processed for the parent element.
    '#prefix',
    '#suffix',
    '#attached',
    '#processed',
    '#theme_wrappers',
  );

  // Move this element into sub-element 'value'.
  unset($element['value']);
  foreach (element_properties($element) as $key) {
    if (!in_array($key, $blacklist)) {
      $element['value'][$key] = $element[$key];
    }
  }
  $element['value']['#type'] = $element['#base_type'];
  $element['value'] += element_info($element['#base_type']);

  // Get a list of formats to which the current user has access.
  $formats = filter_formats($user);

  // JavaScript settings are not idempotent in Drupal 7 which causes editor
  // configuration information to be added once per text area, resulting in
  // duplicate toolbars, plugins, etc.
  // @see https://www.drupal.org/node/1911578
  static $has_run = FALSE;

  // Ensure that editor attachments are only added once by tracking whether or
  // not they have already been attached.
  if (!$has_run) {

    // Turn original element into a text format wrapper.
    $element['#attached'] = editor_get_attached($formats);
    $has_run = TRUE;
  }

  // Attach Editor module's (this module) library.
  $element['#attached']['library'][] = array(
    'filter',
    'filter',
  );
  $element['#attached']['library'][] = array(
    'editor',
    'drupal.editor',
  );
  $element['#attached']['library'][] = array(
    'editor',
    'drupal.editor.dialog',
  );

  // Use the default format for this user if none was selected.
  if (!isset($element['#format'])) {
    $element['#format'] = filter_default_format($user);
  }

  // Remove the Plain text format if not set and other options are available.
  $fallback_format = variable_get('filter_fallback_format');
  if ($element['#format'] != $fallback_format && count($formats) > 1 && array_key_exists($fallback_format, $formats)) {
    unset($formats[$fallback_format]);
  }

  // Setup child container for the text format widget.
  $element['format'] = array(
    '#type' => 'fieldset',
    '#attributes' => array(
      'class' => array(
        'filter-wrapper',
      ),
    ),
  );

  // Prepare text format guidelines.
  $element['format']['guidelines'] = array(
    '#type' => 'container',
    '#attributes' => array(
      'class' => array(
        'filter-guidelines',
      ),
    ),
    '#weight' => 20,
  );
  foreach ($formats as $format) {
    $options[$format->format] = $format->name;
    $element['format']['guidelines'][$format->format] = array(
      '#theme' => 'filter_guidelines',
      '#format' => $format,
    );
  }

  // If there are multiple options OR if the current text format is no
  // longer available to the current user, then show as a select.
  if (count($options) > 1 || !array_key_exists($element['#format'], $options)) {
    $element['format']['format'] = array(
      '#type' => 'select',
      '#title' => t('Editor'),
      '#options' => $options,
      '#default_value' => $element['#format'],
      '#weight' => 10,
      '#attributes' => array(
        'class' => array(
          'filter-list',
        ),
      ),
      '#parents' => array_merge($element['#parents'], array(
        'format',
      )),
    );
  }
  else {
    $element['format']['format'] = array(
      '#type' => 'hidden',
      '#value' => $element['#format'],
      '#default_value' => $element['#format'],
      '#attributes' => array(
        'class' => array(
          'filter-list',
        ),
      ),
      '#parents' => array_merge($element['#parents'], array(
        'format',
      )),
    );
  }
  $all_formats = filter_formats();
  $format_exists = isset($all_formats[$element['#format']]);
  $user_has_access = isset($formats[$element['#format']]);
  $user_is_admin = user_access('administer filters');

  // If the stored format does not exist, administrators have to assign a new
  // format.
  if (!$format_exists && $user_is_admin) {
    $element['format']['format']['#required'] = TRUE;
    $element['format']['format']['#default_value'] = NULL;

    // Force access to the format selector (it may have been denied above if
    // the user only has access to a single format).
    $element['format']['format']['#access'] = TRUE;
  }
  elseif (!$user_has_access || !$format_exists) {

    // Overload default values into #value to make them unalterable.
    $element['value']['#value'] = $element['value']['#default_value'];
    $element['format']['format']['#value'] = $element['format']['format']['#default_value'];

    // Prepend #pre_render callback to replace field value with user notice
    // prior to rendering.
    $element['value'] += array(
      '#pre_render' => array(),
    );
    array_unshift($element['value']['#pre_render'], 'filter_form_access_denied');

    // Cosmetic adjustments.
    if (isset($element['value']['#rows'])) {
      $element['value']['#rows'] = 3;
    }
    $element['value']['#disabled'] = TRUE;
    $element['value']['#resizable'] = 'none';

    // Hide the text format selector and any other child element (such as text
    // field's summary).
    foreach (element_children($element) as $key) {
      if ($key != 'value') {
        $element[$key]['#access'] = FALSE;
      }
    }
  }
  return $element;
}