mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Restrict context data available to PluginTemplateExtensions

Browse Source
This commit is contained in:
Jeremy Stretch
2020-03-26 16:50:55 -04:00
parent e7f7b14214
commit f03cc96050
3 changed files with 32 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/plugins/development.md
View File

@ -325,13 +325,17 @@ Plugins can inject custom content into certain areas of the detail views of appl
* `full_width_page()` - Inject content across the entire bottom of the page
* `buttons()` - Add buttons to the top of the page
Each of these methods must return HTML content suitable for inclusion in the object template. Two instance attributes are available for context:
* `self.obj` - The object being viewed
* `self.context` - The current template context
Additionally, a `render()` method is available for convenience. This method accepts the name of a template to render, and any additional context data you want to pass. Its use is optional, however.
When a PluginTemplateExtension is instantiated, context data is assigned to `self.context`. Available data include:
* `obj` - The object being viewed
* `request` - The current request
* `settings` - Global NetBox settings
* `config` - Plugin-specific configuration parameters
For example, accessing `{{ request.user }}` within a template will return the current user.
Declared subclasses should be gathered into a list or tuple for integration with NetBox. By default, NetBox looks for an iterable named `template_extensions` within a `template_content.py` file. (This can be overridden by setting `template_extensions` to a custom value on the plugin's PluginConfig.) An example is below.
```python