Download & Extend

Document views access plugins

Project:Drupal core
Version:8.x-dev
Component:views.module
Category:task
Priority:normal
Assigned:thsutton
Status:active
Issue tags:documentation, Novice, VDC

Issue Summary

Add documentation comments to the views access plugins as described in #1882558: [META] Document all views plugins types.

Comments

#1

Add details to the documentation block for AccessPluginBase.

AttachmentSizeStatusTest resultOperations
document-views-access-base-plugin-1912658-1.patch1.36 KBIgnored: Check issue status.NoneNone

#2

Beside this small thing below, I'm wondering whether it makes sense to provide an example here for the access/get_access_callback methods.

+++ b/core/modules/views/lib/Drupal/views/Plugin/views/access/AccessPluginBase.phpundefined
@@ -21,6 +21,26 @@
+ * To define an access control plugin, extend this base class. The
+ * ViewsPluginManager (used to create views plugins objects) adds annotated
+ * discovery for block plugins. Your access plugin should have an annotation

The middle sentence is confusing, as it is 100% out of context :)

nobody click here