Url::getRouteName

public Url::getRouteName()

Returns the route name.

Return value

string

Throws

\UnexpectedValueException. If this is a URI with no corresponding route.

File

core/lib/Drupal/Core/Url.php, line 552

Class

Url: Defines an object that holds information about a URL.

Namespace

Drupal\Core

Code

public function getRouteName() {
  if ($this->unrouted) {
    throw new \UnexpectedValueException('External URLs do not have an internal route name.');
  }
 
  return $this->routeName;
}

Links:

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Url.php/function/Url%3A%3AgetRouteName/8.2.x

doc_Drupal

2025-01-10 15:47:30

Comments

Popular Articles

RouteMatch::getRouteName public RouteMatch::getRouteName() Returns the route name. Return value string|null The route name. NULL if no route is matched. Overrides RouteMatch

NullRouteMatch::getRouteName public NullRouteMatch::getRouteName() Returns the route name. Return value string|null The route name. NULL if no route is matched. Overrides RouteM

LocalActionDefault::getRouteName public LocalActionDefault::getRouteName() Get the route name from the settings. Return value string The name of the route this action links to. Over

MenuLinkInterface::getRouteName public MenuLinkInterface::getRouteName() Returns the route name, if available. Return value string The name of the route this menu link links to. Fi

RouteMatchInterface::getRouteName public RouteMatchInterface::getRouteName() Returns the route name. Return value string|null The route name. NULL if no route is matched. File core/l