Changeset 54963 for trunk/src/wp-admin/includes/template.php

Timestamp:

12/13/2022 04:37:36 PM (2 years ago)

Author:

johnbillion

Message:

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

File:

• trunk/src/wp-admin/includes/template.php (modified) (1 diff)

trunk/src/wp-admin/includes/template.php

@@ -1847 +1847 @@
  * @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.
- *
- *     @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'.
+ * @return array[] {
+ *     Array of settings error arrays.
+ *
+ *     @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'.
+ *     }
  * }
  */