function hook_feeds_processor_targets in Feeds 7.2

Adds mapping targets for processors.

This hook allows additional target options to be added to the processors mapping form.

If the key in $targets[] does not correspond to the actual key on the node object ($node->key), real_target MUST be specified. See mappers/link.inc

For an example implementation, see mappers/text.inc

Parameters

string $entity_type: The entity type of the target, for instance a 'node' entity.

string $bundle: The entity bundle to return targets for.

Return value

array An array whose keys are the target name and whose values are arrays containing the following keys:

name: A human readable, translated label for the target.
description: (optional) A human readable, translated description for the target.
callback: The callback used to set the value on the target.
real_target: (optional) the name of the property on the entity that will be set by the callback. Specify this if the target name is not equal to the entity property name. This information will be used to clear the right target at the beginning of the mapping process.
optional_unique: (optional) A boolean that indicates whether or not the target can be used as an unique target. If you set this to TRUE, be sure to also specify "unique_callbacks".
unique_callbacks: (optional) An array of callbacks that are used to retrieve existing entity ids. Existing entities can be updated based on unique targets.
form_callbacks: (optional) An array of callbacks that are used to return a form with additional configuration for a target.
summary_callbacks: (optional) An array of callbacks that are used to display values of additional target configuration.
preprocess_callbacks: (optional) An array of callbacks that are used to set or change mapping options.
deprecated: (optional) A boolean that if TRUE, hides the target from the UI. Use this if you want to rename targets for consistency, but don't want to break importers that are using the old target name. If an importer uses this target it will show up as "DEPRECATED" in the UI.

File

./feeds.api.php, line 340: Documentation of Feeds hooks.

Code

function hook_feeds_processor_targets($entity_type, $bundle) {
  $targets = array();
  if ($entity_type == 'node') {

    // Example 1: provide the minimal info for a target. Description is
    // optional, but recommended.
    // @see my_module_set_target()
    $targets['my_node_field'] = array(
      'name' => t('My custom node field'),
      'description' => t('Description of what my custom node field does.'),
      'callback' => 'callback_my_module_set_target',
    );

    // Example 2: specify "real_target" if the target name is different from
    // the entity property name.
    // Here the target is called "my_node_field2:uri", but the entity property
    // is called "my_node_field2". This will ensure that the property
    // "my_node_field2" is cleared out that the beginning of the mapping
    // process.
    $targets['my_node_field2:uri'] = array(
      'name' => t('My third custom node field'),
      'description' => t('A target that sets a property that does not have the same name as the target.'),
      'callback' => 'my_module_set_target2',
      'real_target' => 'my_node_field2',
    );

    // Example 3: you can make your target selectable as an unique target by
    // setting "optional_unique" to TRUE and specify one or more callbacks to
    // retrieve existing entity id's.
    // @see my_module_mapper_unique()
    $targets['my_node_field3'] = array(
      'name' => t('My third custom node field'),
      'description' => t('A field that can be set as an unique target.'),
      'callback' => 'my_module_set_target3',
      'optional_unique' => TRUE,
      'unique_callbacks' => array(
        'callback_my_module_mapper_unique',
      ),
    );

    // Example 4: use the form and summary callbacks to add additional
    // configuration options for your target. Use the form callbacks to provide
    // a form to set the target configuration. Use the summary callbacks to
    // display the target configuration.
    // @see my_module_form_callback()
    // @see my_module_summary_callback()
    $targets['my_node_field4'] = array(
      'name' => t('My fourth custom node field'),
      'description' => t('A field with additional configuration.'),
      'callback' => 'my_module_set_target4',
      'form_callbacks' => array(
        'callback_my_module_form_callback',
      ),
      'summary_callbacks' => array(
        'callback_my_module_summary_callback',
      ),
    );

    // Example 5: use preprocess callbacks to set or change mapping options.
    // @see my_module_preprocess_callback()
    $targets['my_node_field5'] = array(
      'name' => t('My fifth custom node field'),
      'description' => t('A field with additional configuration.'),
      'callback' => 'my_module_set_target5',
      'preprocess_callbacks' => array(
        'callback_my_module_preprocess_callback',
      ),
    );

    // Example 6: when you want to remove or rename previously provided targets,
    // you can set "deprecated" to TRUE for the old target name. This will make
    // the target to be no longer selectable in the UI. If an importer uses this
    // target it will show up as "DEPRECATED" in the UI.
    // If you want that the target continues to work, you can still specify the
    // callback.
    $targets['deprecated_target'] = array(
      'name' => t('A target that cannot be chosen in the UI.'),
      'deprecated' => TRUE,
    );
  }
  return $targets;
}

You are here

function hook_feeds_processor_targets in Feeds 7.2

Parameters

Return value

Related topics

File

Code

API Navigation