WordPress.org

Make WordPress Core


Ignore:
Timestamp:
05/02/2016 03:59:56 AM (5 years ago)
Author:
DrewAPicture
Message:

Docs: Remove inline @see tags from function, class, and method references in inline docs.

Known functions, classes, and methods are now auto-linked in Code Reference pages following #meta1483.

Note: Hook references are still linked via inline @see tags due to the unlikelihood of reliably matching for known hooks based on a RegEx pattern.

See #32246.

File:
1 edited

Legend:

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

    r37330 r37342  
    14291429
    14301430/**
    1431  * Display settings errors registered by {@see add_settings_error()}.
     1431 * Display settings errors registered by add_settings_error().
    14321432 *
    14331433 * Part of the Settings API. Outputs a div for each error retrieved by
    1434  * {@see get_settings_errors()}.
     1434 * get_settings_errors().
    14351435 *
    14361436 * This is called automatically after a settings page based on the
    14371437 * Settings API is submitted. Errors should be added during the validation
    1438  * callback function for a setting defined in {@see register_setting()}
    1439  *
    1440  * The $sanitize option is passed into {@see get_settings_errors()} and will
     1438 * callback function for a setting defined in register_setting().
     1439 *
     1440 * The $sanitize option is passed into get_settings_errors() and will
    14411441 * re-run the setting sanitization
    14421442 * on its current value.
     
    14521452 * @param string $setting        Optional slug title of a specific setting who's errors you want.
    14531453 * @param bool   $sanitize       Whether to re-sanitize the setting value before returning errors.
    1454  * @param bool   $hide_on_update If set to true errors will not be shown if the settings page has already been submitted.
     1454 * @param bool   $hide_on_update If set to true errors will not be shown if the settings page has
     1455 *                               already been submitted.
    14551456 */
    14561457function settings_errors( $setting = '', $sanitize = false, $hide_on_update = false ) {
Note: See TracChangeset for help on using the changeset viewer.