class TestContextAwareBlock

Provides a context-aware block.

Plugin annotation

@Block(
  id = "test_context_aware",
  admin_label = @Translation("Test context-aware block"),
  context_definitions = {
    "user" = @ContextDefinition("entity:user", required = FALSE,
      label = @Translation("User Context"), constraints = { "NotNull" = {} }
    ),
  }
)

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_test\Plugin\Block\TestContextAwareBlock extends \Drupal\Core\Block\BlockBase

Expanded class hierarchy of TestContextAwareBlock

File

core/modules/block/tests/modules/block_test/src/Plugin/Block/TestContextAwareBlock.php, line 22

Namespace

class TestContextAwareBlock extends BlockBase {
    
    /**
     * {@inheritdoc}
     */
    public function build() {
        
        /** @var \Drupal\user\UserInterface $user */
        $user = $this->getContextValue('user');
        return [
            '#prefix' => '<div id="' . $this->getPluginId() . '--username">',
            '#suffix' => '</div>',
            '#markup' => $user ? $user->getAccountName() : 'No context mapping selected.',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function blockAccess(AccountInterface $account) {
        if ($this->getContextValue('user') instanceof UserInterface) {
            $this->messenger()
                ->addStatus('User context found.');
        }
        return parent::blockAccess($account);
    }

}

Members