Provides a basic block for testing block instantiation and configuration.
@Plugin(
id = "test_block_instantiation",
admin_label = @Translation("Display message"),
module = "block_test"
)
Expanded class hierarchy of TestBlockInstantiation
class TestBlockInstantiation extends BlockBase {
/**
* {@inheritdoc}
*/
public function settings() {
return array(
'display_message' => 'no message set',
);
}
/**
* {@inheritdoc}
*/
public function access() {
return user_access('access content');
}
/**
* {@inheritdoc}
*/
public function blockForm($form, &$form_state) {
$form['display_message'] = array(
'#type' => 'textfield',
'#title' => t('Display message'),
'#default_value' => $this->configuration['display_message'],
);
return $form;
}
/**
* {@inheritdoc}
*/
public function blockSubmit($form, &$form_state) {
$this->configuration['display_message'] = $form_state['values']['display_message'];
}
/**
* {@inheritdoc}
*/
public function build() {
return array(
'#children' => $this->configuration['display_message'],
);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BlockBase:: |
public | function | Adds block type-specific validation for the block form. | |
BlockBase:: |
public | function |
Implements \Drupal\block\BlockPluginInterface::form(). Overrides BlockPluginInterface:: |
1 |
BlockBase:: |
public | function | Returns the configuration data for the block plugin. | |
BlockBase:: |
public | function | Sets a particular value in the block settings. | |
BlockBase:: |
public | function |
Implements \Drupal\block\BlockPluginInterface::submit(). Overrides BlockPluginInterface:: |
|
BlockBase:: |
public | function |
Implements \Drupal\block\BlockPluginInterface::validate(). Overrides BlockPluginInterface:: |
|
BlockBase:: |
public | function |
Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
1 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
public | function |
Returns the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
TestBlockInstantiation:: |
public | function |
Indicates whether block-specific criteria allow access to the block. Overrides BlockBase:: |
|
TestBlockInstantiation:: |
public | function |
Returns the configuration form elements specific to this block plugin. Overrides BlockBase:: |
|
TestBlockInstantiation:: |
public | function |
Adds block type-specific submission handling for the block form. Overrides BlockBase:: |
|
TestBlockInstantiation:: |
public | function |
Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface:: |
|
TestBlockInstantiation:: |
public | function |
Returns plugin-specific settings for the block. Overrides BlockBase:: |