Document new theme_update() function

This commit is contained in:
Starbeamrainbowlabs 2019-09-01 21:20:10 +01:00
parent e708220bc6
commit e570427469
Signed by: sbrl
GPG Key ID: 1BE5172E637709C2
1 changed files with 5 additions and 0 deletions

View File

@ -108,6 +108,11 @@ register_module([
}
]);
/**
* Updates the currently selected theme by fetching it from a remote url.
* @param bool $force_update Whether to force an update - even if we've already updated recently.
* @return bool Whether the update was sucessful. It might fail because of network issues, or the theme update requires a newer version of Pepperminty Wiki than is currently installed.
*/
function theme_update($force_update = false) : bool {
global $version, $settings;