Local plugins - Revision history

Devdocsbot: Protected "Local plugins": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-05-06T07:27:04Z

Protected "Local plugins": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 07:27, 6 May 2022
(No difference)

Devdocsbot: Update migration status and path

2022-04-28T07:01:07Z

Update migration status and path

← Older revision		Revision as of 07:01, 28 April 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/plugintypes/local}}
	{{Infobox Project		{{Infobox Project
	\|name = Local customisations		\|name = Local customisations

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:30:28Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:30, 14 July 2021
				
Line 47:
Line 47:
== /local/xxx/db/messages.php == == /local/xxx/db/messages.php ==
Example File Structure: Example File Structure:
<code php> <syntaxhighlight lang="php">
<?php <?php



Line 80:
Line 80:



Sample /local/defaults.php file content: Sample /local/defaults.php file content:
<code php> <syntaxhighlight lang="php">
<?php <?php
$defaults['moodle']['forcelogin'] = 1;  // new default for $CFG->forcelogin $defaults['moodle']['forcelogin'] = 1;  // new default for $CFG->forcelogin
Line 119:
Line 119:



Sample code in config.php Sample code in config.php
<code php> <syntaxhighlight lang="php">
$CFG->allowobjectembed = 0; $CFG->allowobjectembed = 0;
$CFG->forced_plugin_settings = array('page'=>array('displayoptions'=>5, 'requiremodintro'=>1), 'folder'=>array('requiremodintro'=>1)); $CFG->forced_plugin_settings = array('page'=>array('displayoptions'=>5, 'requiremodintro'=>1), 'folder'=>array('requiremodintro'=>1));
Line 131:
Line 131:
following file with content changes string "Login" to "Sign in": following file with content changes string "Login" to "Sign in":
moodledata/lang/en_local moodledata/lang/en_local
<code php> <syntaxhighlight lang="php">
<?php <?php
   $string['login'] = 'Sign in';    $string['login'] = 'Sign in';
Line 163:
Line 163:
In local/*pluginname*/lib.php, define a function named local_*pluginname*_extend_settings_navigation, this will get called when Moodle builds the settings block. In local/*pluginname*/lib.php, define a function named local_*pluginname*_extend_settings_navigation, this will get called when Moodle builds the settings block.
This example adds a link to the bottom of the course administration section of the settings block. This example adds a link to the bottom of the course administration section of the settings block.
<code php> <syntaxhighlight lang="php">
function local_myplugin_extend_settings_navigation($settingsnav, $context) { function local_myplugin_extend_settings_navigation($settingsnav, $context) {
     global $CFG, $PAGE;      global $CFG, $PAGE;
Line 197:
Line 197:



=== Removing the "Site Home" link from the navigation menu === === Removing the "Site Home" link from the navigation menu ===
<code php> <syntaxhighlight lang="php">
function local_xxx_extend_navigation(global_navigation $navigation) { function local_xxx_extend_navigation(global_navigation $navigation) {
     if ($home = $navigation->find('home', global_navigation::TYPE_SETTING)) {      if ($home = $navigation->find('home', global_navigation::TYPE_SETTING)) {
Line 209:
Line 209:
If you need to add site wide settings for your local plugin, perhaps connection details for an API, you will need to do something similar to the below in your settings file (local/yourplugin/settings.php) If you need to add site wide settings for your local plugin, perhaps connection details for an API, you will need to do something similar to the below in your settings file (local/yourplugin/settings.php)



<code php> <syntaxhighlight lang="php">
// Ensure the configurations for this site are set // Ensure the configurations for this site are set
if ( $hassiteconfig ){ if ( $hassiteconfig ){



Mudrd8mz: Text replacement - "" to ""

2021-07-14T13:07:15Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:07, 14 July 2021
				
Line 39:
Line 39:



=== List of differences from normal plugins: === === List of differences from normal plugins: ===
* always executed last during install/upgrade - guaranteed by order of plugins in <code>get_plugin_types()</syntaxhighlight> * always executed last during install/upgrade - guaranteed by order of plugins in <syntaxhighlight lang="php">get_plugin_types()</syntaxhighlight>
* are expected to use event handlers - events are intended for communication core-->plugins only, local plugins are the best candidates for event handlers * are expected to use event handlers - events are intended for communication core-->plugins only, local plugins are the best candidates for event handlers
* can add admin settings to any settings page - loaded last when constructing admin tree * can add admin settings to any settings page - loaded last when constructing admin tree
Line 255:
Line 255:



=== Migration from old 1.9.x /local/: === === Migration from old 1.9.x /local/: ===
* <code>local/*</syntaxhighlight> needs to be copied to new directory * <syntaxhighlight lang="php">local/*</syntaxhighlight> needs to be copied to new directory
* <code>local/xxxx/db/install.php</syntaxhighlight> is intended for first installation, originally everything was in upgrade.php * <syntaxhighlight lang="php">local/xxxx/db/install.php</syntaxhighlight> is intended for first installation, originally everything was in upgrade.php
* events are used instead of hooks * events are used instead of hooks
* upgrade code needs to migrate old settings, events, etc. directly in core db tables - such as change component strings and capability names from db/install.php or manually before/after upgrade * upgrade code needs to migrate old settings, events, etc. directly in core db tables - such as change component strings and capability names from db/install.php or manually before/after upgrade



Mudrd8mz: Text replacement - "" to ""
2021-07-14T13:06:58Z
Text replacement - "</code>" to "</syntaxhighlight>"

				
				
				
				
				
				← Older revision
				Revision as of 13:06, 14 July 2021
				
Line 39:
Line 39:



=== List of differences from normal plugins: === === List of differences from normal plugins: ===
* always executed last during install/upgrade - guaranteed by order of plugins in <code>get_plugin_types()</code> * always executed last during install/upgrade - guaranteed by order of plugins in <code>get_plugin_types()</syntaxhighlight>
* are expected to use event handlers - events are intended for communication core-->plugins only, local plugins are the best candidates for event handlers * are expected to use event handlers - events are intended for communication core-->plugins only, local plugins are the best candidates for event handlers
* can add admin settings to any settings page - loaded last when constructing admin tree * can add admin settings to any settings page - loaded last when constructing admin tree
Line 65:
Line 65:



); );
</code> </syntaxhighlight>



== Other /local/ customisation files==   == Other /local/ customisation files==  
Line 86:
Line 86:
$defaults['moodlecourse']['numsections'] = 11; $defaults['moodlecourse']['numsections'] = 11;
$defaults['moodle']['hiddenuserfields'] = array('city', 'country'); $defaults['moodle']['hiddenuserfields'] = array('city', 'country');
</code> </syntaxhighlight>
First bracket contains string from column plugin of config_plugins table. First bracket contains string from column plugin of config_plugins table.
Second bracket is the name of setting. In the admin settings UI the plugin and Second bracket is the name of setting. In the admin settings UI the plugin and
Line 122:
Line 122:
$CFG->allowobjectembed = 0; $CFG->allowobjectembed = 0;
$CFG->forced_plugin_settings = array('page'=>array('displayoptions'=>5, 'requiremodintro'=>1), 'folder'=>array('requiremodintro'=>1)); $CFG->forced_plugin_settings = array('page'=>array('displayoptions'=>5, 'requiremodintro'=>1), 'folder'=>array('requiremodintro'=>1));
</code> </syntaxhighlight>



=== Local language customisations===   === Local language customisations===  
Line 134:
Line 134:
<?php <?php
   $string['login'] = 'Sign in';    $string['login'] = 'Sign in';
</code> </syntaxhighlight>
See also https://docs.moodle.org/en/Language_editing See also https://docs.moodle.org/en/Language_editing



Line 194:
Line 194:
     }      }
} }
</code> </syntaxhighlight>



=== Removing the "Site Home" link from the navigation menu === === Removing the "Site Home" link from the navigation menu ===
Line 203:
Line 203:
     }      }
} }
</code> </syntaxhighlight>



=== Adding Site Wide Settings For Your Local Plugin === === Adding Site Wide Settings For Your Local Plugin ===
Line 242:
Line 242:



} }
</code> </syntaxhighlight>



== Local customisations in previous versions == == Local customisations in previous versions ==
Line 255:
Line 255:



=== Migration from old 1.9.x /local/: === === Migration from old 1.9.x /local/: ===
* <code>local/*</code> needs to be copied to new directory * <code>local/*</syntaxhighlight> needs to be copied to new directory
* <code>local/xxxx/db/install.php</code> is intended for first installation, originally everything was in upgrade.php * <code>local/xxxx/db/install.php</syntaxhighlight> is intended for first installation, originally everything was in upgrade.php
* events are used instead of hooks * events are used instead of hooks
* upgrade code needs to migrate old settings, events, etc. directly in core db tables - such as change component strings and capability names from db/install.php or manually before/after upgrade * upgrade code needs to migrate old settings, events, etc. directly in core db tables - such as change component strings and capability names from db/install.php or manually before/after upgrade



Mhughes2k: CVS server no longer online
2020-05-20T11:19:43Z
CVS server no longer online

				
				
				
				
				
				← Older revision
				Revision as of 11:19, 20 May 2020
				
Line 264:
Line 264:
* [http://moodle.org/mod/forum/discuss.php?d=170325&parent=753095 Extending navigation block] * [http://moodle.org/mod/forum/discuss.php?d=170325&parent=753095 Extending navigation block]
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=86903 Local Customisations] forum discussion * Using Moodle [http://moodle.org/mod/forum/discuss.php?d=86903 Local Customisations] forum discussion
* http://cvs.moodle.org/moodle/local/readme.txt?view=markup 
* [[Local customisation (Moodle 1.9)]] * [[Local customisation (Moodle 1.9)]]



[[Category:Plugins]] [[Category:Plugins]]



Noeldemartin: /* Standard plugin features: */
2020-02-10T10:25:29Z
Standard plugin features:

				
				
				
				
				
				← Older revision
				Revision as of 10:25, 10 February 2020
				
Line 33:
Line 33:
* /local/xxx/cron.php - cron job, run at the interval defined in version.php. Alternatively, you can define <tt>local_xxx_cron()</tt> in lib.php. Between those two methods, the lib.php one is preferred. But both of them are considered legacy and have been deprecated for Moodle 3.5 (MDL-52846) and will be deleted for Moodle 3.9 (MDL-61165). [[https://docs.moodle.org/dev/Task_API#Legacy_cron More info here]]. They are being replaced with the [[Task_API]]. * /local/xxx/cron.php - cron job, run at the interval defined in version.php. Alternatively, you can define <tt>local_xxx_cron()</tt> in lib.php. Between those two methods, the lib.php one is preferred. But both of them are considered legacy and have been deprecated for Moodle 3.5 (MDL-52846) and will be deleted for Moodle 3.9 (MDL-61165). [[https://docs.moodle.org/dev/Task_API#Legacy_cron More info here]]. They are being replaced with the [[Task_API]].
* /local/xxx/lang/en/local_pluginname.php - language file * /local/xxx/lang/en/local_pluginname.php - language file
* /local/xxx/lib.php - function library, automatically included with by config.php.  Hook functions local_pluginname_extend_navigation() and local_pluginname_extend_settings_navigation() can be used to add items to the navigation and settings blocks * /local/xxx/lib.php - function library, automatically included with by config.php.  Hook functions <tt>local_xxx_extend_navigation()</tt> and <tt>local_xxx_extend_settings_navigation()</tt> can be used to add items to the navigation and settings blocks
* /local/xxx/settings.php - configuration options. These get added to the admin menu. * /local/xxx/settings.php - configuration options. These get added to the admin menu.






Monidu: fix to conform ro https://docs.moodle.org/dev/Plugin_contribution_checklist#Settings_storage
2019-06-07T11:46:57Z
fix to conform ro https://docs.moodle.org/dev/Plugin_contribution_checklist#Settings_storage

				
				
				
				
				
				← Older revision
				Revision as of 11:46, 7 June 2019
				
Line 225:
Line 225:
		 		
		// This is the reference you will use to your configuration 		// This is the reference you will use to your configuration
		'yourplugin_apikey', 		'local_yourplugin/apikey',
	 	
		// This is the friendly title for the config, which will be displayed 		// This is the friendly title for the config, which will be displayed



Henriquefm at 00:24, 18 August 2018
2018-08-18T00:24:12Z


				
				
				
				
				
				← Older revision
				Revision as of 00:24, 18 August 2018
				
Line 31:
Line 31:
* /local/xxx/db/messages.php - messaging registration * /local/xxx/db/messages.php - messaging registration
* /local/xxx/db/external.php - web services and external functions descriptions * /local/xxx/db/external.php - web services and external functions descriptions
* /local/xxx/cron.php - cron job, run at the interval defined in version.php. Alternatively, you can define <tt>local_xxx_cron()</tt> in lib.php. (The lib.php method is now preferred.) * /local/xxx/cron.php - cron job, run at the interval defined in version.php. Alternatively, you can define <tt>local_xxx_cron()</tt> in lib.php. Between those two methods, the lib.php one is preferred. But both of them are considered legacy and have been deprecated for Moodle 3.5 (MDL-52846) and will be deleted for Moodle 3.9 (MDL-61165). [[https://docs.moodle.org/dev/Task_API#Legacy_cron More info here]]. They are being replaced with the [[Task_API]].
* /local/xxx/lang/en/local_pluginname.php - language file * /local/xxx/lang/en/local_pluginname.php - language file
* /local/xxx/lib.php - function library, automatically included with by config.php.  Hook functions local_pluginname_extend_navigation() and local_pluginname_extend_settings_navigation() can be used to add items to the navigation and settings blocks * /local/xxx/lib.php - function library, automatically included with by config.php.  Hook functions local_pluginname_extend_navigation() and local_pluginname_extend_settings_navigation() can be used to add items to the navigation and settings blocks



Mattjohnsonuk: Added an example of how to use site wide settings for local plugins
2016-07-05T11:23:15Z
Added an example of how to use site wide settings for local plugins

				
				
				
				
				
				← Older revision
				Revision as of 11:23, 5 July 2016
				
Line 202:
Line 202:
         $home->remove();          $home->remove();
     }      }
}
</code>

=== Adding Site Wide Settings For Your Local Plugin ===

If you need to add site wide settings for your local plugin, perhaps connection details for an API, you will need to do something similar to the below in your settings file (local/yourplugin/settings.php)

<code php>
// Ensure the configurations for this site are set
if ( $hassiteconfig ){

	// Create the new settings page
	// - in a local plugin this is not defined as standard, so normal $settings->methods will throw an error as
	// $settings will be NULL
	$settings = new admin_settingpage( 'local_yourplugin', 'Your Settings Page Title' );

	// Create 
	$ADMIN->add( 'localplugins', $settings );

	// Add a setting field to the settings for this page
	$settings->add( new admin_setting_configtext(
		
		// This is the reference you will use to your configuration
		'yourplugin_apikey',
	
		// This is the friendly title for the config, which will be displayed
		'External API: Key',
	
		// This is helper text for this config field
		'This is the key used to access the External API',
	
		// This is the default value
		'No Key Defined',
	
		// This is the type of Parameter this config is
		PARAM_TEXT
	
	) );

} }
</code> </code>

← Older revision		Revision as of 13:30, 14 July 2021
Line 47:		Line 47:
	== /local/xxx/db/messages.php ==		== /local/xxx/db/messages.php ==
	Example File Structure:		Example File Structure:
	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php

Line 80:		Line 80:

	Sample /local/defaults.php file content:		Sample /local/defaults.php file content:
	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php
	$defaults['moodle']['forcelogin'] = 1; // new default for $CFG->forcelogin		$defaults['moodle']['forcelogin'] = 1; // new default for $CFG->forcelogin
Line 119:		Line 119:

	Sample code in config.php		Sample code in config.php
	<~~code~~ php>		<syntaxhighlight lang="php">
	$CFG->allowobjectembed = 0;		$CFG->allowobjectembed = 0;
	$CFG->forced_plugin_settings = array('page'=>array('displayoptions'=>5, 'requiremodintro'=>1), 'folder'=>array('requiremodintro'=>1));		$CFG->forced_plugin_settings = array('page'=>array('displayoptions'=>5, 'requiremodintro'=>1), 'folder'=>array('requiremodintro'=>1));
Line 131:		Line 131:
	following file with content changes string "Login" to "Sign in":		following file with content changes string "Login" to "Sign in":
	moodledata/lang/en_local		moodledata/lang/en_local
	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php
	$string['login'] = 'Sign in';		$string['login'] = 'Sign in';
Line 163:		Line 163:
	In local/pluginname/lib.php, define a function named local_pluginname_extend_settings_navigation, this will get called when Moodle builds the settings block.		In local/pluginname/lib.php, define a function named local_pluginname_extend_settings_navigation, this will get called when Moodle builds the settings block.
	This example adds a link to the bottom of the course administration section of the settings block.		This example adds a link to the bottom of the course administration section of the settings block.
	<~~code~~ php>		<syntaxhighlight lang="php">
	function local_myplugin_extend_settings_navigation($settingsnav, $context) {		function local_myplugin_extend_settings_navigation($settingsnav, $context) {
	global $CFG, $PAGE;		global $CFG, $PAGE;
Line 197:		Line 197:

	=== Removing the "Site Home" link from the navigation menu ===		=== Removing the "Site Home" link from the navigation menu ===
	<~~code~~ php>		<syntaxhighlight lang="php">
	function local_xxx_extend_navigation(global_navigation $navigation) {		function local_xxx_extend_navigation(global_navigation $navigation) {
	if ($home = $navigation->find('home', global_navigation::TYPE_SETTING)) {		if ($home = $navigation->find('home', global_navigation::TYPE_SETTING)) {
Line 209:		Line 209:
	If you need to add site wide settings for your local plugin, perhaps connection details for an API, you will need to do something similar to the below in your settings file (local/yourplugin/settings.php)		If you need to add site wide settings for your local plugin, perhaps connection details for an API, you will need to do something similar to the below in your settings file (local/yourplugin/settings.php)

	<~~code~~ php>		<syntaxhighlight lang="php">
	// Ensure the configurations for this site are set		// Ensure the configurations for this site are set
	if ( $hassiteconfig ){		if ( $hassiteconfig ){

← Older revision		Revision as of 13:07, 14 July 2021
Line 39:		Line 39:

	=== List of differences from normal plugins: ===		=== List of differences from normal plugins: ===
	* always executed last during install/upgrade - guaranteed by order of plugins in <~~code~~>get_plugin_types()</syntaxhighlight>		* always executed last during install/upgrade - guaranteed by order of plugins in <syntaxhighlight lang="php">get_plugin_types()</syntaxhighlight>
	* are expected to use event handlers - events are intended for communication core-->plugins only, local plugins are the best candidates for event handlers		* are expected to use event handlers - events are intended for communication core-->plugins only, local plugins are the best candidates for event handlers
	* can add admin settings to any settings page - loaded last when constructing admin tree		* can add admin settings to any settings page - loaded last when constructing admin tree
Line 255:		Line 255:

	=== Migration from old 1.9.x /local/: ===		=== Migration from old 1.9.x /local/: ===
	* <~~code~~>local/*</syntaxhighlight> needs to be copied to new directory		* <syntaxhighlight lang="php">local/*</syntaxhighlight> needs to be copied to new directory
	* <~~code~~>local/xxxx/db/install.php</syntaxhighlight> is intended for first installation, originally everything was in upgrade.php		* <syntaxhighlight lang="php">local/xxxx/db/install.php</syntaxhighlight> is intended for first installation, originally everything was in upgrade.php
	* events are used instead of hooks		* events are used instead of hooks
	* upgrade code needs to migrate old settings, events, etc. directly in core db tables - such as change component strings and capability names from db/install.php or manually before/after upgrade		* upgrade code needs to migrate old settings, events, etc. directly in core db tables - such as change component strings and capability names from db/install.php or manually before/after upgrade

← Older revision		Revision as of 13:06, 14 July 2021
Line 39:		Line 39:

	=== List of differences from normal plugins: ===		=== List of differences from normal plugins: ===
	* always executed last during install/upgrade - guaranteed by order of plugins in <code>get_plugin_types()</~~code~~>		* always executed last during install/upgrade - guaranteed by order of plugins in <code>get_plugin_types()</syntaxhighlight>
	* are expected to use event handlers - events are intended for communication core-->plugins only, local plugins are the best candidates for event handlers		* are expected to use event handlers - events are intended for communication core-->plugins only, local plugins are the best candidates for event handlers
	* can add admin settings to any settings page - loaded last when constructing admin tree		* can add admin settings to any settings page - loaded last when constructing admin tree
Line 65:		Line 65:

	);		);
	</~~code~~>		</syntaxhighlight>

	== Other /local/ customisation files==		== Other /local/ customisation files==
Line 86:		Line 86:
	$defaults['moodlecourse']['numsections'] = 11;		$defaults['moodlecourse']['numsections'] = 11;
	$defaults['moodle']['hiddenuserfields'] = array('city', 'country');		$defaults['moodle']['hiddenuserfields'] = array('city', 'country');
	</~~code~~>		</syntaxhighlight>
	First bracket contains string from column plugin of config_plugins table.		First bracket contains string from column plugin of config_plugins table.
	Second bracket is the name of setting. In the admin settings UI the plugin and		Second bracket is the name of setting. In the admin settings UI the plugin and
Line 122:		Line 122:
	$CFG->allowobjectembed = 0;		$CFG->allowobjectembed = 0;
	$CFG->forced_plugin_settings = array('page'=>array('displayoptions'=>5, 'requiremodintro'=>1), 'folder'=>array('requiremodintro'=>1));		$CFG->forced_plugin_settings = array('page'=>array('displayoptions'=>5, 'requiremodintro'=>1), 'folder'=>array('requiremodintro'=>1));
	</~~code~~>		</syntaxhighlight>

	=== Local language customisations===		=== Local language customisations===
Line 134:		Line 134:
	<?php		<?php
	$string['login'] = 'Sign in';		$string['login'] = 'Sign in';
	</~~code~~>		</syntaxhighlight>
	See also https://docs.moodle.org/en/Language_editing		See also https://docs.moodle.org/en/Language_editing

Line 194:		Line 194:
	}		}
	}		}
	</~~code~~>		</syntaxhighlight>

	=== Removing the "Site Home" link from the navigation menu ===		=== Removing the "Site Home" link from the navigation menu ===
Line 203:		Line 203:
	}		}
	}		}
	</~~code~~>		</syntaxhighlight>

	=== Adding Site Wide Settings For Your Local Plugin ===		=== Adding Site Wide Settings For Your Local Plugin ===
Line 242:		Line 242:

	}		}
	</~~code~~>		</syntaxhighlight>

	== Local customisations in previous versions ==		== Local customisations in previous versions ==
Line 255:		Line 255:

	=== Migration from old 1.9.x /local/: ===		=== Migration from old 1.9.x /local/: ===
	* <code>local/*</~~code~~> needs to be copied to new directory		* <code>local/*</syntaxhighlight> needs to be copied to new directory
	* <code>local/xxxx/db/install.php</~~code~~> is intended for first installation, originally everything was in upgrade.php		* <code>local/xxxx/db/install.php</syntaxhighlight> is intended for first installation, originally everything was in upgrade.php
	* events are used instead of hooks		* events are used instead of hooks
	* upgrade code needs to migrate old settings, events, etc. directly in core db tables - such as change component strings and capability names from db/install.php or manually before/after upgrade		* upgrade code needs to migrate old settings, events, etc. directly in core db tables - such as change component strings and capability names from db/install.php or manually before/after upgrade

← Older revision		Revision as of 11:19, 20 May 2020
Line 264:		Line 264:
	* [http://moodle.org/mod/forum/discuss.php?d=170325&parent=753095 Extending navigation block]		* [http://moodle.org/mod/forum/discuss.php?d=170325&parent=753095 Extending navigation block]
	* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=86903 Local Customisations] forum discussion		* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=86903 Local Customisations] forum discussion
	* http://cvs.moodle.org/moodle/local/readme.txt?view=markup
	* [[Local customisation (Moodle 1.9)]]		* [[Local customisation (Moodle 1.9)]]

	[[Category:Plugins]]		[[Category:Plugins]]

← Older revision		Revision as of 10:25, 10 February 2020
Line 33:		Line 33:
	* /local/xxx/cron.php - cron job, run at the interval defined in version.php. Alternatively, you can define <tt>local_xxx_cron()</tt> in lib.php. Between those two methods, the lib.php one is preferred. But both of them are considered legacy and have been deprecated for Moodle 3.5 (MDL-52846) and will be deleted for Moodle 3.9 (MDL-61165). [[https://docs.moodle.org/dev/Task_API#Legacy_cron More info here]]. They are being replaced with the [[Task_API]].		* /local/xxx/cron.php - cron job, run at the interval defined in version.php. Alternatively, you can define <tt>local_xxx_cron()</tt> in lib.php. Between those two methods, the lib.php one is preferred. But both of them are considered legacy and have been deprecated for Moodle 3.5 (MDL-52846) and will be deleted for Moodle 3.9 (MDL-61165). [[https://docs.moodle.org/dev/Task_API#Legacy_cron More info here]]. They are being replaced with the [[Task_API]].
	* /local/xxx/lang/en/local_pluginname.php - language file		* /local/xxx/lang/en/local_pluginname.php - language file
	* /local/xxx/lib.php - function library, automatically included with by config.php. Hook functions ~~local_pluginname_extend_navigation~~() and ~~local_pluginname_extend_settings_navigation~~() can be used to add items to the navigation and settings blocks		* /local/xxx/lib.php - function library, automatically included with by config.php. Hook functions <tt>local_xxx_extend_navigation()</tt> and <tt>local_xxx_extend_settings_navigation()</tt> can be used to add items to the navigation and settings blocks
	* /local/xxx/settings.php - configuration options. These get added to the admin menu.		* /local/xxx/settings.php - configuration options. These get added to the admin menu.

← Older revision		Revision as of 11:46, 7 June 2019
Line 225:		Line 225:

	// This is the reference you will use to your configuration		// This is the reference you will use to your configuration
	'~~yourplugin_apikey~~',		'local_yourplugin/apikey',

	// This is the friendly title for the config, which will be displayed		// This is the friendly title for the config, which will be displayed

← Older revision		Revision as of 00:24, 18 August 2018
Line 31:		Line 31:
	* /local/xxx/db/messages.php - messaging registration		* /local/xxx/db/messages.php - messaging registration
	* /local/xxx/db/external.php - web services and external functions descriptions		* /local/xxx/db/external.php - web services and external functions descriptions
	* /local/xxx/cron.php - cron job, run at the interval defined in version.php. Alternatively, you can define <tt>local_xxx_cron()</tt> in lib.php. ~~(The~~ lib.php ~~method~~ is ~~now~~ preferred.)		* /local/xxx/cron.php - cron job, run at the interval defined in version.php. Alternatively, you can define <tt>local_xxx_cron()</tt> in lib.php. Between those two methods, the lib.php one is preferred. But both of them are considered legacy and have been deprecated for Moodle 3.5 (MDL-52846) and will be deleted for Moodle 3.9 (MDL-61165). [[https://docs.moodle.org/dev/Task_API#Legacy_cron More info here]]. They are being replaced with the [[Task_API]].
	* /local/xxx/lang/en/local_pluginname.php - language file		* /local/xxx/lang/en/local_pluginname.php - language file
	* /local/xxx/lib.php - function library, automatically included with by config.php. Hook functions local_pluginname_extend_navigation() and local_pluginname_extend_settings_navigation() can be used to add items to the navigation and settings blocks		* /local/xxx/lib.php - function library, automatically included with by config.php. Hook functions local_pluginname_extend_navigation() and local_pluginname_extend_settings_navigation() can be used to add items to the navigation and settings blocks