Docs: Document the return value of `get_settings_errors()` using hash notation.
Props stevenlinx, webdevmattcrom, atachibana. Fixes #42786. Built from https://develop.svn.wordpress.org/trunk@48760 git-svn-id: http://core.svn.wordpress.org/trunk@48522 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
parent
649ab58d96
commit
132942b9fa
|
@ -1797,7 +1797,16 @@ function add_settings_error( $setting, $code, $message, $type = 'error' ) {
|
|||
*
|
||||
* @param string $setting Optional. Slug title of a specific setting whose errors you want.
|
||||
* @param bool $sanitize Optional. Whether to re-sanitize the setting value before returning errors.
|
||||
* @return array Array of settings errors.
|
||||
* @return array {
|
||||
* Array of settings errors.
|
||||
*
|
||||
* @type string $setting Slug title of the setting to which this error applies.
|
||||
* @type string $code Slug-name to identify the error. Used as part of 'id' attribute in HTML output.
|
||||
* @type string $message The formatted message text to display to the user (will be shown inside styled
|
||||
* `<div>` and `<p>` tags).
|
||||
* @type string $type Optional. Message type, controls HTML class. Possible values include 'error',
|
||||
* 'success', 'warning', 'info'. Default 'error'.
|
||||
* }
|
||||
*/
|
||||
function get_settings_errors( $setting = '', $sanitize = false ) {
|
||||
global $wp_settings_errors;
|
||||
|
|
|
@ -13,7 +13,7 @@
|
|||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '5.6-alpha-48758';
|
||||
$wp_version = '5.6-alpha-48760';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
|
Loading…
Reference in New Issue