Same name and namespace in other branches
  1. 8.9.x core/modules/views/views.api.php \views_plugins
  2. 9 core/modules/views/views.api.php \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 Locationsort descending Description
ViewsPluginManager core/modules/views/src/Plugin/ViewsPluginManager.php Plugin type manager for all views plugins.

Interfaces

Name Locationsort descending Description
DependentWithRemovalPluginInterface core/modules/views/src/Plugin/DependentWithRemovalPluginInterface.php Provides an interface for a plugin that has dependencies that can be removed.

Sub-Topics

Name Locationsort descending 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 cache plugins core/modules/views/src/Plugin/views/cache/CachePluginBase.php Plugins to handle Views caches.
Views display plugins core/modules/views/src/Plugin/views/display/DisplayPluginInterface.php Plugins to handle the overall display of views.
Views display extender plugins core/modules/views/src/Plugin/views/display_extender/DisplayExtenderPluginBase.php Plugins that offer additional display options across display types.
Views join handler plugins core/modules/views/src/Plugin/views/join/JoinPluginBase.php Handler plugins for Views table joins.
Views relationship handlers core/modules/views/src/Plugin/views/relationship/RelationshipPluginBase.php Plugins for handling views relationships.
Views sort handler plugins core/modules/views/src/Plugin/views/sort/SortPluginBase.php Plugins that handle sorting for Views.
Views wizard plugins core/modules/views/src/Plugin/views/wizard/WizardPluginBase.php Plugins for Views wizards.