heckyel/mediagoblin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add docs on collection_add_media hook.

Browse Source
This commit is contained in:
Elrond 2014-08-19 00:56:37 +02:00
parent 7610eb231e
commit 3322a63df4
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/source/pluginwriter/hooks.rst
View File

@ -17,3 +17,19 @@ Documentation on Built-in Hooks
===============================
This section explains built-in hooks to MediaGoblin.
What hooks are available?
=========================
'collection_add_media'
----------------------
This hook is used by ``add_media_to_collection``
in ``mediagoblin.user_pages.lib``.
It gets a ``CollectionItem`` as its argument.
It's the newly created item just before getting commited.
So the item can be modified by the hook, if needed.
Changing the session regarding this item is currently
undefined behaviour, as the SQL Session might contain other
things.