You are here

public function DisplayPluginBase::getArgumentText in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/views/src/Plugin/views/display/DisplayPluginBase.php \Drupal\views\Plugin\views\display\DisplayPluginBase::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.

Overrides DisplayPluginInterface::getArgumentText

1 method overrides DisplayPluginBase::getArgumentText()
Page::getArgumentText in core/modules/views/src/Plugin/views/display/Page.php
Provides help text for the arguments.

File

core/modules/views/src/Plugin/views/display/DisplayPluginBase.php, line 2641

Class

DisplayPluginBase
Base class for views display plugins.

Namespace

Drupal\views\Plugin\views\display

Code

public function getArgumentText() {
  return [
    'filter value not present' => $this
      ->t('When the filter value is <em>NOT</em> available'),
    'filter value present' => $this
      ->t('When the filter value <em>IS</em> available or a default is provided'),
    'description' => $this
      ->t("This display does not have a source for contextual filters, so no contextual filter value will be available unless you select 'Provide default'."),
  ];
}