class LanguageBlock
Provides a 'Language switcher' block.
Attributes
#[Block(id: "language_block", admin_label: new TranslatableMarkup("Language switcher"), category: new TranslatableMarkup("System"), deriver: LanguageBlockDeriver::class)]
  Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Block\BlockBase 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 extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\language\Plugin\Block\LanguageBlock implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Core\Cache\CacheOptionalInterface extends \Drupal\Core\Block\BlockBase
 
 
 - class \Drupal\Core\Block\BlockBase 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 extends \Drupal\Core\Plugin\PluginBase
 
 - class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
 
Expanded class hierarchy of LanguageBlock
File
- 
              core/
modules/ language/ src/ Plugin/ Block/ LanguageBlock.php, line 22  
Namespace
Drupal\language\Plugin\BlockView source
class LanguageBlock extends BlockBase implements ContainerFactoryPluginInterface, CacheOptionalInterface {
  
  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;
  
  /**
   * The path matcher.
   *
   * @var \Drupal\Core\Path\PathMatcherInterface
   */
  protected $pathMatcher;
  
  /**
   * Constructs a LanguageBlock object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\Core\Path\PathMatcherInterface $path_matcher
   *   The path matcher.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, LanguageManagerInterface $language_manager, PathMatcherInterface $path_matcher) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->languageManager = $language_manager;
    $this->pathMatcher = $path_matcher;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container->get('language_manager'), $container->get('path.matcher'));
  }
  
  /**
   * {@inheritdoc}
   */
  protected function blockAccess(AccountInterface $account) {
    $access = $this->languageManager
      ->isMultilingual() ? AccessResult::allowed() : AccessResult::forbidden();
    return $access->addCacheTags([
      'config:configurable_language_list',
    ]);
  }
  
  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [];
    $type = $this->getDerivativeId();
    $route_match = \Drupal::routeMatch();
    // If there is no route match, for example when creating blocks on 404 pages
    // for logged-in users with big_pipe enabled using the front page instead.
    if ($this->pathMatcher
      ->isFrontPage() || !$route_match->getRouteObject()) {
      // We are skipping the route match on both 404 and front page.
      // Example: If on front page, there is no route match like when creating
      // blocks on 404 pages for logged-in users with big_pipe enabled, use the
      // front page.
      $url = Url::fromRoute('<front>');
    }
    else {
      $url = Url::fromRouteMatch($route_match);
    }
    $links = $this->languageManager
      ->getLanguageSwitchLinks($type, $url);
    // In any render cache items wrapping this block, account for variations
    // by user access to each switcher link, the current path and query
    // arguments, and language negotiation.
    $cache_metadata = BubbleableMetadata::createFromRenderArray($build)->addCacheContexts([
      'url.path',
      'url.query_args',
      'url.site',
      'languages:' . $type,
    ]);
    if (isset($links->links)) {
      $build = [
        '#theme' => 'links__language_block',
        '#links' => $links->links,
        '#attributes' => [
          'class' => [
            "language-switcher-{$links->method_id}",
          ],
        ],
        '#set_active_class' => TRUE,
      ];
      foreach ($links->links as $link) {
        if ($link['url'] instanceof Url) {
          $cache_metadata->addCacheableDependency($link['url']->access(NULL, TRUE));
        }
      }
    }
    $cache_metadata->applyTo($build);
    return $build;
  }
  
  /**
   * {@inheritdoc}
   */
  public function createPlaceholder() : bool {
    return TRUE;
  }
}
Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides | 
|---|---|---|---|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. | ||||
| BlockBase::buildConfigurationForm | public | function | Form constructor. | Overrides PluginFormInterface::buildConfigurationForm | 2 | ||
| BlockBase::submitConfigurationForm | public | function | Form submission handler. | Overrides PluginFormInterface::submitConfigurationForm | |||
| 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 | 14 | ||||
| BlockPluginTrait::blockSubmit | public | function | 10 | ||||
| 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 | 1 | ||||
| BlockPluginTrait::defaultConfiguration | public | function | 16 | ||||
| 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().  | 
                                                                                        Aliased as: traitSubmitConfigurationForm | |||
| 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::getCacheContexts | public | function | 9 | ||||
| ContextAwarePluginTrait::getCacheMaxAge | public | function | 6 | ||||
| ContextAwarePluginTrait::getCacheTags | public | function | 3 | ||||
| ContextAwarePluginTrait::getContext | public | function | |||||
| ContextAwarePluginTrait::getContextDefinition | public | function | |||||
| ContextAwarePluginTrait::getContextDefinitions | public | function | |||||
| ContextAwarePluginTrait::getContextMapping | public | function | 1 | ||||
| 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 | |||||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||||
| DependencySerializationTrait::__sleep | public | function | 2 | ||||
| DependencySerializationTrait::__wakeup | public | function | 2 | ||||
| LanguageBlock::$languageManager | protected | property | The language manager. | ||||
| LanguageBlock::$pathMatcher | protected | property | The path matcher. | ||||
| LanguageBlock::blockAccess | protected | function | Indicates whether the block should be shown. | Overrides BlockPluginTrait::blockAccess | |||
| LanguageBlock::build | public | function | Builds and returns the renderable array for this block plugin. | Overrides BlockPluginInterface::build | |||
| LanguageBlock::create | public static | function | Instantiates a new instance of the implementing class using autowiring. | Overrides PluginBase::create | |||
| LanguageBlock::createPlaceholder | public | function | Overrides BlockPluginTrait::createPlaceholder | ||||
| LanguageBlock::__construct | public | function | Constructs a LanguageBlock object. | Overrides BlockPluginTrait::__construct | |||
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | |||
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | |||
| MessengerTrait::setMessenger | public | function | Sets the messenger. | ||||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |||
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | |||
| PluginBase::$pluginId | protected | property | The plugin ID. | ||||
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | |||||
| PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | |||
| PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | |||
| PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |||
| PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | |||
| PluginWithFormsTrait::getFormClass | public | function | Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass(). | ||||
| PluginWithFormsTrait::hasFormClass | public | function | Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass(). | ||||
| 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. | 1 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.