You are here

Home » API reference » Webform 7.4 » webform.api.php

function hook_webform_component_defaults_alter in Webform 7.4

Same name and namespace in other branches
  1. 6.3 webform.api.php \hook_webform_component_defaults_alter()
  2. 7.3 webform.api.php \hook_webform_component_defaults_alter()

Alter the list of Webform component default values.

Parameters

$defaults: A list of component defaults as defined by _webform_defaults_COMPONENT().

$type: The component type whose defaults are being provided.

See also

_webform_defaults_component()

Related topics

Webform Module Hooks
Webform's hooks enable other modules to intercept events within Webform, such as the completion of a submission or adding validation. Webform's hooks also allow other modules to provide additional components for use within forms.
1 invocation of hook_webform_component_defaults_alter()
webform_component_defaults in includes/webform.components.inc
Populate a component with the defaults for that type.

File

./webform.api.php, line 596
Sample hooks demonstrating usage in Webform.

Code

function hook_webform_component_defaults_alter(&$defaults, $type) {

  // Alter a default for all component types.
  $defaults['required'] = 1;

  // Add a default for a new field added via hook_form_alter() or
  // hook_form_FORM_ID_alter() for all component types.
  $defaults['extra']['added_field'] = t('Added default value');

  // Add or alter defaults for specific component types:
  switch ($type) {
    case 'select':
      $defaults['extra']['optrand'] = 1;
      break;
    case 'textfield':
    case 'textarea':
      $defaults['extra']['another_added_field'] = t('Another added default value');
  }
}