diff options
author | zotlabs <mike@macgirvin.com> | 2018-12-17 18:45:42 -0800 |
---|---|---|
committer | zotlabs <mike@macgirvin.com> | 2018-12-17 18:45:42 -0800 |
commit | 15ce8bc79b219e10f709796c09c739649a8df53b (patch) | |
tree | edd456a39ad0daf12d6cc4409a99477f4fb38d82 /doc/hook | |
parent | 8d70b919551f6f6462e639f7cfffda9825344e43 (diff) | |
parent | d190b1995b0886b430beb5dac1a1e72582b9ad2b (diff) | |
download | volse-hubzilla-15ce8bc79b219e10f709796c09c739649a8df53b.tar.gz volse-hubzilla-15ce8bc79b219e10f709796c09c739649a8df53b.tar.bz2 volse-hubzilla-15ce8bc79b219e10f709796c09c739649a8df53b.zip |
Merge branch 'dev' of https://framagit.org/hubzilla/core into xdev_merge
Diffstat (limited to 'doc/hook')
-rw-r--r-- | doc/hook/item_custom.bb | 24 | ||||
-rw-r--r-- | doc/hook/item_stored.bb | 18 | ||||
-rw-r--r-- | doc/hook/item_stored_update.bb | 15 |
3 files changed, 57 insertions, 0 deletions
diff --git a/doc/hook/item_custom.bb b/doc/hook/item_custom.bb new file mode 100644 index 000000000..d20c7d76c --- /dev/null +++ b/doc/hook/item_custom.bb @@ -0,0 +1,24 @@ +[h2]item_custom[/h2] + +Allow addons to create and process custom item types. + +Addon authors will need to use iconfig meta data (with sharing on) or some other method +to specify and determine whether the custom item is destined for their addon. + +It is fed an array of ['item' => ${item_array}, 'allow_exec' => {true/false}] + +By default $arr['item']['cancel'] is set to TRUE which will abort storage of the +custom item in the item table unless the addon unsets it or sets it to false. + +[code] + if ($arr['item_type']==ITEM_TYPE_CUSTOM) { + /* Custom items are not stored by default + because they require an addon to process. */ + $d['item']['cancel']=true; + + call_hooks('item_custom',$d); + } + +[/code] + +see: include/items.php diff --git a/doc/hook/item_stored.bb b/doc/hook/item_stored.bb new file mode 100644 index 000000000..8d706cb4e --- /dev/null +++ b/doc/hook/item_stored.bb @@ -0,0 +1,18 @@ +[h2]item_stored[/h2] + +Allow addons to continue processing after an item has been stored in the event +that they need access to the item_id or other data that gets assigned during +the storage process. + +It is fed an array of type item (including terms and iconfig data). + +[code] + /** + * @hooks item_stored + * Called after new item is stored in the database. + * (By this time we have an item_id and other frequently needed info.) + */ + call_hooks('item_stored',$arr); +[/code] + +see: include/items.php diff --git a/doc/hook/item_stored_update.bb b/doc/hook/item_stored_update.bb new file mode 100644 index 000000000..4532a347c --- /dev/null +++ b/doc/hook/item_stored_update.bb @@ -0,0 +1,15 @@ +[h2]item_stored_update[/h2] + +Allow addons to continue processing after an item update has been stored + +It is fed an array of type item (including terms and iconfig data). + +[code] + /** + * @hooks item_stored_update + * Called after updated item is stored in the database. + */ + call_hooks('item_stored_update',$arr); +[/code] + +see: include/items.php |