Changeset 46880

Timestamp:

12/11/2019 10:57:44 AM (4 years ago)

Author:

SergeyBiryukov

Message:

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

Props grapplerulrich.
Fixes #48932.

File:

• trunk/src/wp-admin/includes/dashboard.php (modified) (7 diffs)

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

@@ -1472 +1472 @@
 
 /**
- * Display the WordPress events and news feeds.
+ * Displays the WordPress events and news feeds.
  *
  * @since 3.8.0
@@ -1490 +1490 @@
 
 /**
- * Display file upload quota on dashboard.
+ * Displays file upload quota on dashboard.
  *
  * Runs on the {@see 'activity_box_end'} hook in wp_dashboard_right_now().
@@ -1554 +1554 @@
 }
 
-// Display Browser Nag Meta Box
+/**
+ * Displays the browser update nag.
+ *
+ * @since 3.2.0
+ */
 function wp_dashboard_browser_nag() {
     $notice   = '';
@@ -1612 +1616 @@
 
 /**
+ * Adds an additional class to the browser nag if the current version is insecure.
+ *
  * @since 3.2.0
  *
- * @param array $classes
- * @return array
+ * @param string[] $classes Array of meta box classes.
+ * @return string[] Modified array of meta box classes.
  */
 function dashboard_browser_nag_class( $classes ) {
@@ -1628 +1634 @@
 
 /**
- * Check if the user needs a browser update
+ * Checks if the user needs a browser update.
  *
  * @since 3.2.0
  *
- * @return array|bool False on failure, array of browser data on success.
+ * @return array|bool Array of browser data on success, false on failure.
  */
 function wp_check_browser_version() {
@@ -1732 +1738 @@
  * @since 5.1.0
  *
- * @param string[] $classes Array of metabox classes.
- * @return string[] Modified array of metabox classes.
+ * @param string[] $classes Array of meta box classes.
+ * @return string[] Modified array of meta box classes.
  */
 function dashboard_php_nag_class( $classes ) {
@@ -1747 +1753 @@
 /**
  * Empty function usable by plugins to output empty dashboard widget (to be populated later by JS).
+ *
+ * @since 2.5.0
  */
 function wp_dashboard_empty() {}