block_class.module in Block Class 7.2

Enhanced control over the CSS Classes of any Block.

Block Class allows users to add classes to any block through the block's configuration interface. This implementation is based on an alteration of the Core block database table to leverage the Core Block API functions, objects and structure.

File

block_class.module

<?php

/**
 * @file
 * Enhanced control over the CSS Classes of any Block.
 *
 * Block Class allows users to add classes to any block through the block's
 * configuration interface. This implementation is based on an alteration of
 * the Core block database table to leverage the Core Block API functions,
 * objects and structure.
 */

/**
 * Implements hook_help().
 */
function block_class_help($path, $arg) {
  switch ($path) {

    // Main module help for the block_class module
    case 'admin/help#block_class':
      $output = '<p>Block Class allows users to add classes to any block through the block\'s configuration interface. By adding a very short snippet of PHP to a theme\'s block.tpl.php file, classes can be added to the parent element of a block.</p>';
      $output .= '<p>For more information, please visit the <a href="https://www.drupal.org/project/block_class">official project page on Drupal.org</a>.</p>';
      return $output;
  }
}

/**
 * Implements hook_permission().
 */
function block_class_permission() {
  return array(
    'administer block classes' => array(
      'title' => t('Administer block classes'),
      'description' => t('Set CSS classes for blocks.'),
    ),
  );
}

/**
 * Implements theme_preprocess_block().
 *
 * Extend block's classes with any user defined classes.
 */
function block_class_preprocess_block(&$vars) {
  $block = $vars['block'];
  if (!empty($block->css_class)) {
    $classes_array = explode(' ', $block->css_class);
    foreach ($classes_array as $class) {
      $vars['classes_array'][] = drupal_clean_css_identifier($class, array());
    }
  }
}

/**
 * Implements hook_preprocess_HOOK().
 *
 * Extend panel block's classes with any user defined classes.
 */
function block_class_preprocess_panels_pane(&$vars) {
  if ($vars['pane']->type != 'block') {
    return;
  }

  // Infer the block's $module and $delta from the pane subtype.
  $block_parts = explode('-', $vars['pane']->subtype);

  // Load the block based on the block parts.
  $block = block_load($block_parts[0], $block_parts[1]);

  // Add a generic 'module type' pane class.
  $vars['classes_array'][] = drupal_html_class('pane-' . $block->module);

  // Add $css_class to the $classes_array.
  if (!empty($block->css_class)) {
    $classes_array = explode(' ', $block->css_class);
    foreach ($classes_array as $class) {
      $vars['classes_array'][] = drupal_clean_css_identifier($class, array());
    }
  }
}

/**
 * Implements hook_form_alter().
 *
 * Alter block edit form to add configuration field.
 */
function block_class_form_alter(&$form, &$form_state, $form_id) {

  // Form ids of modules with block creation pages also need to be checked.
  if (user_access('administer block classes') && in_array($form_id, array(
    'block_admin_configure',
    'block_add_block_form',
    'menu_block_add_block_form',
  ))) {

    // Load statically cached block object used to display the form.
    $block = block_load($form['module']['#value'], $form['delta']['#value']);
    $form['settings']['css_class'] = array(
      '#type' => 'textfield',
      '#title' => t('CSS class(es)'),
      '#default_value' => isset($block->css_class) ? $block->css_class : '',
      '#description' => t('Customize the styling of this block by adding CSS classes. Separate multiple classes by spaces.'),
      '#maxlength' => 255,
    );
    $form['#submit'][] = 'block_class_form_submit';
  }
}

/**
 * Helper function: additional submit callback for block configuration pages.
 *
 * Save supplied CSS classes.
 */
function block_class_form_submit($form, &$form_state) {

  // Form ids of modules with block creation pages also need to be checked.
  if (in_array($form_state['values']['form_id'], array(
    'block_admin_configure',
    'block_add_block_form',
    'menu_block_add_block_form',
  ))) {

    // Only save if value has changed.
    if (isset($form_state['values']['css_class']) && $form['settings']['css_class']['#default_value'] != $form_state['values']['css_class'] && user_access('administer blocks')) {
      db_update('block')
        ->fields(array(
        'css_class' => $form_state['values']['css_class'],
      ))
        ->condition('module', $form_state['values']['module'])
        ->condition('delta', $form_state['values']['delta'])
        ->execute();

      // Flush all context module cache to use the updated css_class.
      if (module_exists('context')) {
        cache_clear_all('context', 'cache', TRUE);
      }
    }
  }
}

Functions

Name	Description
block_class_form_alter	Implements hook_form_alter().
block_class_form_submit	Helper function: additional submit callback for block configuration pages.
block_class_help	Implements hook_help().
block_class_permission	Implements hook_permission().
block_class_preprocess_block	Implements theme_preprocess_block().
block_class_preprocess_panels_pane	Implements hook_preprocess_HOOK().