function hook_skinr_skin_info in Skinr 8.2
Same name and namespace in other branches
- 7.2 skinr.api.php \hook_skinr_skin_info()
Define the skin(s) for this Skinr plugin.
Each skin definition consists of properties that define its form element and settings that are needed to make it work, such as the class(es) Skinr should apply, which files it should load, whether or not it should be disabled by default and which theme hook(s) it was designed to work with.
Each skin name must be unique. Skins cannot have the same name even if they are located in different plugins. It is recommended to prefix the name of each skin with the name of the theme or module implementing it.
Skin settings:
- title (required): Title of the skin form element.
- description (optional): Description of the skin form element.
- group (optional): The group the skin is attached to; defaults to a Skinr provided group labeled "General."
- type (optional): The type of form element. Allowed values:
- checkboxes (default): Useful when single or multiple options can be chosen. This type does not need to be set manually. Skinr will apply it by default.
- select: Useful when a single option can be chosen, but many exist.
- radios: Useful when a single option can be chosen and only a few options exist.
- weight (discouraged): Sets the weight of the skin inside the group; NULL by default. weight should not be set on each individual skin. Instead, it should be used sparingly where positioning a skin at the very top or bottom is desired.
- attached (optional): A array containing information about CSS and
JavaScript files the skin requires. Each entry is an array keyed by type:
- css (optional): Maps to the functionality of drupal_add_css() with one exception: paths are automatically assumed relative to the plugin directory, unless external. Examples:
- js (optional): Maps to the functionality of drupal_add_js() with one exception: paths are automatically assumed as relative to the plugin directory, unless external. Examples:
- options (required): An array containing one or more options (also arrays)
for the user to choose from when applying skins. Each option key should be
a machine name describing the option. An option should including the
following keys:
- title (required): The option label.
- class (required): An array containing one or more classes the skin should apply. All classes should be entered as an array: For example: 'class' => array('class-b', 'class-b')
- attached (optional): Same syntax as above, but applies to a specific option only.
- theme hooks (optional): An array containing certain allowed theme hooks, which allow you to limit where the skin can be used. Allowed options include: block, block__MODULE, comment_wrapper,comment__wrapper_NODETYPE, node, node__NODETYPE, region, region__REGIONNAME, panels_display, panels_region, panels_pane, views_view, views_view__STYLENAME, views_view__DISPLAYNAME, and views_view__VIEWNAME.
- default status (optional): Skins are disabled by default to keep UI clutter to a minimum. In some cases, like contrib themes, it makes sense to enable skins which are required to make the theme work properly by default. Setting this property to 1 will cause it to be enabled by default for all installed themes.
- status: (optional) An associative array whose keys are theme names and whose corresponding values denote the desired default status for the particular theme.
The "hook" prefix is substituted with the name of the module or theme implementing it.
Related topics
8 functions implement hook_skinr_skin_info()
Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.
- skinr_test_basetheme_other_skinr_skin_info in tests/
themes/ skinr_test_basetheme_other/ skinr_test_basetheme_other.skinr.inc - Implements hook_skinr_skin_info().
- skinr_test_basetheme_skinr_skin_info in tests/
themes/ skinr_test_basetheme/ skinr_test_basetheme.skinr.inc - Implements hook_skinr_skin_info().
- skinr_test_incompatible_skinr_skin_info in tests/
modules/ skinr_test_incompatible/ skinr_test_incompatible.module - Implements hook_skinr_skin_info().
- skinr_test_skinr_skin_info in tests/
modules/ skinr_test/ skinr_test.skinr.inc - Implements hook_skinr_skin_info().
- skinr_test_subtheme_other_skinr_skin_info in tests/
themes/ skinr_test_subtheme_other/ skinr_test_subtheme_other.skinr.inc - Implements hook_skinr_skin_info().
File
- ./
skinr.api.php, line 222 - This file contains no working PHP code; it exists to provide additional documentation for doxygen as well as to document hooks in the standard Drupal manner.
Code
function hook_skinr_skin_info() {
$skins['skinr_menus'] = array(
'title' => t('Menu styles'),
'description' => t('Select a style to use for the main navigation.'),
'type' => 'select',
'group' => 'skinr_menus',
'theme hooks' => array(
'block__menu',
'block__menu_block',
),
'attached' => array(
'css' => array(
'css/nav.css',
),
),
'options' => array(
'one_level' => array(
'title' => t('Standard (1 level) - No colors'),
'class' => array(
'nav',
),
),
'menu_a' => array(
'title' => t('Standard (1 level) - Green'),
'class' => array(
'nav',
'nav-a',
),
'attached' => array(
'css' => array(
'css/nav-colors.css',
),
),
),
'menu_b' => array(
'title' => t('Standard (1 level) - Blue'),
'class' => array(
'nav',
'nav-b',
),
'attached' => array(
'css' => array(
'css/nav-colors.css',
),
),
),
'menu_c' => array(
'title' => t('Dropdowns - No colors'),
'class' => array(
'nav',
'nav-dd',
),
'attached' => array(
'css' => array(
'css/nav-dd.css',
),
'js' => array(
'js/dropdown.js',
),
),
),
'menu_d' => array(
'title' => t('Dropdowns - Green'),
'class' => array(
'nav',
'nav-dd',
'nav-a',
),
'attached' => array(
'css' => array(
'css/nav-dd.css',
),
'js' => array(
'js/dropdown.js',
),
),
),
'menu_e' => array(
'title' => t('Dropdowns - Blue'),
'class' => array(
'nav',
'nav-dd',
'nav-b',
),
'attached' => array(
'css' => array(
'css/nav-dd.css',
),
'js' => array(
'js/dropdown.js',
),
),
),
),
// Optional: Specify a global default status for this skin, making it
// available or unavailable to all themes.
'default status' => 0,
// Optional: Specify a default status for a particular theme. This mainly
// makes sense for skins provided by themes only.
'status' => array(
'bartik' => 1,
'garland' => 0,
// In case you are registering a skin for your base theme, then you likely
// do not know which sub themes are going to use your base theme. By
// setting the global default status to 0 (as above) and enabling the skin
// for your base theme itself, the skin's status will be automatically
// inherited to all sub themes of your base theme.
'mybasetheme' => 1,
),
);
$skins['skinr_custom'] = array(
'title' => t('Custom'),
// Use a custom form callback function. This function should return a drupal
// form array(). Example:
// function skinr_skinr_custom_form($form, $form_state, $context) {
// $theme = $context['theme'];
// $skin_name = $context['skin_name'];
// $skin_info = $context['skin_info'];
// $value = $context['value'];
//
// $form = array(
// '#type' => 'checkboxes',
// '#title' => t('Custom'),
// '#options' => array(
// 'custom' => t('Custom'),
// ),
// '#default_value' => $value,
// );
// return $form;
// }
'form callback' => 'skinr_skinr_custom_form',
'group' => 'general',
'theme hooks' => array(
'block__system',
'comment_wrapper__page',
'node__page',
),
'options' => array(
'custom' => array(
'class' => array(
'custom',
),
),
),
);
return $skins;
}