FilterProcessResult

Used to return values from a text filter plugin's processing method.

The typical use case for a text filter plugin's processing method is to just apply some filtering to the given text, but for more advanced use cases, it may be necessary to also:

• Declare asset libraries to be loaded.
• Declare cache tags that the filtered text depends upon, so when either of those cache tags is invalidated, the filtered text should also be invalidated.
• Declare cache context to vary by, e.g. 'language' to do language-specific filtering.
• Declare a maximum age for the filtered text.
• Apply uncacheable filtering, for example because it differs per user.

In case a filter needs one or more of these advanced use cases, it can use the additional methods available.

The typical use case:

public function process($text, $langcode) {
  // Modify $text.

  return new FilterProcessResult($text);
}

The advanced use cases:

public function process($text, $langcode) {
  // Modify $text.

  $result = new FilterProcessResult($text);

  // Associate assets to be attached.
  $result->setAttachments(array(
    'library' => array(
       'filter/caption',
    ),
  ));

  // Associate cache contexts to vary by.
  $result->setCacheContexts(['language']);

  // Associate cache tags to be invalidated by.
  $result->setCacheTags($node->getCacheTags());

  // Associate a maximum age.
  $result->setCacheMaxAge(300); // 5 minutes.

  return $result;
}

Hierarchy

• class \Drupal\Core\Cache\CacheableMetadata implements RefinableCacheableDependencyInterface uses RefinableCacheableDependencyTrait
  • class \Drupal\Core\Render\BubbleableMetadata implements AttachmentsInterface uses AttachmentsTrait
    • class \Drupal\filter\FilterProcessResult

File

core/modules/filter/src/FilterProcessResult.php, line 63

Namespace

Drupal\filter

Members