function drupal_array_set_nested_value in Drupal 7

Sets a value in a nested array with variable depth.

This helper function should be used when the depth of the array element you are changing may vary (that is, the number of parent keys is variable). It is primarily used for form structures and renderable arrays.

Example:

// Assume you have a 'signature' element somewhere in a form. It might be:
$form['signature_settings']['signature'] = array(
  '#type' => 'text_format',
  '#title' => t('Signature'),
);

// Or, it might be further nested:
$form['signature_settings']['user']['signature'] = array(
  '#type' => 'text_format',
  '#title' => t('Signature'),
);

To deal with the situation, the code needs to figure out the route to the element, given an array of parents that is either

array(
  'signature_settings',
  'signature',
);

in the first case or

array(
  'signature_settings',
  'user',
  'signature',
);

in the second case.

Without this helper function the only way to set the signature element in one line would be using eval(), which should be avoided:

// Do not do this! Avoid eval().
eval('$form[\'' . implode("']['", $parents) . '\'] = $element;');

Instead, use this helper function:

drupal_array_set_nested_value($form, $parents, $element);

However if the number of array parent keys is static, the value should always be set directly rather than calling this function. For instance, for the first example we could just do:

$form['signature_settings']['signature'] = $element;

Parameters

$array: A reference to the array to modify.

$parents: An array of parent keys, starting with the outermost key.

$value: The value to set.

$force: (Optional) If TRUE, the value is forced into the structure even if it requires the deletion of an already existing non-array parent value. If FALSE, PHP throws an error if trying to add into a value that is not an array. Defaults to FALSE.

See also

drupal_array_get_nested_value()

7 calls to drupal_array_set_nested_value()

drupal_validate_form in includes/form.inc

Validates user-submitted form data in the $form_state array.

field_form_set_state in modules/field/field.form.inc

Stores processing information about a field in $form_state.

file_field_widget_submit in modules/file/file.field.inc

Form submission handler for upload/remove button of file_field_widget_form().

file_managed_file_submit in modules/file/file.module

Form submission handler for upload / remove buttons of managed_file elements.

form_process_machine_name in includes/form.inc

Processes a machine-readable name form element.

... See full list

File

includes/common.inc, line 6871

Common functions that many Drupal modules will need to reference.

Code

function drupal_array_set_nested_value(array &$array, array $parents, $value, $force = FALSE) {
  $ref =& $array;
  foreach ($parents as $parent) {

    // PHP auto-creates container arrays and NULL entries without error if $ref
    // is NULL, but throws an error if $ref is set, but not an array.
    if ($force && isset($ref) && !is_array($ref)) {
      $ref = array();
    }
    $ref =& $ref[$parent];
  }
  $ref = $value;
}