dynamic_background.api.php in Dynamic Background 7.2

Hooks provided by the dynamic background module.

File

dynamic_background.api.php

<?php

/**
 * @file
 * Hooks provided by the dynamic background module.
 *
 */

/**
 * Sub-modules that provieds image selection to the css generation process have
 * to implement this hook.
 *
 * @param array $vars
 * @return array
 */
function hook_dynamic_background_css($vars) {
  return array(
    'image' => 'PATH TO IMAGE',
    'css_configuration' => array(
      'selector' => 'CSS SELECTOR',
      'css' => 'CSS OPTIONS',
    ),
    'image_style' => 'IMAGE STYLE NAME',
  );
}
function hook_dynamic_background_info() {
  return array(
    'type' => 'UNIQUE IDENTIFIER',
    'menu' => array(
      'title' => t('Settings'),
      'description' => t('Configure dynamic backgrounds'),
      'weight' => 50,
    ),
    'upload' => FALSE | TRUE,
  );
}
function hook_dynamic_background_settings_form() {
}

/**
 * Sub-modules that provieds image selection to the css generation process have
 * to implement this hook. It's used to determind the default weight of the
 * sub-module.
 */
function hook_dynamic_background_weight() {
  return array(
    'weight' => -30,
  );
}

/**
 * Customize the image selector display.
 *
 * @param $form
 *   A nested array of images, and other settings, as returned by
 *   dynamic_background_image_selector_form().
 * @param $settings
 *   The settings that will be used to display the image for this object.
 * @param $instance
 *   The {dynamic_background_usage} record for this object.
 */
function hook_dynamic_background_selector_alter(&$form, $settings, $instance) {
}

Functions

Name	Description
hook_dynamic_background_css	Sub-modules that provieds image selection to the css generation process have to implement this hook.
hook_dynamic_background_info
hook_dynamic_background_selector_alter	Customize the image selector display.
hook_dynamic_background_settings_form
hook_dynamic_background_weight	Sub-modules that provieds image selection to the css generation process have to implement this hook. It's used to determind the default weight of the sub-module.