Views argument handlers

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php \Drupal\views\Plugin\views\argument\views_argument_handlers
  2. 10 core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php \Drupal\views\Plugin\views\argument\views_argument_handlers
  3. 11.x core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php \Drupal\views\Plugin\views\argument\views_argument_handlers

Handler plugins for Views contextual filters.

Handler plugins help build the view query object. Views argument handlers are for contextual filtering.

Views argument handlers extend \Drupal\views\Plugin\views\argument\ArgumentPluginBase. They must be annotated with \Drupal\views\Annotation\ViewsArgument annotation, and they must be in namespace directory Plugin\views\argument.

See also

Plugin API

Parent topics

File

core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php, line 17

Classes

Title Sort descending File name Summary
ArgumentPluginBase core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php Base class for argument (contextual filter) handler plugins.
Broken core/modules/views/src/Plugin/views/argument/Broken.php A special handler to take the place of missing or broken handlers.
Date core/modules/views/src/Plugin/views/argument/Date.php Argument handler for dates.
Date core/modules/datetime/src/Plugin/views/argument/Date.php Abstract argument handler for dates.
Fid core/modules/aggregator/src/Plugin/views/argument/Fid.php Argument handler to accept an aggregator feed id.
Fid core/modules/file/src/Plugin/views/argument/Fid.php Argument handler to accept multiple file ids.
Formula core/modules/views/src/Plugin/views/argument/Formula.php Argument handler for simple formulae.
GroupByNumeric core/modules/views/src/Plugin/views/argument/GroupByNumeric.php Simple handler for arguments using group by.
Iid core/modules/aggregator/src/Plugin/views/argument/Iid.php Argument handler to accept an aggregator item id.
IndexTid core/modules/taxonomy/src/Plugin/views/argument/IndexTid.php Allow taxonomy term ID(s) as argument.
IndexTidDepth core/modules/taxonomy/src/Plugin/views/argument/IndexTidDepth.php Argument handler for taxonomy terms with depth.
IndexTidDepthModifier core/modules/taxonomy/src/Plugin/views/argument/IndexTidDepthModifier.php Argument handler for to modify depth for a previous term.
LanguageArgument core/modules/views/src/Plugin/views/argument/LanguageArgument.php Defines an argument handler to accept a language.
ManyToOne core/modules/views/src/Plugin/views/argument/ManyToOne.php An argument handler for use in fields that have a many to one relationship
with the table(s) to the left. This adds a bunch of options that are
reasonably common with this type of relationship.
Definition terms:
NullArgument core/modules/views/src/Plugin/views/argument/NullArgument.php Argument handler that ignores the argument.
NumberListField core/modules/options/src/Plugin/views/argument/NumberListField.php Argument handler for list field to show the human readable name in the
summary.
NumericArgument core/modules/views/src/Plugin/views/argument/NumericArgument.php Basic argument handler for arguments that are numeric. Incorporates
break_phrase.
RolesRid core/modules/user/src/Plugin/views/argument/RolesRid.php Allow role ID(s) as argument.
Search core/modules/search/src/Plugin/views/argument/Search.php Argument handler for search keywords.
Standard core/modules/views/src/Plugin/views/argument/Standard.php Default implementation of the base argument plugin.
StringArgument core/modules/views/src/Plugin/views/argument/StringArgument.php Basic argument handler to implement string arguments that may have length
limits.
StringListField core/modules/options/src/Plugin/views/argument/StringListField.php Argument handler for list field to show the human readable name in summary.
Taxonomy core/modules/taxonomy/src/Plugin/views/argument/Taxonomy.php Argument handler for basic taxonomy tid.
Uid core/modules/user/src/Plugin/views/argument/Uid.php Argument handler to accept a user id.
UserUid core/modules/comment/src/Plugin/views/argument/UserUid.php Argument handler to accept a user id to check for nodes that
user posted or commented on.
UserUid core/modules/tracker/src/Plugin/views/argument/UserUid.php UID argument to check for nodes that user posted or commented on.
ViewsArgument core/modules/views/src/Annotation/ViewsArgument.php Defines a Plugin annotation object for views argument handlers.
VocabularyVid core/modules/taxonomy/src/Plugin/views/argument/VocabularyVid.php Argument handler to accept a vocabulary id.

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