function check_url in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/includes/common.inc \check_url()
Strips dangerous protocols from a URI and encodes it for output to HTML.
Parameters
$uri: A plain-text URI that might contain dangerous protocols.
Return value
string A URI stripped of dangerous protocols and encoded for output to an HTML attribute value. Because it is already encoded, it should not be set as a value within a $attributes array passed to Drupal\Core\Template\Attribute, because Drupal\Core\Template\Attribute expects those values to be plain-text strings. To pass a filtered URI to Drupal\Core\Template\Attribute, call \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols() instead.
Deprecated
in Drupal 8.0.x-dev, will be removed before Drupal 9.0.0. Use UrlHelper::stripDangerousProtocols() or UrlHelper::filterBadProtocol() instead. UrlHelper::stripDangerousProtocols() can be used in conjunction with \Drupal\Component\Utility\SafeMarkup::format() and an @variable placeholder which will perform the necessary escaping. UrlHelper::filterBadProtocol() is functionality equivalent to check_url() apart from the fact it is protected from double escaping bugs. Note that this method no longer marks its output as safe.
See also
\Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
\Drupal\Component\Utility\UrlHelper::filterBadProtocol()
Related topics
1 call to check_url()
- XssUnitTest::testBadProtocolStripping in core/
modules/ system/ src/ Tests/ Common/ XssUnitTest.php - Checks that harmful protocols are stripped.
File
- core/
includes/ common.inc, line 225 - Common functions that many Drupal modules will need to reference.
Code
function check_url($uri) {
return Html::escape(UrlHelper::stripDangerousProtocols($uri));
}