TestBlockInstantiation.php

Same filename and directory in other branches
  1. 8.9.x core/modules/block/tests/modules/block_test/src/Plugin/Block/TestBlockInstantiation.php
  2. 10 core/modules/block/tests/modules/block_test/src/Plugin/Block/TestBlockInstantiation.php
  3. 11.x core/modules/block/tests/modules/block_test/src/Plugin/Block/TestBlockInstantiation.php

Namespace

Drupal\block_test\Plugin\Block

File

core/modules/block/tests/modules/block_test/src/Plugin/Block/TestBlockInstantiation.php

View source
<?php

namespace Drupal\block_test\Plugin\Block;

use Drupal\Core\Access\AccessResult;
use Drupal\Core\Block\BlockBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Session\AccountInterface;

/**
 * Provides a basic block for testing block instantiation and configuration.
 *
 * @Block(
 *   id = "test_block_instantiation",
 *   admin_label = @Translation("Display message")
 * )
 */
class TestBlockInstantiation extends BlockBase {
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        return [
            'display_message' => 'no message set',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function blockAccess(AccountInterface $account) {
        return AccessResult::allowedIfHasPermission($account, 'access content');
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockForm($form, FormStateInterface $form_state) {
        $form['display_message'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Display message'),
            '#default_value' => $this->configuration['display_message'],
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockSubmit($form, FormStateInterface $form_state) {
        $this->configuration['display_message'] = $form_state->getValue('display_message');
    }
    
    /**
     * {@inheritdoc}
     */
    public function build() {
        return [
            '#children' => $this->configuration['display_message'],
        ];
    }

}

Classes

Title Deprecated Summary
TestBlockInstantiation Provides a basic block for testing block instantiation and configuration.

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