Skip to content
Browse files

Documentation for get_plugin_urls method.

  • Loading branch information...
1 parent 802cccf commit 533e5da3c6d84bc044561233e368d8ceb99e0374 @mitar committed Mar 6, 2011
Showing with 8 additions and 1 deletion.
  1. +8 −1 docs/extending_cms/api_references.rst
View
9 docs/extending_cms/api_references.rst
@@ -25,6 +25,13 @@ cms.plugin_base
Custom form class to be used to edit this plugin.
+ .. method:: get_plugin_urls(instance)
+
+ Returns URL patterns for which the plugin wants to register views for.
+ They are included under Django CMS admin (probably ``/admin/cms/page/``)
+ and further under ``/plugin/<plugin name>/``. Useful if your plugin
+ needs to asynchronously talk to the admin.
+
.. attribute:: model
Is the CMSPlugin model we created earlier. If you don't need a model
@@ -105,4 +112,4 @@ menus.base
:param dict attr: Optional, dictionary of additional information to store on
this node.
:param bool visible: Optional, defaults to ``True``, whether this item is
- visible or not.
+ visible or not.

0 comments on commit 533e5da

Please sign in to comment.
Something went wrong with that request. Please try again.