Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@0:  * @file
Chris@0:  * Documentation for Text Editor API.
Chris@0:  */
Chris@0: 
Chris@0: use Drupal\filter\FilterFormatInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * @addtogroup hooks
Chris@0:  * @{
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * Performs alterations on text editor definitions.
Chris@0:  *
Chris@0:  * @param array $editors
Chris@0:  *   An array of metadata of text editors, as collected by the plugin annotation
Chris@0:  *   discovery mechanism.
Chris@0:  *
Chris@0:  * @see \Drupal\editor\Plugin\EditorBase
Chris@0:  */
Chris@0: function hook_editor_info_alter(array &$editors) {
Chris@0:   $editors['some_other_editor']['label'] = t('A different name');
Chris@0:   $editors['some_other_editor']['library']['module'] = 'myeditoroverride';
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Modifies JavaScript settings that are added for text editors.
Chris@0:  *
Chris@0:  * @param array $settings
Chris@0:  *   All the settings that will be added to the page for the text formats to
Chris@0:  *   which a user has access.
Chris@0:  */
Chris@0: function hook_editor_js_settings_alter(array &$settings) {
Chris@0:   if (isset($settings['editor']['formats']['basic_html'])) {
Chris@0:     $settings['editor']['formats']['basic_html']['editor'] = 'MyDifferentEditor';
Chris@0:     $settings['editor']['formats']['basic_html']['editorSettings']['buttons'] = ['strong', 'italic', 'underline'];
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Modifies the text editor XSS filter that will used for the given text format.
Chris@0:  *
Chris@0:  * Is only called when an EditorXssFilter will effectively be used; this hook
Chris@0:  * does not allow one to alter that decision.
Chris@0:  *
Chris@0:  * @param string &$editor_xss_filter_class
Chris@0:  *   The text editor XSS filter class that will be used.
Chris@0:  * @param \Drupal\filter\FilterFormatInterface $format
Chris@0:  *   The text format configuration entity. Provides context based upon which
Chris@0:  *   one may want to adjust the filtering.
Chris@0:  * @param \Drupal\filter\FilterFormatInterface|null $original_format
Chris@0:  *   (optional) The original text format configuration entity (when switching
Chris@0:  *   text formats/editors). Also provides context based upon which one may want
Chris@0:  *   to adjust the filtering.
Chris@0:  *
Chris@0:  * @see \Drupal\editor\EditorXssFilterInterface
Chris@0:  */
Chris@0: function hook_editor_xss_filter_alter(&$editor_xss_filter_class, FilterFormatInterface $format, FilterFormatInterface $original_format = NULL) {
Chris@0:   $filters = $format->filters()->getAll();
Chris@0:   if (isset($filters['filter_wysiwyg']) && $filters['filter_wysiwyg']->status) {
Chris@0:     $editor_xss_filter_class = '\Drupal\filter_wysiwyg\EditorXssFilter\WysiwygFilter';
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * @} End of "addtogroup hooks".
Chris@0:  */