Editor API - Revision history

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

2022-06-24T02:30:31Z

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

← Older revision		Revision as of 02:30, 24 June 2022
(No difference)

Devdocsbot: Update migration status and path

2022-06-24T02:28:38Z

Update migration status and path

← Older revision		Revision as of 02:28, 24 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/subsystems/editor/}}
	The editor API lets you control Moodle text editors. It can be found in lib/editorlib.php.		The editor API lets you control Moodle text editors. It can be found in lib/editorlib.php.

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


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

				
				
				
				
				
				← Older revision
				Revision as of 13:30, 14 July 2021
				
Line 14:
Line 14:
For example, assuming there is an HTML text area with id mytextareaid: For example, assuming there is an HTML text area with id mytextareaid:



<code php> <syntaxhighlight lang="php">
$editor = editors_get_preferred_editor(FORMAT_HTML); $editor = editors_get_preferred_editor(FORMAT_HTML);
$editor->use_editor('mytextareaid'); $editor->use_editor('mytextareaid');
Line 35:
Line 35:
The following code will cause atto to show the four buttons indicated. The following code will cause atto to show the four buttons indicated.



  <code php>   <syntaxhighlight lang="php">
$attobuttons = 'style1 = bold, italic'. PHP_EOL .'list = unorderedlist, orderedlist'; $attobuttons = 'style1 = bold, italic'. PHP_EOL .'list = unorderedlist, orderedlist';
$editor->use_editor($id, ['context' => $context, 'autosave' => false, 'atto:toolbar' => $attobuttons], $editor->use_editor($id, ['context' => $context, 'autosave' => false, 'atto:toolbar' => $attobuttons],
                 ['return_types' => FILE_EXTERNAL]);</syntaxhighlight>                  ['return_types' => FILE_EXTERNAL]);</syntaxhighlight>

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

2021-07-14T13:09:22Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 13:09, 14 July 2021
Line 17:		Line 17:
	$editor = editors_get_preferred_editor(FORMAT_HTML);		$editor = editors_get_preferred_editor(FORMAT_HTML);
	$editor->use_editor('mytextareaid');		$editor->use_editor('mytextareaid');
	</~~code~~>		</syntaxhighlight>

	== Editor options ==		== Editor options ==
Line 38:		Line 38:
	$attobuttons = 'style1 = bold, italic'. PHP_EOL .'list = unorderedlist, orderedlist';		$attobuttons = 'style1 = bold, italic'. PHP_EOL .'list = unorderedlist, orderedlist';
	$editor->use_editor($id, ['context' => $context, 'autosave' => false, 'atto:toolbar' => $attobuttons],		$editor->use_editor($id, ['context' => $context, 'autosave' => false, 'atto:toolbar' => $attobuttons],
	['return_types' => FILE_EXTERNAL]);</~~code~~>		['return_types' => FILE_EXTERNAL]);</syntaxhighlight>

Marcusgreen: /* Atto-specific options */

2019-12-25T21:09:33Z

Atto-specific options

← Older revision		Revision as of 21:09, 25 December 2019
Line 32:		Line 32:

	; toolbar : set to override which icons appear on the toolbar (normally it uses the admin setting - this is for special cases e.g. if you want a minimal editor in a particular plugin).		; toolbar : set to override which icons appear on the toolbar (normally it uses the admin setting - this is for special cases e.g. if you want a minimal editor in a particular plugin).

			The following code will cause atto to show the four buttons indicated.

			<code php>
			$attobuttons = 'style1 = bold, italic'. PHP_EOL .'list = unorderedlist, orderedlist';
			$editor->use_editor($id, ['context' => $context, 'autosave' => false, 'atto:toolbar' => $attobuttons],
			['return_types' => FILE_EXTERNAL]);</code>

Quen: Very basic documentation about setting up text editors, hopefully correct

2018-08-13T11:04:12Z

Very basic documentation about setting up text editors, hopefully correct

New page

The editor API lets you control Moodle text editors. It can be found in lib/editorlib.php.

Normally you do not need to use this API directly because you can include editors as part of a Moodle form, which will automatically set up the editor for you.

This documentation is (very) incomplete.

== How to set up a text editor ==

To set up a text editor on an existing HTML text area field:

* Call function editors_get_preferred_editor(), which will return an object of the texteditor class.
* Call function use_editor to enable the editor for the text area.

For example, assuming there is an HTML text area with id mytextareaid:

<code php>
$editor = editors_get_preferred_editor(FORMAT_HTML);
$editor->use_editor('mytextareaid');
</code>

== Editor options ==

The use_editor function allows an options array to be supplied.

=== General options ===

; context : set to the current context object
; enable_filemanagement : set false to get rid of the managefiles plugin
; autosave : set false to turn off autosave

=== Atto-specific options ===

; toolbar : set to override which icons appear on the toolbar (normally it uses the admin setting - this is for special cases e.g. if you want a minimal editor in a particular plugin).

← Older revision		Revision as of 13:30, 14 July 2021
Line 14:		Line 14:
	For example, assuming there is an HTML text area with id mytextareaid:		For example, assuming there is an HTML text area with id mytextareaid:

	<~~code~~ php>		<syntaxhighlight lang="php">
	$editor = editors_get_preferred_editor(FORMAT_HTML);		$editor = editors_get_preferred_editor(FORMAT_HTML);
	$editor->use_editor('mytextareaid');		$editor->use_editor('mytextareaid');
Line 35:		Line 35:
	The following code will cause atto to show the four buttons indicated.		The following code will cause atto to show the four buttons indicated.

	<~~code~~ php>		<syntaxhighlight lang="php">
	$attobuttons = 'style1 = bold, italic'. PHP_EOL .'list = unorderedlist, orderedlist';		$attobuttons = 'style1 = bold, italic'. PHP_EOL .'list = unorderedlist, orderedlist';
	$editor->use_editor($id, ['context' => $context, 'autosave' => false, 'atto:toolbar' => $attobuttons],		$editor->use_editor($id, ['context' => $context, 'autosave' => false, 'atto:toolbar' => $attobuttons],
	['return_types' => FILE_EXTERNAL]);</syntaxhighlight>		['return_types' => FILE_EXTERNAL]);</syntaxhighlight>