Commit 36db800e authored by Aaron Wells's avatar Aaron Wells

Documenting all local/lib.php methods

Bug 1314012

Change-Id: I5e19266e8379fa1244cafafa147e20b7a23a0895
parent f91fbf0a
......@@ -5,9 +5,41 @@
* For simple customisation of a Mahara site, the core code will call some local_* functions
* which may be defined in this file.
*
* Functions that will be called by core:
* - local_main_nav_update($menu): modify the main navigation menu in the header
* - local_xmlrpc_services(): add custom xmlrpc functions
* Functions that will be called by core if they are defined:
*
* - local_can_remove_viewtype($viewtype): stop users from deleting views of a particular type
* - local_progressbar_sortorder($options): Change the order of items in the profile completion progress bar
*
* - local_get_allowed_blocktypes($category, $view): Limit which blocktypes are allowed on a view
*
* - local_get_allowed_blocktype_categories($view): Limit which blocktype categories are allowed
* on a view
*
* - local_header_top_content(): Returned data is printed at top of <head>
*
* - local_init_user(): Called after $USER is initialized on each page load. This is useful for
* changing the user's theme before $THEME is initialized.
*
* - local_main_nav_update(&$menu): Modify the main navigation menu by reference
*
* - local_logout(): Hook function called during the user logout process immediately before
* $USER->logout()
*
* - local_post_register($registration): Called after a user has successfully been created and
* logged in during registration. This is useful when the properties of the user (which may have
* been saved to usr_registration.extra [see local_register_submit()]) need to be transferred
* to the newly registered user.
*
* - local_progressbar_sortorder($options): Change the order of items in the profile completion
* progress bar
*
* - local_register_submit(&$values): Called when registration is submitted, but before the values
* are saved to usr_registration. This is useful for remembering the properties or preferences of
* the logged-out user when the form was submitted. If a $value['extra'] field is added, it will
* be stored to usr_registration.extra.
*
* - local_right_nav_update(&$menu): Modify the right column navigation menu by reference
*
* - local_site_content_pages(): Add to the list of "static pages" types.
*
* - local_xmlrpc_services(): add custom xmlrpc functions
*/
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment