class ViewsExposedForm

Same name in this branch
  1. 9 core/modules/views/src/Form/ViewsExposedForm.php \Drupal\views\Form\ViewsExposedForm
Same name and namespace in other branches
  1. 11.x core/modules/views/src/Attribute/ViewsExposedForm.php \Drupal\views\Attribute\ViewsExposedForm
  2. 11.x core/modules/views/src/Form/ViewsExposedForm.php \Drupal\views\Form\ViewsExposedForm
  3. 11.x core/modules/views/src/Annotation/ViewsExposedForm.php \Drupal\views\Annotation\ViewsExposedForm
  4. 10 core/modules/views/src/Attribute/ViewsExposedForm.php \Drupal\views\Attribute\ViewsExposedForm
  5. 10 core/modules/views/src/Form/ViewsExposedForm.php \Drupal\views\Form\ViewsExposedForm
  6. 10 core/modules/views/src/Annotation/ViewsExposedForm.php \Drupal\views\Annotation\ViewsExposedForm
  7. 8.9.x core/modules/views/src/Form/ViewsExposedForm.php \Drupal\views\Form\ViewsExposedForm
  8. 8.9.x core/modules/views/src/Annotation/ViewsExposedForm.php \Drupal\views\Annotation\ViewsExposedForm

Defines a Plugin annotation object for views exposed form plugins.

Hierarchy

Expanded class hierarchy of ViewsExposedForm

See also

\Drupal\views\Plugin\views\exposed_form\ExposedFormPluginInterface

\Drupal\views\Plugin\views\exposed_form\ExposedFormPluginBase

Related topics

2 classes are annotated with ViewsExposedForm
Basic in core/modules/views/src/Plugin/views/exposed_form/Basic.php
Exposed form plugin that provides a basic exposed form.
InputRequired in core/modules/views/src/Plugin/views/exposed_form/InputRequired.php
Exposed form plugin that provides an exposed form with required input.

File

core/modules/views/src/Annotation/ViewsExposedForm.php, line 15

Namespace

Drupal\views\Annotation
View source
class ViewsExposedForm extends ViewsPluginAnnotationBase {
  
  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;
  
  /**
   * The plugin title used in the views UI.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title = '';
  
  /**
   * (optional) The short title used in the views UI.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $short_title = '';
  
  /**
   * A short help string; this is displayed in the views UI.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $help = '';
  
  /**
   * The types of the display this plugin can be used with.
   *
   * For example the Feed display defines the type 'feed', so only rss style
   * and row plugins can be used in the views UI.
   *
   * @var array
   */
  public $display_types;
  
  /**
   * The base tables on which this exposed form plugin can be used.
   *
   * If no base table is specified the plugin can be used with all tables.
   *
   * @var array
   */
  public $base;
  
  /**
   * Whether the plugin should be not selectable in the UI.
   *
   * If it's set to TRUE, you can still use it via the API in config files.
   *
   * @var bool
   */
  public $no_ui;

}

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