block_example_block_info

Implements hook_block_info().

This hook declares what blocks are provided by the module.

Related topics

Example: Block

Demonstrates code creation of blocks.

File

block_example/block_example.module, line 47

Module file for block_example.

Code

function block_example_block_info() {
  // This hook returns an array, each component of which is an array of block
  // information. The array keys are the 'delta' values used in other block
  // hooks.

  // The required block information is a block description, which is shown
  // to the site administrator in the list of possible blocks. You can also
  // provide initial settings for block weight, status, etc.

  // Many options are defined in hook_block_info():
  $blocks['example_configurable_text'] = array(
    // info: The name of the block.
    'info' => t('Example: configurable text string'),
    // Block caching options (per role, per user, etc.) 
    'cache' => DRUPAL_CACHE_PER_ROLE, // default
  );

  // This sample shows how to provide default settings. In this case we'll
  // enable the block in the first sidebar and make it visible only on
  // 'node/*' pages. See the hook_block_info() documentation for these.
  $blocks['example_empty'] = array(
    'info' => t('Example: empty block'), 
    'status' => TRUE, 
    'region' => 'sidebar_first', // Not usually provided. 
    'visibility' => BLOCK_VISIBILITY_LISTED, // Not usually provided. 
    'pages' => 'node/*', // Not usually provided here.
  );

  $blocks['example_uppercase'] = array(
    // info: The name of the block.
    'info' => t('Example: uppercase this please'), 
    'status' => TRUE, 
    'region' => 'sidebar_first', // Not usually provided.
  );

  return $blocks;
}