WordPress.org

Make WordPress Core

Changeset 46880


Ignore:
Timestamp:
12/11/2019 10:57:44 AM (8 months ago)
Author:
SergeyBiryukov
Message:

Docs: Improve documentation for wp_dashboard_browser_nag() and dashboard_browser_nag_class().

Props grapplerulrich.
Fixes #48932.

File:
1 edited

Legend:

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

    r46770 r46880  
    14721472
    14731473/**
    1474  * Display the WordPress events and news feeds.
     1474 * Displays the WordPress events and news feeds.
    14751475 *
    14761476 * @since 3.8.0
     
    14901490
    14911491/**
    1492  * Display file upload quota on dashboard.
     1492 * Displays file upload quota on dashboard.
    14931493 *
    14941494 * Runs on the {@see 'activity_box_end'} hook in wp_dashboard_right_now().
     
    15541554}
    15551555
    1556 // Display Browser Nag Meta Box
     1556/**
     1557 * Displays the browser update nag.
     1558 *
     1559 * @since 3.2.0
     1560 */
    15571561function wp_dashboard_browser_nag() {
    15581562    $notice   = '';
     
    16121616
    16131617/**
     1618 * Adds an additional class to the browser nag if the current version is insecure.
     1619 *
    16141620 * @since 3.2.0
    16151621 *
    1616  * @param array $classes
    1617  * @return array
     1622 * @param string[] $classes Array of meta box classes.
     1623 * @return string[] Modified array of meta box classes.
    16181624 */
    16191625function dashboard_browser_nag_class( $classes ) {
     
    16281634
    16291635/**
    1630  * Check if the user needs a browser update
     1636 * Checks if the user needs a browser update.
    16311637 *
    16321638 * @since 3.2.0
    16331639 *
    1634  * @return array|bool False on failure, array of browser data on success.
     1640 * @return array|bool Array of browser data on success, false on failure.
    16351641 */
    16361642function wp_check_browser_version() {
     
    17321738 * @since 5.1.0
    17331739 *
    1734  * @param string[] $classes Array of metabox classes.
    1735  * @return string[] Modified array of metabox classes.
     1740 * @param string[] $classes Array of meta box classes.
     1741 * @return string[] Modified array of meta box classes.
    17361742 */
    17371743function dashboard_php_nag_class( $classes ) {
     
    17471753/**
    17481754 * Empty function usable by plugins to output empty dashboard widget (to be populated later by JS).
     1755 *
     1756 * @since 2.5.0
    17491757 */
    17501758function wp_dashboard_empty() {}
Note: See TracChangeset for help on using the changeset viewer.