Filter.php

Same filename in this branch
  1. 11.x core/modules/jsonapi/src/Query/Filter.php
  2. 11.x core/modules/filter/src/Attribute/Filter.php
Same filename in other branches
  1. 9 core/modules/jsonapi/src/Query/Filter.php
  2. 9 core/modules/filter/src/Annotation/Filter.php
  3. 8.9.x core/modules/jsonapi/src/Query/Filter.php
  4. 8.9.x core/modules/filter/src/Annotation/Filter.php
  5. 10 core/modules/jsonapi/src/Query/Filter.php
  6. 10 core/modules/filter/src/Annotation/Filter.php
  7. 10 core/modules/filter/src/Attribute/Filter.php

Namespace

Drupal\filter\Annotation

File

core/modules/filter/src/Annotation/Filter.php

View source
<?php

namespace Drupal\filter\Annotation;

use Drupal\Component\Annotation\Plugin;

/**
 * Defines a filter annotation object.
 *
 * Plugin Namespace: Plugin\Filter
 *
 * For a working example, see \Drupal\filter\Plugin\Filter\FilterHtml
 *
 * @see \Drupal\filter\FilterPluginManager
 * @see \Drupal\filter\Plugin\FilterInterface
 * @see \Drupal\filter\Plugin\FilterBase
 * @see plugin_api
 *
 * @Annotation
 */
class Filter extends Plugin {
    
    /**
     * The plugin ID.
     *
     * @var string
     */
    public $id;
    
    /**
     * The name of the provider that owns the filter.
     *
     * @var string
     */
    public $provider;
    
    /**
     * The human-readable name of the filter.
     *
     * This is used as an administrative summary of what the filter does.
     *
     * @var \Drupal\Core\Annotation\Translation
     *
     * @ingroup plugin_translatable
     */
    public $title;
    
    /**
     * Additional administrative information about the filter's behavior.
     *
     * This property is optional and it does not need to be declared.
     *
     * @var \Drupal\Core\Annotation\Translation
     *
     * @ingroup plugin_translatable
     */
    public $description = '';
    
    /**
     * A default weight for the filter in new text formats.
     *
     * This property is optional and it does not need to be declared.
     *
     * @var int
     */
    public $weight = 0;
    
    /**
     * Whether this filter is enabled or disabled by default.
     *
     * This property is optional and it does not need to be declared.
     *
     * @var bool
     */
    public $status = FALSE;
    
    /**
     * The default settings for the filter.
     *
     * This property is optional and it does not need to be declared.
     *
     * @var array
     */
    public $settings = [];

}

Classes

Title Deprecated Summary
Filter Defines a filter annotation object.

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