function StringInterface::getLocations

Same name in other branches
  1. 9 core/modules/locale/src/StringInterface.php \Drupal\locale\StringInterface::getLocations()
  2. 8.9.x core/modules/locale/src/StringInterface.php \Drupal\locale\StringInterface::getLocations()
  3. 10 core/modules/locale/src/StringInterface.php \Drupal\locale\StringInterface::getLocations()

Gets location information for this string.

Locations are arbitrary pairs of type and name strings, used to store information about the origins of the string, like the file name it was found on, the path on which it was discovered, etc.

A string can have any number of locations since the same string may be found on different places of Drupal code and configuration.

Parameters

bool $check_only: (optional) Set to TRUE to get only new locations added during the current page request and not loading all existing locations.

Return value

array Location ids indexed by type and name.

1 method overrides StringInterface::getLocations()
StringBase::getLocations in core/modules/locale/src/StringBase.php
Gets location information for this string.

File

core/modules/locale/src/StringInterface.php, line 167

Class

StringInterface
Defines the locale string interface.

Namespace

Drupal\locale

Code

public function getLocations($check_only = FALSE);

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