class ExampleEmptyBlock

Provides a 'Example: empty block' block.

Plugin annotation

@Block(
  id = "example_empty",
  admin_label = @Translation("Example: empty block")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\Core\Block\BlockBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Block\BlockPluginInterface, \Drupal\Core\Plugin\PluginWithFormsInterface, \Drupal\Core\Plugin\PreviewAwarePluginInterface, \Drupal\Core\Render\PreviewFallbackInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Block\BlockPluginTrait, \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait
      • class \Drupal\block_example\Plugin\Block\ExampleEmptyBlock extends \Drupal\Core\Block\BlockBase

Expanded class hierarchy of ExampleEmptyBlock

File

modules/block_example/src/Plugin/Block/ExampleEmptyBlock.php, line 15

Namespace

class ExampleEmptyBlock extends BlockBase {
    
    /**
     * {@inheritdoc}
     *
     * The return value of the build() method is a renderable array. Returning an
     * empty array will result in empty block contents. The front end will not
     * display empty blocks.
     */
    public function build() {
        // We return an empty array on purpose. The block will thus not be rendered
        // on the site. See BlockExampleTest::testBlockExampleBasic().
        return [];
    }

}

Members