Views plugins

Overview of views plugins

Views plugins are objects that are used to build and render the view. See individual views plugin topics for more information about the specifics of each plugin type, and the Plugin API topic for more information about plugins in general.

Some Views plugins are known as handlers. Handler plugins help build the view query object: filtering, contextual filtering, sorting, relationships, etc.

@todo Document specific options on the appropriate plugin base classes. @todo Add examples.

See also

\Drupal\views\Plugin\views\PluginBase

\Drupal\views\Plugin\views\HandlerBase

Plugin API

Annotations

Parent topics

Views overview

Overview of the Views module API

File

core/modules/views/views.api.php, line 46

Describes hooks and plugins provided by the Views module.

Classes

Name	Location	Description
HandlerBase	core/modules/views/src/Plugin/views/HandlerBase.php	Base class for Views handler plugins.
PluginBase	core/modules/views/src/Plugin/views/PluginBase.php	Base class for any views plugin types.
ViewsPluginManager	core/modules/views/src/Plugin/ViewsPluginManager.php	Plugin type manager for all views plugins.

Sub-Topics

Name	Location	Description
Views access plugins	core/modules/views/src/Plugin/views/access/AccessPluginBase.php	Plugins to handle access checking for views.
Views area handler plugins	core/modules/views/src/Plugin/views/area/AreaPluginBase.php	Plugins governing areas of views, such as header, footer, and empty text.
Views argument default plugins	core/modules/views/src/Plugin/views/argument_default/ArgumentDefaultPluginBase.php	Plugins for argument defaults in Views.
Views argument handlers	core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php	Handler plugins for Views contextual filters.
Views argument validate plugins	core/modules/views/src/Plugin/views/argument_validator/ArgumentValidatorPluginBase.php	Plugins for validating views contextual filters.
Views cache plugins	core/modules/views/src/Plugin/views/cache/CachePluginBase.php	Plugins to handle Views caches.
Views display extender plugins	core/modules/views/src/Plugin/views/display_extender/DisplayExtenderPluginBase.php	Plugins that offer additional display options across display types.
Views display plugins	core/modules/views/src/Plugin/views/display/DisplayPluginInterface.php	Plugins to handle the overall display of views.
Views field handler plugins	core/modules/views/src/Plugin/views/field/FieldPluginBase.php	Handler plugins for Views fields.
Views filter handler plugins	core/modules/views/src/Plugin/views/filter/FilterPluginBase.php	Plugins that handle views filtering.
Views join handler plugins	core/modules/views/src/Plugin/views/join/JoinPluginBase.php	Handler plugins for Views table joins.
Views pager plugins	core/modules/views/src/Plugin/views/pager/PagerPluginBase.php	Plugins to handle paging in views.
Views query plugins	core/modules/views/src/Plugin/views/query/QueryPluginBase.php	Plugins for views queries.
Views relationship handlers	core/modules/views/src/Plugin/views/relationship/RelationshipPluginBase.php	Plugins for handling views relationships.
Views row plugins	core/modules/views/src/Plugin/views/row/RowPluginBase.php	Plugins that control how Views outputs an individual record.
Views sort handler plugins	core/modules/views/src/Plugin/views/sort/SortPluginBase.php	Plugins that handle sorting for Views.
Views style plugins	core/modules/views/src/Plugin/views/style/StylePluginBase.php	Plugins that control how the collection of results is rendered in a view.
Views wizard plugins	core/modules/views/src/Plugin/views/wizard/WizardPluginBase.php	Plugins for Views wizards.