[手册]Wordpress 函数参考(Function Reference)

8、Fomatting Functions 格式化函数

add_magic_quotes <?php add_magic_quotes( $array ) ?>: 过滤内容时访问数组中的每一个元素。
addslashes_gpc <?php addslashes_gpc( $gpc ) ?>: 添加斜线以避免使用字符串。
antispambot <?php antispambot( $emailaddy, $mailto ) ?>: 将电子邮件地址的字符转换为HTML实体以阻止广告机器人.
attribute_escape <?php echo attribute_escape($text); ?>: 在HTML属性中，该函数对特定HTML字符（包括单引号和双引号）进行字符转义或将这些字符译为计算机语言。该函数工作方式类似于标准的PHP函数 htmlspecialchars，唯一不同在于该函数不会对HTML实体进行双重编码（例如，该函数用 &&代替&&）。(已弃用)
backslashit <?php backslashit( $string ) ?>: 在字母和字符串首的数字前添加反斜线符号。
balanceTags <?php balanceTags( $text, $force ) ?>: 函数仅在被要求以及选项被设为校正标签时会对标签进行自动校正。
clean_pre <?php clean_pre( $matches ) ?>: 该函数接收来自wpautop()中 preg_replace_callback 的匹配数组或字符串。确保 <pre>...</pre> HTML块中的内容没有转换成段落或分行符。
clean_url <?php clean_url( $url, $protocols, $context ) ?>: 查看并过滤URL。URL中若干字符被删除。如果URL用于在文本中显示链接地址，URL中的&号也会被替换。clean_url对返回的已过滤URL进行再次过滤。(已弃用)
convert_chars <?php convert_chars( $content, $deprecated ) ?>: 将字符串转换为一系列字符。该函数移除Metadata标签<title> 和<category>，将 <br> 和<hr>转换为相应的XHTML，将统一码字符转换为可用值。
convert_smilies <?php convert_smilies( $text ) ?>: 将文本中的表情符号转换为表情图像。只在选项'use_smilies'为true，且函数中的全局变量不为空时转换表情符号。
ent2ncr <?php ent2ncr( $text ) ?>: 将名称实体转换为数值型实体.
esc_attr <?php esc_attr( $text ) ?>: 编码< > & " '为实体。
force_balance_tags <?php force_balance_tags( $text ) ?>: 用改进的堆栈自动校正字符串标签。忽略'use_balanceTags'选项。
format_to_edit <?php format_to_edit( $content, $richedit ) ?>: 处理将要被编辑的文本。$richedit未赋值时只是一个存储“format_to_edit”过滤器的文件夹。如果$richedit被设为true，那么 htmlspecialchars会在文本上运行并将特定字符转换为 HTML实体。
format_to_post <?php format_to_post( $content ) ?>: 保存'format_to_post' 过滤器。
funky_javascript_fix <?php funky_javascript_fix( $text ) ?: 修正浏览器中的JavaScript错误。将统一码字符转换为 HTML数值实体。
htmlentities2 <?php htmlentities2( $myHTML ) ?>: 转换字符实体，保留已经被编码的字符实体。
is_email <?php is_email( $email, $check_dns ) ?>: 合适email是否有效。
js_escape <?php js_escape( $text ) ?>: 转义单引号，转换双引号，改正行结束符号。也可使用过滤器'js_escape' 。
make_clickable <?php make_clickable( $ret ) ?>: 将普通文本URL转换成HTML链接。可以转换URL，www，ftp和电子邮件地址等。
popuplinks <?php popuplinks( $text ) ?>: 为所有HTML的anchor标签添加 target='_blank' and rel='external'代码，以在新窗口中打开链接。该函数可过滤弹出窗口中的注释文本。目前该函数没有多大用途，但在理想情况下它可以判断目标或rel属性是否存在并相应调整操作。
remove_accents <?php remove_accents( $string ) ?>: 将所有重音字符转换为ASCII字符。如果没有重音字符，返回所给字符串。
sanitize_email <?php sanitize_email( $email ) ?>: 过滤邮件中不允许出现的字符。
sanitize_file_name <?php sanitize_file_name( $name ) ?>: 过滤文件名中的特定字符串。删除所有字符串，只保留以空格、破折号以及时间隔开的字母数字式字符串，将所有字符串转换为小写状态。所有空格和下划线都被转换为破折号。将多个破折号转换为单一破折号。删除名称以破折号结尾的文件。
sanitize_user <?php sanitize_user( $username, $strict ) ?>: 消除用户名中的不安全字符。若$strict参数为true，则返回添加了_, space, ., -, *, 以及 @的字母数字式字符。该函数删除所有标签，XX以及实体，如果$strict参数被激活，该函数删除所有非ASCII字符。清理用户名后，该函数将用户名、原始用户名（参数中的用户名）以及$strict参数作为过滤器参数。
sanitize_title <?php sanitize_title( $title, $fallback_title ) ?>: 检查标题或使用备用标题。特别要说明的是， HTML 和PHP标签都会被忽略。可以通过插件API来添加下一步动作。若$title为空且已设置$fallback_title，函数会使用后者。
sanitize_title_with_dashes <?php sanitize_title_with_dashes( $title ) ?>: 检查标题，用破折号代替空格。输出结果仅限于字母数字字符、下划线（_）和破折号（-）。空格将被替换为破折号。
seems_utf8 <?php seems_utf8( $Str ) ?>: 检查是否有urf8编码格式的字符串。
stripslashes_deep <?php stripslashes_deep( $value ) ?>: 该函数通过数组进行导航，删除函数值中的斜线。数组被传递后，array_map()函数引发回调，将值回传给stripslashes_deep()函数。stripslashes()函数删除值中的斜线。
trailingslashit <?php trailingslashit( $string ) ?>: 添加结尾斜线。添加前删除已有的结尾斜线，防止字符串或路径出现双斜线。该函数主要用于路径，也只应该用于路径。函数对路径没有特别限制，也不为路径提供特别支持。
untrailingslashit <?php untrailingslashit( $string ) ?>: 删除已有的结尾斜线。
该函数主要用于路径，也只应该用于路径。函数对路径没有特别限制，也不为路径提供特别支持。
utf8_uri_encode <?php utf8_uri_encode( $utf8_string, $length ) ?>: 为URI中使用的统一码值进行编码。
wpautop <?php wpautop( $pee, $br = 1 ); ?>: 将文本中的成对换行符换成HTML段落符号(<p>...</p>)，WordPress使用该函数来过滤文章内容和摘要。
wptexturize <?php wptexturize(); ?>: 返回一些转换的字符串。
wp_filter_kses <?php wp_filter_kses( $data ) ?>: 过滤带有合法 HTMLKses规则的文本。
wp_filter_post_kses <?php wp_filter_post_kses( $data ) ?>: 在日志正文中检查含有合法HTML标签的文本。日志正文指类型为“日志（post）”的页面内容，而非表格中的 $_POST数据。
wp_filter_nohtml_kses <?php wp_filter_nohtml_kses( $data ) ?>: 删除文本中的所有 HTML。
wp_iso_descrambler <?php wp_iso_descrambler( $string ) ?>: 将电子邮件主题转换为 ASCII码。
wp_kses <?php wp_kses($string, $allowed_html, $allowed_protocols); ?>: 该函数确保在$string中只出现经许可的HTML元素名称、属性名称和属性值以及有意义的HTML实体。调用该函数前需要删除PHP魔术引号中的斜线。
wp_kses_array_lc <?php wp_kses_array_lc( $inarray ) ?>: 该函数遍历某数组并将其中的密码改为小写状态。
wp_kses_attr <?php wp_kses_attr( $element, $attr, $allowed_html, $allowed_protocols ) ?>: 该函数删除元素不允许的所有属性。若某些属性得到许可，函数调用 wp_kses_hair()进一步分裂这些属性，并利用 wp_kses_hair()返回的信息创建新的HTML代码。该函数删除剩余的'<' and '>'字符。此外该函数还负责检查标签是否具有XHTML结尾斜线，如果有，函数会在返回的代码中也添加结尾斜线。
wp_kses_bad_protocol <?php wp_kses_bad_protocol( $string, $allowed_protocols ) ?>: 过滤bad protocol中的字符串。该函数在$string开始时，删除所有不被允许的protocol。函数可以忽略空格和字母大小写的差异，同时可以识别HTML实体。函数在while循环中工作，因此不会被类似'javascript:javascript:alert(57)'的字符串欺骗。
wp_kses_bad_protocol_once <?php wp_kses_bad_protocol_once( $string, $allowed_protocols ) ?>: 过滤文本中的bad protocol和其它字符。该函数在处理空格符和HTML实体时，在$string的开始部分查找URL protocol（协议）。
wp_kses_bad_protocol_once2 <?php wp_kses_bad_protocol_once2( $matches ) ?>: 该函数接收来自wpautop()中 preg_replace_callback 的匹配数组或字符串。确保 <pre>...</pre> HTML块中的内容没有转换成段落或分行符。
wp_kses_check_attr_val <?php wp_kses_check_attr_val( $value, $vless, $checkname, $checkvalue ) ?>: 该函数为属性值执行不同查询。目前可执行的查询包括'maxlen', 'minlen', 'maxval', 'minval' 以及 'valueless'，将来可能会支持更多可执行查询。
wp_kses_decode_entities <?php wp_kses_decode_entities( $string ) ?>: 该函数将所有实体转换为与之相对应的字符。该函数为数值型HTML实体（如A 与 A）解码。函数不处理ä等其它实体，但我们在URL protocol白名单中也不需要这类实体。
wp_kses_hair <?php wp_kses_hair( $attr, $allowed_protocols ) ?>: 该函数从含有属性的字符串中建立一个属性列表。该函数可有多种用途。首先该函数将属性列表解析为一个带有属性信息的数组，之后即使接收到怪异的输入内容也会尽量保持正确操作。其次该函数会为没有引号或撇号的属性值添加引号，以便更轻松地生成符合W3C HTML标准的HTML代码。此外该函数还可以删除属性值中的坏链协议，利用之前定义的属性（(foo='bar' foo='baz' will result in foo='bar')）减少重复属性。
wp_kses_hook <?php wp_kses_hook( $string, $allowed_html, $allowed_protocols ) ?>: 可在此处添加任何kses（用PHP编写的HTML过滤器）钩子。目前WordPress中只有一个kses 钩子，于是系统会在wp_kses_hook中调用这个钩子。所有参数都被传递到kses钩子，期望返回字符串。
wp_kses_html_error <?php wp_kses_html_error( $string ) ?>: 该函数处理wp_kses_hair中的错误解析。通常该函数会删除所有内容，只保留一些空格，函数也可以处理引号和撇号。
wp_kses_js_entities <?php wp_kses_js_entities( $string ) ?>: 该函数删除Netscape 4早期版本中的HTMLJavaScript实体。
wp_kses_no_null <?php wp_kses_no_null( $string ) ?>: 删除$string中的NULL字符。
wp_kses_normalize_entities <?php wp_kses_normalize_entities( $string ) ?>: 转换并修正HTML实体。该函数统一HTML字符，使之正规化。函数将"AT&T"转换为"AT&T"，将 ":"转换为 ":"，将"&#XYZZY;" 转换为 "&#XYZZY;"等等。
wp_kses_normalize_entities2 <?php wp_kses_normalize_entities2( $matches ) ?>: 为正则表达式 wp_kses_normalize_entities()进行回调。该函数使wp_kses_normalize_entities()只支持16位值以及 &#number; 实体。
wp_kses_split <?php wp_kses_split( $string, $allowed_html, $allowed_protocols ) ?>: 查找HTML标签，无论格式是否被破坏。该函数还可以为单个“>”字符配对。
wp_kses_split2 <?php wp_kses_split2( $string, $allowed_html, $allowed_protocols ) ?>: 回调 wp_kses_split()，修复损坏的HTML标签。该函数进行大量工作。wp_kses_split2()拒绝<:::>等不完整字符。如果某个元素不允许出现，wp_kses_split2()返回空字符。否则wp_kses_split2()会将标签拆分为一个元素和一个属性列表。标签被拆分后会运行另一个过滤器函数，这个过滤器函数能够删除所有非法属性。
wp_kses_stripslashes <?php wp_kses_stripslashes( $string ) ?>: 删除引号前的斜线。该函数将字符顺序 \" 改为 "。该函数不干涉其它位置上的斜线，但preg_replace(//e)例外。
wp_kses_version <?php wp_kses_version() ?>: 该函数返回kses的版本号。
wp_make_link_relative <?php wp_make_link_relative( $link ) ?>: 将完整URL路径转换成绝对路径。删除http或https以及域名。保留URL开始部分的“/”，URL不是完全的相对链接，只是web根目录下的链接。
wp_rel_nofollow <?php wp_rel_nofollow( $text ) ?>: 为文本中所有HTML实体元素A添加字符串rel="nofollow"。
wp_richedit_pre <?php wp_richedit_pre( $text ) ?>: 为富文本编辑器中的文本进行排版。
使用过滤器函数'richedit_pre'。如果 $text为空，过滤器函数可用于空字符串。
wp_specialchars <?php wp_specialchars( $text, $quotes ) ?>: 将若干特定字符转换成HTML实体字符。这与 htmlspecialchars有所不同，因为已有HTML实体字符不会被编码。特别注意要将 &转换为 &， < 转换为< 以及 > 转换为 >。对' to '进行编码时，可以将$quotes设为'single'；对" to " 进行编码时则设为'double'；对两者同时编码时，则设为'1'。默认值为0，不对引号进行编码。
zeroise <?php zeroise( $number, $threshold ) ?>: 必要时添加前导符零。如果将阈值设为'4'，数字为'10'，将返回'0010'。如果将阈值设为'4'，数字为'5000'，返回'5000'。该函数在$threshold参数以及数字大小的基础上用sprintf来添加零的个数。数字足够大时无需添加零。