class UserLoginBlock

Same name in other branches
  1. 8.9.x core/modules/user/src/Plugin/Block/UserLoginBlock.php \Drupal\user\Plugin\Block\UserLoginBlock
  2. 10 core/modules/user/src/Plugin/Block/UserLoginBlock.php \Drupal\user\Plugin\Block\UserLoginBlock
  3. 11.x core/modules/user/src/Plugin/Block/UserLoginBlock.php \Drupal\user\Plugin\Block\UserLoginBlock

Provides a 'User login' block.

Plugin annotation


@Block(
  id = "user_login_block",
  admin_label = @Translation("User login"),
  category = @Translation("Forms")
)

Hierarchy

Expanded class hierarchy of UserLoginBlock

File

core/modules/user/src/Plugin/Block/UserLoginBlock.php, line 26

Namespace

Drupal\user\Plugin\Block
View source
class UserLoginBlock extends BlockBase implements ContainerFactoryPluginInterface, TrustedCallbackInterface {
    use RedirectDestinationTrait;
    
    /**
     * The route match.
     *
     * @var \Drupal\Core\Routing\RouteMatchInterface
     */
    protected $routeMatch;
    
    /**
     * Constructs a new UserLoginBlock instance.
     *
     * @param array $configuration
     *   The plugin configuration, i.e. an array with configuration values keyed
     *   by configuration option name. The special key 'context' may be used to
     *   initialize the defined contexts by setting it to an array of context
     *   values keyed by context names.
     * @param string $plugin_id
     *   The plugin_id for the plugin instance.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   The route match.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->routeMatch = $route_match;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('current_route_match'));
    }
    
    /**
     * {@inheritdoc}
     */
    protected function blockAccess(AccountInterface $account) {
        $route_name = $this->routeMatch
            ->getRouteName();
        if ($account->isAnonymous() && !in_array($route_name, [
            'user.login',
            'user.logout',
        ])) {
            return AccessResult::allowed()->addCacheContexts([
                'route.name',
                'user.roles:anonymous',
            ]);
        }
        return AccessResult::forbidden();
    }
    
    /**
     * {@inheritdoc}
     */
    public function build() {
        $form = \Drupal::formBuilder()->getForm('Drupal\\user\\Form\\UserLoginForm');
        unset($form['name']['#attributes']['autofocus']);
        // When unsetting field descriptions, also unset aria-describedby attributes
        // to avoid introducing an accessibility bug.
        // @todo Do this automatically in https://www.drupal.org/node/2547063.
        unset($form['name']['#description']);
        unset($form['name']['#attributes']['aria-describedby']);
        unset($form['pass']['#description']);
        unset($form['pass']['#attributes']['aria-describedby']);
        $form['name']['#size'] = 15;
        $form['pass']['#size'] = 15;
        // Instead of setting an actual action URL, we set the placeholder, which
        // will be replaced at the very last moment. This ensures forms with
        // dynamically generated action URLs don't have poor cacheability.
        // Use the proper API to generate the placeholder, when we have one. See
        // https://www.drupal.org/node/2562341. The placeholder uses a fixed string
        // that is
        // Crypt::hashBase64('\Drupal\user\Plugin\Block\UserLoginBlock::build');
        // This is based on the implementation in
        // \Drupal\Core\Form\FormBuilder::prepareForm(), but the user login block
        // requires different behavior for the destination query argument.
        $placeholder = 'form_action_p_4r8ITd22yaUvXM6SzwrSe9rnQWe48hz9k1Sxto3pBvE';
        $form['#attached']['placeholders'][$placeholder] = [
            '#lazy_builder' => [
                '\\Drupal\\user\\Plugin\\Block\\UserLoginBlock::renderPlaceholderFormAction',
                [],
            ],
        ];
        $form['#action'] = $placeholder;
        // Build action links.
        $items = [];
        if (\Drupal::config('user.settings')->get('register') != UserInterface::REGISTER_ADMINISTRATORS_ONLY) {
            $items['create_account'] = [
                '#type' => 'link',
                '#title' => $this->t('Create new account'),
                '#url' => Url::fromRoute('user.register', [], [
                    'attributes' => [
                        'title' => $this->t('Create a new user account.'),
                        'class' => [
                            'create-account-link',
                        ],
                    ],
                ]),
            ];
        }
        $items['request_password'] = [
            '#type' => 'link',
            '#title' => $this->t('Reset your password'),
            '#url' => Url::fromRoute('user.pass', [], [
                'attributes' => [
                    'title' => $this->t('Send password reset instructions via email.'),
                    'class' => [
                        'request-password-link',
                    ],
                ],
            ]),
        ];
        return [
            'user_login_form' => $form,
            'user_links' => [
                '#theme' => 'item_list',
                '#items' => $items,
            ],
        ];
    }
    
    /**
     * #lazy_builder callback; renders a form action URL including destination.
     *
     * @return array
     *   A renderable array representing the form action.
     *
     * @see \Drupal\Core\Form\FormBuilder::renderPlaceholderFormAction()
     */
    public static function renderPlaceholderFormAction() {
        return [
            '#type' => 'markup',
            '#markup' => UrlHelper::filterBadProtocol(Url::fromRoute('<current>', [], [
                'query' => \Drupal::destination()->getAsArray(),
                'external' => FALSE,
            ])
                ->toString()),
            '#cache' => [
                'contexts' => [
                    'url.path',
                    'url.query_args',
                ],
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public static function trustedCallbacks() {
        return [
            'renderPlaceholderFormAction',
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
BlockBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$inPreview protected property Whether the plugin is being rendered in preview mode.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockForm public function 17
BlockPluginTrait::blockSubmit public function 13
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual
block plugins can add elements to this form by overriding
BlockBase::blockForm(). Most block plugins should not override this
method unless they need to alter the generic form elements.
Aliased as: traitBuildConfigurationForm
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::defaultConfiguration public function 19
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setInPreview public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission
handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation
for a specific block type, override BlockBase::blockValidate().
1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
PluginWithFormsTrait::getFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.
UserLoginBlock::$routeMatch protected property The route match.
UserLoginBlock::blockAccess protected function Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
UserLoginBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
UserLoginBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
UserLoginBlock::renderPlaceholderFormAction public static function #lazy_builder callback; renders a form action URL including destination.
UserLoginBlock::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks
UserLoginBlock::__construct public function Constructs a new UserLoginBlock instance. Overrides BlockPluginTrait::__construct

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