IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Options, Meta APIs: Correct the documented return type for get_settings_errors().

Browse Source 
This function returns an array of settings errors arrays.

Props mcaskill, costdev

Fixes #57323

Built from https://develop.svn.wordpress.org/trunk@54963


git-svn-id: http://core.svn.wordpress.org/trunk@54515 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2022-12-13 16:39:11 +00:00
parent 58cde838c1
commit 0d5910247a
2 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
wp-admin/includes/template.php
View File

@ -1846,15 +1846,19 @@ function add_settings_error( $setting, $code, $message, $type = 'error' ) {
* *
* @param string $setting Optional. Slug title of a specific setting whose errors you want. * @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. * @param bool $sanitize Optional. Whether to re-sanitize the setting value before returning errors.
* @return array { * @return array[] {
* Array of settings errors. * Array of settings error arrays.
* *
* @type string $setting Slug title of the setting to which this error applies. * @type array ...$0 {
* @type string $code Slug-name to identify the error. Used as part of 'id' attribute in HTML output. * Associative array of setting error data.
* @type string $message The formatted message text to display to the user (will be shown inside styled *
* `<div>` and `<p>` tags). * @type string $setting Slug title of the setting to which this error applies.
* @type string $type Optional. Message type, controls HTML class. Possible values include 'error', * @type string $code Slug-name to identify the error. Used as part of 'id' attribute in HTML output.
* 'success', 'warning', 'info'. Default 'error'. * @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 ) { function get_settings_errors( $setting = '', $sanitize = false ) {

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.2-alpha-54962'; $wp_version = '6.2-alpha-54963';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.