class DefaultValue

Returns a given default value if the input is empty.

The default_value process plugin provides the ability to set a fixed default value. The plugin returns a default value if the input value is considered empty (NULL, FALSE, 0, '0', an empty string, or an empty array). The strict configuration key can be used to set the default only when the incoming value is NULL.

Available configuration keys:

• default_value: The fixed default value to apply.
• strict: (optional) Use strict value checking. Defaults to false.
  • FALSE: Apply default when input value is empty().
  • TRUE: Apply default when input value is NULL.

Example:

process:
  uid:
    -
      plugin: migration_lookup
      migration: users
      source: author
    -
      plugin: default_value
      default_value: 44

This will look up the source value of author in the users migration and if not found, set the destination property uid to 44.

Plugin annotation

@MigrateProcessPlugin(
  id = "default_value",
  handle_multiples = TRUE
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
    • class \Drupal\migrate\ProcessPluginBase implements \Drupal\migrate\Plugin\MigrateProcessInterface extends \Drupal\Core\Plugin\PluginBase
      • class \Drupal\migrate\Plugin\migrate\process\DefaultValue extends \Drupal\migrate\ProcessPluginBase

Expanded class hierarchy of DefaultValue

See also

\Drupal\migrate\Plugin\MigrateProcessInterface

File

core/modules/migrate/src/Plugin/migrate/process/DefaultValue.php, line 48

Namespace

class DefaultValue extends ProcessPluginBase {
  
  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if (!empty($this->configuration['strict'])) {
      return isset($value) ? $value : $this->configuration['default_value'];
    }
    return $value ?: $this->configuration['default_value'];
  }

}

Members