函数文档

form_option()

💡 云策文档标注

概述

form_option() 是一个 WordPress 函数,用于在表单中安全地输出选项值。它通过调用 get_option() 获取选项值,并使用 esc_attr() 进行转义,以防止 XSS 攻击。

关键要点

  • 函数功能:打印经过转义的选项值,适用于表单字段如 input 的 value 属性。
  • 参数:$option(必需),字符串类型,指定要获取的选项名称。
  • 内部实现:调用 get_option($option) 获取值,然后使用 esc_attr() 进行 HTML 属性转义。
  • 相关函数:esc_attr() 用于 HTML 属性转义,get_option() 用于检索选项值。
  • 版本历史:自 WordPress 1.5.0 版本引入。

📄 原文内容

Prints option value after sanitizing for forms.

Parameters

$optionstringrequired
Option name.

Source

function form_option( $option ) {
	echo esc_attr( get_option( $option ) );
}

Changelog

Version Description
1.5.0 Introduced.