WordPress.org

Make WordPress Core

Changeset 48760


Ignore:
Timestamp:
08/08/2020 12:37:03 PM (10 months ago)
Author:
SergeyBiryukov
Message:

Docs: Document the return value of get_settings_errors() using hash notation.

Props stevenlinx, webdevmattcrom, atachibana.
Fixes #42786.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/template.php

    r48620 r48760  
    17981798 * @param string $setting  Optional. Slug title of a specific setting whose errors you want.
    17991799 * @param bool   $sanitize Optional. Whether to re-sanitize the setting value before returning errors.
    1800  * @return array Array of settings errors.
     1800 * @return array {
     1801 *     Array of settings errors.
     1802 *
     1803 *     @type string $setting Slug title of the setting to which this error applies.
     1804 *     @type string $code    Slug-name to identify the error. Used as part of 'id' attribute in HTML output.
     1805 *     @type string $message The formatted message text to display to the user (will be shown inside styled
     1806 *                           `<div>` and `<p>` tags).
     1807 *     @type string $type    Optional. Message type, controls HTML class. Possible values include 'error',
     1808 *                           'success', 'warning', 'info'. Default 'error'.
     1809 * }
    18011810 */
    18021811function get_settings_errors( $setting = '', $sanitize = false ) {
Note: See TracChangeset for help on using the changeset viewer.