function hook_metatag_info in Metatag 7

Definition of the meta tags and groups.

Return value

array A nested array of 'tags' and 'groups', each keyed off the machine name for their respective structure type, with the following values: Tags: 'label' - The name for this meta tag. 'description' - An explanation of what this meta tag is used for and what values are permissible. 'class' - The class name that controls this meta tag. 'weight' - Used to sort the meta tags during output. 'group' - The machine name of a group this meta tag will be contained within. 'context' - Optionally control the type of configuration the meta tag will be available from. Possible values are: [empty] - All meta tags apply to all possible objects, by default. 'global' - This will make it only show in the global meta tag configuration form. [entity type] - Makes the meta tag only show for specific entity types. 'header' - Optionally output the meta tag as an HTTP header value. 'element' - Optional attributes for rendering the meta tag. Should contain the following: '#theme' - The theming function used to render the meta tag. 'replaces' - An optional array of meta tags that this meta tag replaces. Used to indicate that these deprecated meta tags will be replaced by this newer one, their values will be used, upon the next object save the deprecated tag will be entirely replaced by the new meta tag. While one meta tag can replace several others, only one of the possible values will be used, the others will be silently purged upon the next configuration/object save. 'multiple' - If set to TRUE the output will be comma-separated and output as multiple tags. 'image' - If set to TRUE some additional effort will be added to attempt extracting image URLs from the value. Currently limited to matching the default output of core image theming, i.e. the following string: src="[URL]" width= 'url' - If set to TRUE, relative paths will be converted to absolute. 'is_language' - If set to TRUE, will not allow the Drupal default language value "und" to be output. 'maxlength' - If set to a numeric value, meta tag values will be trimmed to this limit, which may be overridden via the settings page. Note: any meta tags with this value assigned can have its maxlength controlled, so setting the attribute to an empty string will allow site builders to adjust the meta tag lengths as needed. 'select_or_other' - If set to TRUE, form[#type] is set to 'select' and the "select_or_other" module is available, that module will be used to provide a text field to manually insert another option. 'form' - Optional items to be passed directly to the form; uses standard Form API values. 'devel_generate' - Optional values to be passed to the Devel Generate submodule. Should be an array containing one of the following values: 'type' - One of the following: 'canonical' - The token for the absolute URL for the current page. 'email' - An email address randomly generated at the site's hostname. 'float' - A random floating point number between 0.0 and 999.999. 'image' - A randomly generated image. 'integer' - A random integer between 0 and 999. 'phone' - A phone number in the format 999-999-9999. 'select' - A value randomly selected from the available form options. 'text' - Random text string. 'twitter' - A Twitter username. 'url' - A randomly generated URL on this site. 'maxlength' - The maximum length / number of iterations of this value, defaults to 10. 'dependencies' - Optional nested array of values to indicate other meta tags that must be present in order for this meta tag to be visible. See The Open Graph and Twitter Cards submodules for example usage. Each dependency must contain the following elements: 'dependency' - The name of the meta tag that is required. 'attribute' - The name of the other meta tag that is to be checked, most meta tags use "value" as the attribute name. 'condition' - The state condition to be checked against, e.g. "filled" to check text values, "checked" for a checkbox, "value" to compare the raw selection; see https://api.drupal.org/drupal_process_states for more details. 'value' - The field value to check the 'condition' against. see https://api.drupal.org/drupal_process_states for further details. Groups: 'label' - The name for this group. 'description' - A detailed explanation of these meta tags. 'form' - Additional items to be passed directly to the form. Note: 'label', 'description', and any text strings passed in 'form', should be translated.

File

./metatag.api.php, line 265: API documentation for the Metatag module.

Code

function hook_metatag_info() {
  return array();
}

You are here

function hook_metatag_info in Metatag 7

Return value

See also

File

Code

API Navigation