FilterTestPlaceholders.php

Same filename in other branches
  1. 9 core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestPlaceholders.php
  2. 10 core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestPlaceholders.php
  3. 11.x core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestPlaceholders.php

Namespace

Drupal\filter_test\Plugin\Filter

File

core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestPlaceholders.php

View source
<?php

namespace Drupal\filter_test\Plugin\Filter;

use Drupal\Component\Render\FormattableMarkup;
use Drupal\Core\Security\TrustedCallbackInterface;
use Drupal\filter\FilterProcessResult;
use Drupal\filter\Plugin\FilterBase;

/**
 * Provides a test filter to use placeholders.
 *
 * @Filter(
 *   id = "filter_test_placeholders",
 *   title = @Translation("Testing filter"),
 *   description = @Translation("Appends a placeholder to the content; associates #lazy_builder callback."),
 *   type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_REVERSIBLE
 * )
 */
class FilterTestPlaceholders extends FilterBase implements TrustedCallbackInterface {
    
    /**
     * {@inheritdoc}
     */
    public function process($text, $langcode) {
        $result = new FilterProcessResult($text);
        $placeholder = $result->createPlaceholder('\\Drupal\\filter_test\\Plugin\\Filter\\FilterTestPlaceholders::renderDynamicThing', [
            'llama',
        ]);
        $result->setProcessedText($text . '<p>' . $placeholder . '</p>');
        return $result;
    }
    
    /**
     * #lazy_builder callback; builds a render array containing the dynamic thing.
     *
     * @param string $thing
     *   A "thing" string.
     *
     * @return array
     *   A renderable array.
     */
    public static function renderDynamicThing($thing) {
        return [
            '#markup' => new FormattableMarkup('This is a dynamic @thing.', [
                '@thing' => $thing,
            ]),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public static function trustedCallbacks() {
        return [
            'renderDynamicThing',
        ];
    }

}

Classes

Title Deprecated Summary
FilterTestPlaceholders Provides a test filter to use placeholders.

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