Markup.php

Same filename in this branch
  1. 11.x core/lib/Drupal/Core/Render/Markup.php
Same filename in other branches
  1. 9 core/modules/views/src/Plugin/views/field/Markup.php
  2. 9 core/lib/Drupal/Core/Render/Markup.php
  3. 8.9.x core/modules/views/src/Plugin/views/field/Markup.php
  4. 8.9.x core/lib/Drupal/Core/Render/Markup.php
  5. 10 core/modules/views/src/Plugin/views/field/Markup.php
  6. 10 core/lib/Drupal/Core/Render/Markup.php

Namespace

Drupal\views\Plugin\views\field

File

core/modules/views/src/Plugin/views/field/Markup.php

View source
<?php

namespace Drupal\views\Plugin\views\field;

use Drupal\views\Attribute\ViewsField;
use Drupal\views\Plugin\views\display\DisplayPluginBase;
use Drupal\views\ResultRow;
use Drupal\views\ViewExecutable;

/**
 * Handler to run a field through check_markup, using a companion format field.
 *
 * - format: (REQUIRED) Either a string format id to use for this field or an
 *           array('field' => {$field}) where $field is the field in this table
 *           used to control the format such as the 'format' field in the node,
 *           which goes with the 'body' field.
 *
 * @ingroup views_field_handlers
 */
class Markup extends FieldPluginBase {
    
    /**
     * The format to use for this field.
     */
    public string $format;
    
    /**
     * {@inheritdoc}
     */
    public function init(ViewExecutable $view, DisplayPluginBase $display, ?array &$options = NULL) {
        parent::init($view, $display, $options);
        $this->format = $this->definition['format'];
        $this->additional_fields = [];
        if (is_array($this->format)) {
            $this->additional_fields['format'] = $this->format;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function render(ResultRow $values) {
        $value = $this->getValue($values);
        if (is_array($this->format)) {
            $format = $this->getValue($values, 'format');
        }
        else {
            $format = $this->format;
        }
        if ($value) {
            $value = str_replace('<!--break-->', '', $value);
            return check_markup($value, $format);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function elementType($none_supported = FALSE, $default_empty = FALSE, $inline = FALSE) {
        if ($inline) {
            return 'span';
        }
        if (isset($this->definition['element type'])) {
            return $this->definition['element type'];
        }
        return 'div';
    }

}

Classes

Title Deprecated Summary
Markup Handler to run a field through check_markup, using a companion format field.

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