function Url::fromUserInput
Same name in other branches
- 9 core/lib/Drupal/Core/Url.php \Drupal\Core\Url::fromUserInput()
- 8.9.x core/lib/Drupal/Core/Url.php \Drupal\Core\Url::fromUserInput()
- 10 core/lib/Drupal/Core/Url.php \Drupal\Core\Url::fromUserInput()
Creates a Url object for a relative URI reference submitted by user input.
Use this method to create a URL for user-entered paths that may or may not correspond to a valid Drupal route.
Parameters
string $user_input: User input for a link or path. The first character must be one of the following characters:
- '/': A path within the current site. This path might be to a Drupal route (e.g., '/admin'), to a file (e.g., '/README.txt'), or to something processed by a non-Drupal script (e.g., '/not/a/drupal/page'). If the path matches a Drupal route, then the URL generation will include Drupal's path processors (e.g., language-prefixing and aliasing). Otherwise, the URL generation will just append the passed-in path to Drupal's base path.
- '?': A query string for the current page or resource.
- '#': A fragment (jump-link) on the current page or resource.
This helps reduce ambiguity for user-entered links and paths, and supports user interfaces where users may normally use auto-completion to search for existing resources, but also may type one of these characters to link to (e.g.) a specific path on the site. (With regard to the URI specification, the user input is treated as a relative URI reference where the relative part is of type path-abempty.)
array $options: (optional) An array of options. See Url::fromUri() for details.
Return value
static A new Url object based on user input.
Throws
\InvalidArgumentException Thrown when the user input does not begin with one of the following characters: '/', '?', or '#'.
21 calls to Url::fromUserInput()
- BlockEntitySettingTrayForm::getRedirectUrl in core/
modules/ settings_tray/ src/ Block/ BlockEntitySettingTrayForm.php - Gets the form's redirect URL from 'destination' provide in the request.
- BlockHooks::blockBuildLocalActionsBlockAlter in core/
modules/ block/ src/ Hook/ BlockHooks.php - Implements hook_block_build_BASE_BLOCK_ID_alter().
- ConfirmFormHelper::buildCancelLink in core/
lib/ Drupal/ Core/ Form/ ConfirmFormHelper.php - Builds the cancel link for a confirmation form.
- ContactForm::getRedirectUrl in core/
modules/ contact/ src/ Entity/ ContactForm.php - Returns the \Drupal\Core\Url object for redirect path.
- CustomPageExceptionHtmlSubscriber::makeSubrequestToCustomPath in core/
lib/ Drupal/ Core/ EventSubscriber/ CustomPageExceptionHtmlSubscriber.php - Makes a subrequest to retrieve the custom error page.
File
-
core/
lib/ Drupal/ Core/ Url.php, line 210
Class
- Url
- Defines an object that holds information about a URL.
Namespace
Drupal\CoreCode
public static function fromUserInput($user_input, $options = []) {
// Ensuring one of these initial characters also enforces that what is
// passed is a relative URI reference rather than an absolute URI,
// because these are URI reserved characters that a scheme name may not
// start with.
if (!str_starts_with($user_input, '/') && !str_starts_with($user_input, '#') && !str_starts_with($user_input, '?')) {
throw new \InvalidArgumentException("The user-entered string '{$user_input}' must begin with a '/', '?', or '#'.");
}
// fromUri() requires an absolute URI, so prepend the appropriate scheme
// name.
return static::fromUri('internal:' . $user_input, $options);
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.