interface WordfilterProcessInterface in Wordfilter 8.2

Defines an interface for Wordfilter Process plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\wordfilter\Plugin\WordfilterProcessInterface

1 file declares its use of WordfilterProcessInterface

WordfilterConfiguration.php in src/Entity/WordfilterConfiguration.php

File

src/Plugin/WordfilterProcessInterface.php, line 13

Namespace

Drupal\wordfilter\Plugin

interface WordfilterProcessInterface extends PluginInspectionInterface {

  /**
   * Provides filtering of words by the given Wordfilter configuration.
   *
   * @param string $text
   *  The text to filter.
   * @param \Drupal\wordfilter\Entity\WordfilterConfigurationInterface $wordfilter_config
   *  The Wordfilter configuration to use during the filtering process.
   * @param string $langcode
   *  (Optional) The language code.
   *
   * @return string
   *   The filtered text.
   */
  public function filterWords($text, WordfilterConfigurationInterface $wordfilter_config, $langcode = LanguageInterface::LANGCODE_NOT_SPECIFIED);

  /**
   * Additional settings form according to the given Wordfilter configuration.
   *
   * @param array $form
   *   The corresponding form builder array.
   * @param FormStateInterface $form_state
   *   The form state.
   * @param WordfilterConfigurationInterface $wordfilter_config
   *   The corresponding Wordfilter configuration object.
   *
   * @return
   *   A renderable form array.
   */
  public function settingsForm(array $form, FormStateInterface $form_state, WordfilterConfigurationInterface $wordfilter_config);

}

Members

Name	Modifiers	Type	Description	Overrides
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
WordfilterProcessInterface::filterWords	public	function	Provides filtering of words by the given Wordfilter configuration.	2
WordfilterProcessInterface::settingsForm	public	function	Additional settings form according to the given Wordfilter configuration.	1