vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-07-01 07:40:07 +00:00
Code Issues Actions 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


git-svn-id: https://develop.svn.wordpress.org/trunk@54963 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2022-12-13 16:37:36 +00:00
parent d5ef1d8fc4
commit d18ab9906b
1 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/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 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
* `<div>` and `<p>` 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
* `<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 ) {