magic.api.php in Magic 7

Hooks provided by the Magic module

File

magic.api.php

<?php

/**
 * @file
 * Hooks provided by the Magic module
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * A hook for modules to add their settings to the magic settings array.
 *
 * This is for modules to add their own settings to the magic settings array
 * which is in reality part of the hook_form_system_theme_settings_alter.
 * Because of magic's low weight, we feel this might be necissary.
 *
 * @param array $magic_settings
 *   The renderable form array of the magic module theme settings.
 * @param string $theme
 *   The theme that the settings will be editing.
 *
 * @return
 *   The array of settings within the magic module theme page.
 */
function hook_magic($magic_settings, $theme) {
  $settings = array();
  $settings['js']['my_own_js_settings'] = array(
    '#type' => 'checkbox',
    '#title' => t('Do you want to?'),
  );
  return $settings;
}

/**
 * Allows altering of the magic settings array.
 *
 * Magic has to change it's weight to be far lower than other modules in the
 * system to allow for the CSS / JS alter hooks to work correctly. As such, we
 * need to allow other modules to alter or add their own settings into the magic
 * module hook. We created this alter hook just for that purpose.
 *
 * THIS CAN ONLY BE USED BY THE THEME ACTIVELY BEING EDITIED AND ITS BASE THEME.
 *
 * @param array $magic_settings
 *   The renderable form array of the magic module theme settings.
 * @param string $theme
 *   The theme that the settings will be editing.
 */
function hook_magic_alter(&$magic_settings, $theme) {
  $magic_settings['css']['my_own_css_settings'] = array(
    '#type' => 'checkbox',
    '#title' => t('Do you want to?'),
  );

  // Add in your own submit handlers.
  $magic_settings['#submit'][] = 'my_module_magic_custom_submit_function';
}

/**
 * @} End of "addtogroup hooks".
 */

Functions

Name	Description
hook_magic	A hook for modules to add their settings to the magic settings array.
hook_magic_alter	Allows altering of the magic settings array.