function hook_skinr_api_VERSION in Skinr 8.2

Same name and namespace in other branches

1. 7.2 skinr.api.php \hook_skinr_api_VERSION()

Define the API version of Skinr your code is compatible with.

This is required when creating a new Skinr plugin. It checks to make sure your Skins are compatible with the installed version of Skinr and takes care of loading the include files.

Return value

An associative array describing Skinr API integration:

• directory: (optional) The name of a sub-directory, in which include files containing skin or group definitions may be found.
• path: (optional) The path to the directory containing the directory specified in 'directory'. Defaults to the path of the module or theme implementing the hook.

In case no Skinr plugin include files exist for your implementation, simply define the function with an empty function body.

The "hook" prefix is substituted with the name of the module or theme that implements it, e.g. THEME_skinr_api_VERSION() in template.php, or MODULE_skinr_api_VERSION() in MODULE.module.

VERSION is normally identical to Skinr's major version; e.g., "2".

Related topics

12 functions implement hook_skinr_api_VERSION()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

block_skinr_api_3 in ./skinr.module

comment_skinr_api_3 in ./skinr.module

node_skinr_api_3 in ./skinr.module

skinr_panels_skinr_api_3 in skinr_panels/skinr_panels.module

Implements hook_skinr_api().

skinr_skinr_api_3 in ./skinr.skinr.inc

Implements hook_skinr_api_VERSION().

... See full list

File

./skinr.api.php, line 131

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_api_VERSION() {
  return array(
    'path' => drupal_get_path('module', 'mymodule'),
    'directory' => 'skins',
  );
}