WordPress 常用函数 / esc_url

Denis | 邓鸿华 函数参考 2514 2013年01月21日

简介

主要用于 URL 过滤：

  1. 拒绝不是下面协议的 URL （defaulting to http, https, ftp, ftps, mailto, news, irc, gopher, nntp, feed, and telnet）
  2. 消除无效字符和删除危险字符。
  3. 将字符转换成 HTML 实体，并且将 &#038 和 单引号（&#039） 转换成数字实体：&#038, &#039。

用法

<?php esc_url( $url, $protocols, $_context ); ?>

参数

$url
(string) (required) 将要被清理过滤的 URL
Default: 无

$protocols
(array) (optional) 可以接受协议的数组，如果没有设置，默认是：'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet'。
Default: 无

$_context
(string) (optional) 如何返回 URL。
Default: 'display'

返回值

(string)
已经清理过滤的 URL

注解

  • 开发者可以通过 cleaned_url 这个 filter 接口对返回 $url 进行再次过滤。

修改记录

Since: 2.8

源文件

wp-includes/formatting.php