Views area handler plugins

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/area/AreaPluginBase.php \Drupal\views\Plugin\views\area\views_area_handlers
  2. 8.9.x core/modules/views/src/Plugin/views/area/AreaPluginBase.php \Drupal\views\Plugin\views\area\views_area_handlers
  3. 10 core/modules/views/src/Plugin/views/area/AreaPluginBase.php \Drupal\views\Plugin\views\area\views_area_handlers

Plugins governing areas of views, such as header, footer, and empty text.

Area handler plugins extend \Drupal\views\Plugin\views\area\AreaPluginBase. They must be attributed with \Drupal\views\Attribute\ViewsArea attribute, and they must be in namespace directory Plugin\views\area.

See also

Plugin API

Parent topics

Views plugins
Overview of views plugins

File

core/modules/views/src/Plugin/views/area/AreaPluginBase.php, line 10

Classes

Title File name Summary
AreaPluginBase core/modules/views/src/Plugin/views/area/AreaPluginBase.php Base class for area handler plugins.
Broken core/modules/views/src/Plugin/views/area/Broken.php A special handler to take the place of missing or broken handlers.
DisplayLink core/modules/views/src/Plugin/views/area/DisplayLink.php Views area display_link handler.
Entity core/modules/views/src/Plugin/views/area/Entity.php Provides an area handler which renders an entity in a certain view mode.
HTTPStatusCode core/modules/views/src/Plugin/views/area/HTTPStatusCode.php Alter the HTTP response status code used by the view.
ListingEmpty core/modules/node/src/Plugin/views/area/ListingEmpty.php Defines an area plugin to display a node/add link.
ListingEmpty core/modules/block_content/src/Plugin/views/area/ListingEmpty.php Defines an area plugin to display a block add link.
Messages core/modules/views/src/Plugin/views/area/Messages.php Provides an area for messages.
Result core/modules/views/src/Plugin/views/area/Result.php Views area handler to display some configurable result summary.
Text core/modules/views/src/Plugin/views/area/Text.php Views area text handler.
TextCustom core/modules/views/src/Plugin/views/area/TextCustom.php Views area text handler.
Title core/modules/views/src/Plugin/views/area/Title.php Views area title override handler.
TokenizeAreaPluginBase core/modules/views/src/Plugin/views/area/TokenizeAreaPluginBase.php Tokenized base class for area handlers.
View core/modules/views/src/Plugin/views/area/View.php Views area handlers. Insert a view inside of an area.
ViewsArea core/modules/views/src/Attribute/ViewsArea.php Defines a Plugin attribute object for views area handlers.
ViewsArea core/modules/views/src/Annotation/ViewsArea.php Defines a Plugin annotation object for views area handlers.

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