1. 8.5.x core/modules/taxonomy/src/Plugin/views/argument_validator/TermName.php TermName
  2. 8.5.x core/modules/taxonomy/src/Plugin/views/field/TermName.php TermName
  3. 8.0.x core/modules/taxonomy/src/Plugin/views/argument_validator/TermName.php TermName
  4. 8.0.x core/modules/taxonomy/src/Plugin/views/field/TermName.php TermName
  5. 8.1.x core/modules/taxonomy/src/Plugin/views/field/TermName.php TermName
  6. 8.1.x core/modules/taxonomy/src/Plugin/views/argument_validator/TermName.php TermName
  7. 8.2.x core/modules/taxonomy/src/Plugin/views/field/TermName.php TermName
  8. 8.2.x core/modules/taxonomy/src/Plugin/views/argument_validator/TermName.php TermName
  9. 8.3.x core/modules/taxonomy/src/Plugin/views/argument_validator/TermName.php TermName
  10. 8.3.x core/modules/taxonomy/src/Plugin/views/field/TermName.php TermName
  11. 8.4.x core/modules/taxonomy/src/Plugin/views/argument_validator/TermName.php TermName
  12. 8.4.x core/modules/taxonomy/src/Plugin/views/field/TermName.php TermName
  13. 8.6.x core/modules/taxonomy/src/Plugin/views/field/TermName.php TermName
  14. 8.6.x core/modules/taxonomy/src/Plugin/views/argument_validator/TermName.php TermName

Validates whether a term name is a valid term argument.

Plugin annotation

  id = "taxonomy_term_name",
  title = @Translation("Taxonomy term name"),
  entity_type = "taxonomy_term"


Expanded class hierarchy of TermName


core/modules/taxonomy/src/Plugin/views/argument_validator/TermName.php, line 18


View source
class TermName extends Entity {

   * The taxonomy term storage.
   * @var \Drupal\taxonomy\TermStorageInterface
  protected $termStorage;

   * {@inheritdoc}
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityManagerInterface $entity_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_manager);

    // Not handling exploding term names.
    $this->multipleCapable = FALSE;
    $this->termStorage = $entity_manager

   * {@inheritdoc}
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['transform'] = array(
      'default' => FALSE,
    return $options;

   * {@inheritdoc}
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['transform'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Transform dashes in URL to spaces in term name filter values'),
      '#default_value' => $this->options['transform'],

   * {@inheritdoc}
  public function validateArgument($argument) {
    if ($this->options['transform']) {
      $argument = str_replace('-', ' ', $argument);
    $terms = $this->termStorage
      'name' => $argument,
    if (!$terms) {

      // Returned empty array no terms with the name.
      return FALSE;

    // Not knowing which term will be used if more than one is returned check
    // each one.
    foreach ($terms as $term) {
      if (!$this
        ->validateEntity($term)) {
        return FALSE;
    return TRUE;



Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
ArgumentValidatorPluginBase::$argument protected property The argument handler instance associated with this plugin.
ArgumentValidatorPluginBase::access public function Determines if the administrator has the privileges to use this plugin.
ArgumentValidatorPluginBase::checkAccess protected function Blocks user input when the form is shown but we don´t have access.
ArgumentValidatorPluginBase::processSummaryArguments public function Processes the summary arguments for displaying.
ArgumentValidatorPluginBase::setArgument public function Sets the parent argument this plugin is associated with.
ArgumentValidatorPluginBase::validateOptionsForm public function Provides the default form for validating options. Overrides PluginBase::validateOptionsForm
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Prevents serializing any properties.
DependencySerializationTrait::__wakeup public function
Entity::$entityManager protected property The entity manager.
Entity::$multipleCapable protected property If this validator can handle multiple arguments.
Entity::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
Entity::create public static function Creates an instance of the plugin. Overrides PluginBase::create
Entity::submitOptionsForm public function Provides the default form for submitting options. Overrides ArgumentValidatorPluginBase::submitOptionsForm
Entity::validateEntity protected function Validates an individual entity against class access settings.
PluginBase::$configuration protected property Configuration information passed into the plugin.
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form.
PluginBase::$view public property The top object of a view.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer.
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::init public function Initialize the plugin. Overrides ViewsPluginInterface::init
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::query public function Add anything to the query that we might need to. Overrides ViewsPluginInterface::query
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions
PluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TermName::$termStorage protected property The taxonomy term storage.
TermName::buildOptionsForm public function Provides the default form for setting options. Overrides Entity::buildOptionsForm
TermName::defineOptions protected function Retrieves the options when this is a new access control plugin. Overrides Entity::defineOptions
TermName::validateArgument public function Performs validation for a given argument. Overrides Entity::validateArgument
TermName::__construct public function Constructs an \Drupal\views\Plugin\views\argument_validator\Entity object. Overrides Entity::__construct