diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/hook/get_default_export_sections | 10 | ||||
| -rw-r--r-- | doc/hook/identity_basic_export.bb | 9 | ||||
| -rw-r--r-- | doc/hooklist.bb | 3 |
3 files changed, 22 insertions, 0 deletions
diff --git a/doc/hook/get_default_export_sections b/doc/hook/get_default_export_sections new file mode 100644 index 000000000..09b146643 --- /dev/null +++ b/doc/hook/get_default_export_sections @@ -0,0 +1,10 @@ +[h3]get_default_export_sections[/h3] + +The get_default_export_sections call returns the basic functional groups of data to export using channel_export_basic(). + +The hook is passed an array + [ + 'sections' => [ 'channel', 'connections', 'config', 'apps', 'chatrooms', 'events', 'webpages', 'mail', 'wikis' ] + ] + +If you desire the export to contain three months of items, add 'items' to the 'sections' array diff --git a/doc/hook/identity_basic_export.bb b/doc/hook/identity_basic_export.bb index 3f4e88799..71329ba1e 100644 --- a/doc/hook/identity_basic_export.bb +++ b/doc/hook/identity_basic_export.bb @@ -1 +1,10 @@ [h2]identity_basic_export[/h2] + +Called when exporting data for a channel +Passed array contains + + [ + 'channel_id' => channel_id being exported + 'sections' => array of functional export sections which are being exported + 'data' => the export data array which has been generated + ] diff --git a/doc/hooklist.bb b/doc/hooklist.bb index c965b7c44..59d370117 100644 --- a/doc/hooklist.bb +++ b/doc/hooklist.bb @@ -242,6 +242,9 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/get_best_language]get_best_language[/zrl] called when choosing the preferred language for the page +[zrl=[baseurl]/help/hook/get_default_export_sections]get_default_export_sections[/zrl] + Called to get the default list of functional data groups to export in identity_basic_export() + [zrl=[baseurl]/help/hook/get_features]get_features[/zrl] Called when get_features() is called |