Gets this plugin's configuration.

Sets the configuration for this plugin instance.

Gets default configuration for this plugin.

Calculates dependencies for the configured plugin.

Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and

array_parents, see \Drupal\Core\Render\Element\FormElement.

Form validation handler.

Form submission handler.

Gets the plugin_id of the plugin instance.

Gets the definition of the plugin implementation.

The cache contexts associated with this object.

These identify a specific variation/representation of the object.

Cache contexts are tokens: placeholders that are converted to cache keys by the @cache_contexts_manager service. The replacement value depends on the request context (the current URL, language, and so on). They're converted before storing an object in cache.

The cache tags associated with this object.

When this object is modified, these cache tags will be invalidated.

The maximum age for which this object may be cached.

Gets the base_plugin_id of the plugin instance.

Gets the derivative_id of the plugin instance.

Returns the user-facing block label.

Provide other specific label-related methods in https://www.drupal.org/node/2025649.

Indicates whether the block should be shown.

This method allows base implementations to add general access restrictions that should apply to all extending block plugins.

Builds and returns the renderable array for this block plugin.

If a block should not be rendered because it has no content, then this method must also ensure to return no content: it must then only return an empty array, or an empty array with #cache set (with cacheability metadata indicating the circumstances for it being empty).

Sets a particular value in the block settings.

This doesn't belong here. Move this into a new base class in https://www.drupal.org/node/1764380. This does not set a value in \Drupal::config(), so the name is confusing.

Returns the configuration form elements specific to this block plugin.

Blocks that need to add form elements to the normal block configuration form should implement this method.

Adds block type-specific validation for the block form.

Note that this method takes the form structure and form state for the full block configuration form as arguments, not just the elements defined in BlockPluginInterface::blockForm().

Adds block type-specific submission handling for the block form.

Note that this method takes the form structure and form state for the full block configuration form as arguments, not just the elements defined in BlockPluginInterface::blockForm().

Suggests a machine name to identify an instance of this block.

The block plugin need not verify that the machine name is at all unique. It is only responsible for providing a baseline suggestion; calling code is responsible for ensuring whatever uniqueness is required for the use case.