Commit f2c047c6 authored by alexpott's avatar alexpott

Issue #1912658 by joshi.rohit100, thsutton, mikebell_, zealfire, pjonckiere,...

Issue #1912658 by joshi.rohit100, thsutton, mikebell_, zealfire, pjonckiere, dawehner: Document views access plugins
parent 125cda4b
...@@ -29,6 +29,24 @@ ...@@ -29,6 +29,24 @@
/** /**
* The base plugin to handle access control. * The base plugin to handle access control.
*
* Access plugins are responsible for controlling a user's access to the view.
* Views includes plugins for checking user roles and individual permissions.
*
* To define an access control plugin, extend this base class. Your access
* plugin should have an annotation that includes the plugin's metadata, for
* example:
* @Plugin(
* id = "denyall",
* title = @Translation("No Access"),
* help = @Translation("Will not be accessible.")
* )
* The definition should include the following keys:
* - id: The unique identifier of your access plugin.
* - title: The human-readable name for your access plugin.
* - help: A short help message for your plugin.
*
* @see \Drupal\views\Plugin\ViewsPluginManager
*/ */
abstract class AccessPluginBase extends PluginBase { abstract class AccessPluginBase extends PluginBase {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment