function DisplayPluginInterface::getArgumentText

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/display/DisplayPluginInterface.php \Drupal\views\Plugin\views\display\DisplayPluginInterface::getArgumentText()
  2. 10 core/modules/views/src/Plugin/views/display/DisplayPluginInterface.php \Drupal\views\Plugin\views\display\DisplayPluginInterface::getArgumentText()
  3. 11.x core/modules/views/src/Plugin/views/display/DisplayPluginInterface.php \Drupal\views\Plugin\views\display\DisplayPluginInterface::getArgumentText()

Provides help text for the arguments.

Return value

array Returns an array which contains text for the argument fieldset:

  • filter value present: The title of the fieldset in the argument where you can configure what should be done with a given argument.
  • filter value not present: The title of the fieldset in the argument where you can configure what should be done if the argument does not exist.
  • description: A description about how arguments are passed to the display. For example blocks can't get arguments from url.
1 method overrides DisplayPluginInterface::getArgumentText()
DisplayPluginBase::getArgumentText in core/modules/views/src/Plugin/views/display/DisplayPluginBase.php
Provides help text for the arguments.

File

core/modules/views/src/Plugin/views/display/DisplayPluginInterface.php, line 587

Class

DisplayPluginInterface
Provides an interface for Views display plugins.

Namespace

Drupal\views\Plugin\views\display

Code

public function getArgumentText();

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