function editor_load

Loads an individual configured text editor based on text format ID.

Parameters

int $format_id: A text format ID.

Return value

\Drupal\editor\Entity\Editor|null A text editor object, or NULL.

10 calls to editor_load()
Editor::getAttachments in core/modules/quickedit/src/Plugin/InPlaceEditor/Editor.php
Returns the attachments for this editor.
Editor::getAttachments in core/modules/editor/src/Plugin/InPlaceEditor/Editor.php
Returns the attachments for this editor.
Editor::isCompatible in core/modules/quickedit/src/Plugin/InPlaceEditor/Editor.php
Checks whether this in-place editor is compatible with a given field.
Editor::isCompatible in core/modules/editor/src/Plugin/InPlaceEditor/Editor.php
Checks whether this in-place editor is compatible with a given field.
EditorAdminTest::verifyUnicornEditorConfiguration in core/modules/editor/tests/src/Functional/EditorAdminTest.php
Verifies unicorn editor configuration.

... See full list

File

core/modules/editor/editor.module, line 268

Code

function editor_load($format_id) {
  // Load all the editors at once here, assuming that either no editors or more
  // than one editor will be needed on a page (such as having multiple text
  // formats for administrators). Loading a small number of editors all at once
  // is more efficient than loading multiple editors individually.
  $editors = Editor::loadMultiple();
  return $editors[$format_id] ?? NULL;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.