Add docs on collection_add_media hook.
authorElrond <elrond+mediagoblin.org@samba-tng.org>
Mon, 18 Aug 2014 22:56:37 +0000 (00:56 +0200)
committerElrond <elrond+mediagoblin.org@samba-tng.org>
Mon, 18 Aug 2014 22:56:37 +0000 (00:56 +0200)
docs/source/pluginwriter/hooks.rst

index 5272266c36a4c357a1a8d2bf4dfc05cbd4275d11..4aa062e86171e52c926fefb9f874396f8565a47d 100644 (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.