Views plugins in Drupal 9
Same name and namespace in other branches
- 8 core/modules/views/views.api.php \views_plugins
- 10 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
Parent topics
File
- core/
modules/ views/ views.api.php, line 46 - Describes hooks and plugins provided by the Views module.
Classes
Name |
Location | Description |
|---|---|---|
| HandlerBase |
core/ |
Base class for Views handler plugins. |
| PluginBase |
core/ |
Base class for any views plugin types. |
| ViewsPluginManager |
core/ |
Plugin type manager for all views plugins. |
Interfaces
|
Name |
Location | Description |
|---|---|---|
| DependentWithRemovalPluginInterface |
core/ |
Provides an interface for a plugin that has dependencies that can be removed. |
Sub-Topics
|
Name |
Location | Description |
|---|---|---|
| Views access plugins |
core/ |
Plugins to handle access checking for views. |
| Views area handler plugins |
core/ |
Plugins governing areas of views, such as header, footer, and empty text. |
| Views argument default plugins |
core/ |
Plugins for argument defaults in Views. |
| Views argument handlers |
core/ |
Handler plugins for Views contextual filters. |
| Views argument validate plugins |
core/ |
Plugins for validating views contextual filters. |
| Views cache plugins |
core/ |
Plugins to handle Views caches. |
| Views display extender plugins |
core/ |
Plugins that offer additional display options across display types. |
| Views display plugins |
core/ |
Plugins to handle the overall display of views. |
| Views field handler plugins |
core/ |
Handler plugins for Views fields. |
| Views filter handler plugins |
core/ |
Plugins that handle views filtering. |
| Views join handler plugins |
core/ |
Handler plugins for Views table joins. |
| Views pager plugins |
core/ |
Plugins to handle paging in views. |
| Views query plugins |
core/ |
Plugins for views queries. |
| Views relationship handlers |
core/ |
Plugins for handling views relationships. |
| Views row plugins |
core/ |
Plugins that control how Views outputs an individual record. |
| Views sort handler plugins |
core/ |
Plugins that handle sorting for Views. |
| Views style plugins |
core/ |
Plugins that control how the collection of results is rendered in a view. |
| Views wizard plugins |
core/ |
Plugins for Views wizards. |