class PreviewAwareBlock

Defines a class for a context-aware block.

Plugin annotation

@Block(
  id = "preview_aware_block",
  admin_label = "Preview-aware block",
  category = "Test",
)

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\layout_builder_test\Plugin\Block\PreviewAwareBlock extends \Drupal\Core\Block\BlockBase

Expanded class hierarchy of PreviewAwareBlock

File

core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/Block/PreviewAwareBlock.php, line 16

Namespace

class PreviewAwareBlock extends BlockBase {
    
    /**
     * {@inheritdoc}
     */
    public function build() {
        $markup = $this->t('This block is being rendered normally.');
        if ($this->inPreview) {
            $markup = $this->t('This block is being rendered in preview mode.');
        }
        return [
            '#markup' => $markup,
        ];
    }

}

Members