You are here

function ctools_ajax_icon_text_button in Chaos Tool Suite (ctools) 7

Render an icon and related text as a link. This will automatically apply an AJAX class to the link and add the appropriate javascript to make this happen.

Note: 'html' => true so be sure any text is vetted! Chances are these kinds of buttons will not use user input so this is a very minor concern.

Parameters

$text: The text that will be displayed as the link.

$image: The icon image to include in the link.

$dest: The destination of the link.

$alt: The title text of the link.

$class: Any class to apply to the link. @todo this should be a options array.

$type: A type to use, in case a different behavior should be attached. Defaults to ctools-use-ajax.

File

includes/ajax.inc, line 77
Set this so we can tell that the file has been included at some point.

Code

function ctools_ajax_icon_text_button($text, $image, $dest, $alt, $class = '', $type = 'use-ajax') {
  drupal_add_library('system', 'drupal.ajax');
  $rendered_image = theme('image', array(
    'path' => $image,
  ));
  $link_content = $rendered_image . "<span>" . $text . "</span>";
  return l($link_content, $dest, array(
    'html' => TRUE,
    'attributes' => array(
      'class' => array(
        $type,
        $class,
      ),
      'title' => $alt,
    ),
  ));
}