From 0d5910247a38badcc34453d108fa51bc70bed005 Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Tue, 13 Dec 2022 16:39:11 +0000 Subject: [PATCH] Options, Meta APIs: Correct the documented return type for `get_settings_errors()`. 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 --- wp-admin/includes/template.php | 20 ++++++++++++-------- wp-includes/version.php | 2 +- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/wp-admin/includes/template.php b/wp-admin/includes/template.php index 6dc7cc931f..4dfddbdf99 100644 --- a/wp-admin/includes/template.php +++ b/wp-admin/includes/template.php @@ -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 bool $sanitize Optional. Whether to re-sanitize the setting value before returning errors. - * @return array { - * Array of settings errors. + * @return array[] { + * Array of settings error arrays. * - * @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 - * `
` and `

` tags). - * @type string $type Optional. Message type, controls HTML class. Possible values include 'error', - * 'success', 'warning', 'info'. Default 'error'. + * @type array ...$0 { + * Associative array of setting error data. + * + * @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 + * `

` and `

` 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 ) { diff --git a/wp-includes/version.php b/wp-includes/version.php index 1a60a49dec..14304a382f 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -16,7 +16,7 @@ * * @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.