1 layout.api.php | hook_block_configure($delta = '', $settings = array()) |
Define a configuration form for a block.
@since 1.0.6 $settings parameter added.
Parameters
string $delta: Which block is being configured. This is a unique identifier for the block within the module, defined in hook_block_info().
array $settings: An array of settings for this block.
Return value
array: A configuration form, if one is needed for your block beyond the standard elements that the block module provides (block title, visibility, etc.).
For a detailed usage example, see block_example.module.
See also
Related topics
File
- core/
modules/ layout/ layout.api.php, line 583 - Describe hooks provided by the Layout module.
Code
function hook_block_configure($delta = '', $settings = array()) {
// This example comes from node.module.
$form = array();
if ($delta == 'recent') {
$settings += array(
'node_count' => 10,
);
$form['node_count'] = array(
'#type' => 'select',
'#title' => t('Number of recent content items to display'),
'#default_value' => $settings['node_count'],
'#options' => range(2, 30),
);
}
return $form;
}