UserLoginBlock
class UserLoginBlock extends BlockBase implements ContainerFactoryPluginInterface, TrustedCallbackInterface (View source)
Provides a 'User login' block.
Traits
Wrapper methods for the Redirect Destination.
Provides the base implementation of a block plugin.
Provides a trait to add context-aware functionality to plugins.
Handles context assignments for context-aware plugins.
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides a trait for the messenger service.
Provides a trait with typical behavior for plugins which have forms.
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Provides a trait for the messenger service.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
| protected TransliterationInterface | $transliteration | The transliteration service. |
from BlockPluginTrait |
| protected ContextInterface[] | $context | The data objects representing the context of this plugin. |
from ContextAwarePluginTrait |
| protected bool internal | $initializedContextConfig | Tracks whether the context has been initialized from configuration. |
from ContextAwarePluginTrait |
| protected RedirectDestinationInterface | $redirectDestination | The redirect destination service. |
from RedirectDestinationTrait |
| protected RouteMatchInterface | $routeMatch | The route match. |
Methods
Constructs a new UserLoginBlock instance.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
Returns generic default configuration for block plugins.
Wraps the context handler.
Builds a form element for assigning a context to a given slot.
Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
Returns the redirect destination service.
Sets the redirect destination service.
Creates an instance of the plugin.
Builds and returns the renderable array for this block plugin.
lazy_builder callback; renders a form action URL including destination.
Lists the trusted callbacks provided by the implementing class.
Details
__construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match)
Constructs a new UserLoginBlock instance.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
abstract protected
getPluginDefinition()
{@inheritdoc}
bool
isConfigurable()
Determines if the plugin is configurable.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
getFormClass($operation)
Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
hasFormClass($operation)
Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
label()
{@inheritdoc}
getConfiguration()
{@inheritdoc}
setConfiguration(array $configuration)
{@inheritdoc}
protected array
baseConfigurationDefaults()
Returns generic default configuration for block plugins.
defaultConfiguration()
{@inheritdoc}
setConfigurationValue($key, $value)
{@inheritdoc}
calculateDependencies()
{@inheritdoc}
access(AccountInterface $account, $return_as_object = FALSE)
{@inheritdoc}
protected AccessResult
blockAccess(AccountInterface $account)
Indicates whether the block should be shown.
Blocks with specific access checking should override this method rather than access(), in order to avoid repeating the handling of the $return_as_object argument.
buildConfigurationForm(array $form, FormStateInterface $form_state)
{@inheritdoc}
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.
blockForm($form, FormStateInterface $form_state)
{@inheritdoc}
validateConfigurationForm(array $form, FormStateInterface $form_state)
{@inheritdoc}
Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate().
blockValidate($form, FormStateInterface $form_state)
{@inheritdoc}
submitConfigurationForm(array $form, FormStateInterface $form_state)
{@inheritdoc}
Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
blockSubmit($form, FormStateInterface $form_state)
{@inheritdoc}
getMachineNameSuggestion()
{@inheritdoc}
getPreviewFallbackString()
{@inheritdoc}
protected TransliterationInterface
transliteration()
Wraps the transliteration service.
setTransliteration(TransliterationInterface $transliteration)
Sets the transliteration service.
getContexts()
{@inheritdoc}
ContextInterface
getContext($name)
{@inheritdoc}
setContext($name, ContextInterface $context)
{@inheritdoc}
getContextValues()
{@inheritdoc}
getContextValue($name)
{@inheritdoc}
setContextValue($name, $value)
{@inheritdoc}
getContextMapping()
{@inheritdoc}
setContextMapping(array $context_mapping)
{@inheritdoc}
ContextDefinitionInterface[]
getContextDefinitions()
{@inheritdoc}
ContextDefinitionInterface
getContextDefinition($name)
{@inheritdoc}
validateContexts()
{@inheritdoc}
getCacheContexts()
{@inheritdoc}
getCacheTags()
{@inheritdoc}
getCacheMaxAge()
{@inheritdoc}
protected ContextHandlerInterface
contextHandler()
Wraps the context handler.
protected array
addContextAssignmentElement(ContextAwarePluginInterface $plugin, array $contexts)
Builds a form element for assigning a context to a given slot.
protected array
getDestinationArray()
Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
protected RedirectDestinationInterface
getRedirectDestination()
Returns the redirect destination service.
$this
setRedirectDestination(RedirectDestinationInterface $redirect_destination)
Sets the redirect destination service.
static ContainerFactoryPluginInterface
create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition)
Creates an instance of the plugin.
array
build()
Builds and returns the renderable array for this block plugin.
If a block should not be rendered because it has no content, then this method must also ensure to return no content: it must then only return an empty array, or an empty array with #cache set (with cacheability metadata indicating the circumstances for it being empty).
static array
renderPlaceholderFormAction()
lazy_builder callback; renders a form action URL including destination.
static string[]
trustedCallbacks()
Lists the trusted callbacks provided by the implementing class.
Trusted callbacks are public methods on the implementing class and can be invoked via \Drupal\Core\Security\DoTrustedCallbackTrait::doTrustedCallback().