wp_required_field_message()
云策文档标注
概述
wp_required_field_message() 函数用于生成一个解释表单必填字段的消息,返回包含文本和指示符的 span 标签。该函数从 WordPress 6.1.0 版本引入,并可通过过滤器进行自定义。
关键要点
- 函数返回一个字符串,包含翻译后的消息和 wp_required_field_indicator() 生成的指示符,用 span 标签包裹。
- 提供 wp_required_field_message 过滤器,允许开发者修改消息内容。
- 函数内部使用 __() 进行国际化翻译,确保消息可本地化。
- 相关函数包括 wp_required_field_indicator()、__() 和 apply_filters(),用于指示符生成、翻译和过滤器应用。
- 该函数被多个 WordPress 核心函数调用,如 wp_media_insert_url_form() 和 comment_form(),用于表单界面。
代码示例
function wp_required_field_message() {
$message = sprintf(
'%s',
/* translators: %s: Asterisk symbol (*). */
sprintf( __( 'Required fields are marked %s' ), wp_required_field_indicator() )
);
/**
* Filters the message to explain required form fields.
*
* @since 6.1.0
*
* @param string $message Message text and glyph wrapped in a `span` tag.
*/
return apply_filters( 'wp_required_field_message', $message );
}
原文内容
Creates a message to explain required form fields.
Source
function wp_required_field_message() {
$message = sprintf(
'<span class="required-field-message">%s</span>',
/* translators: %s: Asterisk symbol (*). */
sprintf( __( 'Required fields are marked %s' ), wp_required_field_indicator() )
);
/**
* Filters the message to explain required form fields.
*
* @since 6.1.0
*
* @param string $message Message text and glyph wrapped in a `span` tag.
*/
return apply_filters( 'wp_required_field_message', $message );
}
Hooks
- apply_filters( ‘wp_required_field_message’, string $message )
-
Filters the message to explain required form fields.
Changelog
| Version | Description |
|---|---|
| 6.1.0 | Introduced. |