function BlockPluginInterface::getMachineNameSuggestion

Same name in other branches
  1. 9 core/lib/Drupal/Core/Block/BlockPluginInterface.php \Drupal\Core\Block\BlockPluginInterface::getMachineNameSuggestion()
  2. 8.9.x core/lib/Drupal/Core/Block/BlockPluginInterface.php \Drupal\Core\Block\BlockPluginInterface::getMachineNameSuggestion()
  3. 10 core/lib/Drupal/Core/Block/BlockPluginInterface.php \Drupal\Core\Block\BlockPluginInterface::getMachineNameSuggestion()

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.

Return value

string The suggested machine name.

File

core/lib/Drupal/Core/Block/BlockPluginInterface.php, line 155

Class

BlockPluginInterface
Defines the required interface for all block plugins.

Namespace

Drupal\Core\Block

Code

public function getMachineNameSuggestion();

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.