You are here

function hook_taxonomy_tools_overview_info_icons in Taxonomy Tools 8

Same name and namespace in other branches
  1. 7 taxonomy_tools.api.php \hook_taxonomy_tools_overview_info_icons()

Define informative icons for specified taxonomy term.

Parameters

int $tid: Taxonomy term identificator.

Return value

array An associative array keyed by a unique name of the icon. Each icon is an associative array containing:

  • path: Either the path of the image file (relative to base_path()) or a full URL.
  • width: The width of the image (if known).
  • height: The height of the image (if known).
  • alt: The alternative text for text-based browsers. HTML 4 and XHTML 1.0 always require an alt attribute. The HTML 5 draft allows the alt attribute to be omitted in some cases. Therefore, this variable defaults to an empty string, but can be set to NULL for the attribute to be omitted. Usually, neither omission nor an empty string satisfies accessibility requirements, so it is strongly encouraged for code calling theme('image') to pass a meaningful value for this variable. http://www.w3.org/TR/REC-html40/struct/objects.html#h-13.8 http://www.w3.org/TR/xhtml1/dtds.html http://dev.w3.org/html5/spec/Overview.html#alt
  • title: The title text is displayed when the image is hovered in some popular browsers.
  • attributes: Associative array of attributes to be placed in the img tag.
1 function implements hook_taxonomy_tools_overview_info_icons()

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

taxonomy_tools_redirect_taxonomy_tools_overview_info_icons in taxonomy_tools_redirect/taxonomy_tools_redirect.module
Implements hook_taxonomy_tools_overview_info_icons().
1 invocation of hook_taxonomy_tools_overview_info_icons()
taxonomy_tools_overview in ./taxonomy_tools.admin.inc
Build taxonomy overview form.

File

./taxonomy_tools.api.php, line 35
Hooks provided by the Taxonomy Tools module.

Code

function hook_taxonomy_tools_overview_info_icons($tid) {
  $images = array();
  $images['sample_image'] = array(
    'path' => 'sample_image.png',
    'title' => 'Sample image',
    'alt' => 'sample image',
    'attributes' => array(),
  );
  return $images;
}