Core APIs - Revision history

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

2022-05-06T07:26:58Z

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

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

2022-04-14T07:50:39Z

Note migration to new docs

← Older revision		Revision as of 07:50, 14 April 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis}}

	Moodle has a number of core APIs that provide tools for Moodle scripts.		Moodle has a number of core APIs that provide tools for Moodle scripts.

2022-03-16T02:44:00Z

2021-12-23T11:03:14Z

Admin presets API (adminpresets)

← Older revision		Revision as of 11:03, 23 December 2021
Line 32:		Line 32:
	The [[Admin settings]] API deals with providing configuration options for each plugin and Moodle core.		The [[Admin settings]] API deals with providing configuration options for each plugin and Moodle core.
	=== Admin presets API (adminpresets) ===		=== Admin presets API (adminpresets) ===
	The [[AdminPresetsAPI\|~~Analytics~~ API]] allows plugins to make some decisions/implementations related to the Site admin presets.		The [[AdminPresetsAPI\|Admin presets API]] allows plugins to make some decisions/implementations related to the Site admin presets.
	=== Analytics API (analytics) ===		=== Analytics API (analytics) ===
	The [[Analytics API]] allow you to create prediction models and generate insights.		The [[Analytics API]] allow you to create prediction models and generate insights.

2021-12-23T11:01:44Z

Added new adminpresets API

← Older revision		Revision as of 11:01, 23 December 2021
Line 31:		Line 31:
	=== Admin settings API (admin) ===		=== Admin settings API (admin) ===
	The [[Admin settings]] API deals with providing configuration options for each plugin and Moodle core.		The [[Admin settings]] API deals with providing configuration options for each plugin and Moodle core.
			=== Admin presets API (adminpresets) ===
			The [[AdminPresetsAPI\|Analytics API]] allows plugins to make some decisions/implementations related to the Site admin presets.
	=== Analytics API (analytics) ===		=== Analytics API (analytics) ===
	The [[Analytics API]] allow you to create prediction models and generate insights.		The [[Analytics API]] allow you to create prediction models and generate insights.
Line 107:		Line 109:
	=== Custom fields API ===		=== Custom fields API ===
	The [[Custom fields API]] allows you to configure and add custom fields for different entities		The [[Custom fields API]] allows you to configure and add custom fields for different entities

	== Activity module APIs ==		== Activity module APIs ==
	Activity modules are the most important plugin in Moodle. There are several core APIs that service only Activity modules.		Activity modules are the most important plugin in Moodle. There are several core APIs that service only Activity modules.

2021-10-07T11:52:20Z

Link to Report builder API.

← Older revision		Revision as of 11:52, 7 October 2021
Line 85:		Line 85:
	=== Rating API (rating) ===		=== Rating API (rating) ===
	The [[Rating API]] lets you create AJAX rating interfaces so that users can rate items in your plugin. In an activity module, you may choose to aggregate ratings to form grades.		The [[Rating API]] lets you create AJAX rating interfaces so that users can rate items in your plugin. In an activity module, you may choose to aggregate ratings to form grades.
			=== Report builder API (reportbuilder) ===
			The [[Report builder API]] allows you to create reports in your plugin, as well as providing custom reporting data which users can use to build their own reports.
	=== RSS API (rss) ===		=== RSS API (rss) ===
	The [[RSS API]] allows you to create secure RSS feeds of data in your module.		The [[RSS API]] allows you to create secure RSS feeds of data in your module.
Line 105:		Line 107:
	=== Custom fields API ===		=== Custom fields API ===
	The [[Custom fields API]] allows you to configure and add custom fields for different entities		The [[Custom fields API]] allows you to configure and add custom fields for different entities

	== Activity module APIs ==		== Activity module APIs ==
	Activity modules are the most important plugin in Moodle. There are several core APIs that service only Activity modules.		Activity modules are the most important plugin in Moodle. There are several core APIs that service only Activity modules.

2021-09-08T11:02:12Z

Added H5P API

2021-03-11T12:45:40Z

← Older revision		Revision as of 12:45, 11 March 2021
Line 187:		Line 187:

	This is a rather informal grouping of miscellaneous [[User-related APIs]] relating to sorting and searching lists of users.		This is a rather informal grouping of miscellaneous [[User-related APIs]] relating to sorting and searching lists of users.

	~~=== User fields API ===~~

	The [[User fields API]] is mainly used when displaying tables of data about users. It indicates which extra fields (e.g. email) should be displayed in the current context based on the permissions of the current user. It also provides ways to get the necessary data from a query, and to obtainother generally-useful fields for user names and pictures.

	=== Web services API (webservice) ===		=== Web services API (webservice) ===

2021-03-11T11:43:48Z

User-related APIs (user)

← Older revision		Revision as of 11:43, 11 March 2021
Line 187:		Line 187:

	This is a rather informal grouping of miscellaneous [[User-related APIs]] relating to sorting and searching lists of users.		This is a rather informal grouping of miscellaneous [[User-related APIs]] relating to sorting and searching lists of users.

			=== User fields API ===

			The [[User fields API]] is mainly used when displaying tables of data about users. It indicates which extra fields (e.g. email) should be displayed in the current context based on the permissions of the current user. It also provides ways to get the necessary data from a query, and to obtainother generally-useful fields for user names and pictures.

	=== Web services API (webservice) ===		=== Web services API (webservice) ===

2020-12-28T15:02:49Z

ja link

← Older revision		Revision as of 15:02, 28 December 2020
Line 237:		Line 237:
	* [[Callbacks]] - list of all callbacks in Moodle		* [[Callbacks]] - list of all callbacks in Moodle
	* [[Coding style]] - general information about writing PHP code for Moodle		* [[Coding style]] - general information about writing PHP code for Moodle

			[[ja:コアAPI]]

← Older revision		Revision as of 02:44, 16 March 2022
Line 129:		Line 129:
	* [[Callbacks]] - list of all callbacks in Moodle		* [[Callbacks]] - list of all callbacks in Moodle
	* [[Coding style]] - general information about writing PHP code for Moodle		* [[Coding style]] - general information about writing PHP code for Moodle
			* [[Session locks]]
	[[ja:コアAPI]]		[[ja:コアAPI]]