function theme_filter_guidelines

Returns HTML for guidelines for a text format.

Parameters

$variables: An associative array containing:

  • format: An object representing a text format.

Related topics

1 theme call to theme_filter_guidelines()
filter_process_format in modules/filter/filter.module
Expands an element into a base element with text format selector attached.

File

modules/filter/filter.module, line 1211

Code

function theme_filter_guidelines($variables) {
    $format = $variables['format'];
    $attributes['class'][] = 'filter-guidelines-item';
    $attributes['class'][] = 'filter-guidelines-' . $format->format;
    $output = '<div' . drupal_attributes($attributes) . '>';
    $output .= '<h3>' . check_plain($format->name) . '</h3>';
    $output .= theme('filter_tips', array(
        'tips' => _filter_tips($format->format, FALSE),
    ));
    $output .= '</div>';
    return $output;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.