Changeset 39638

Timestamp:

12/27/2016 09:20:11 AM (8 years ago)

Author:

johnbillion

Message:

Docs: Add and correct @since docs for a variety of functions and methods.

Props keesiemeijer, chris_dev
Fixes #39343, #39357, #39344
See #39130

Location:

trunk/src/wp-includes

Files:

• author-template.php (modified) (2 diffs)
• category-template.php (modified) (1 diff)
• functions.php (modified) (2 diffs)
• general-template.php (modified) (1 diff)
• kses.php (modified) (4 diffs)
• media.php (modified) (1 diff)
• ms-functions.php (modified) (1 diff)
• nav-menu.php (modified) (1 diff)
• rest-api.php (modified) (2 diffs)
• rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (1 diff)
• rest-api/endpoints/class-wp-rest-settings-controller.php (modified) (1 diff)
• vars.php (modified) (1 diff)

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

@@ -183 +183 @@
  * If the author has a home page set, return an HTML link, otherwise just return the
  * author's name.
+ *
+ * @since 3.0.0
  *
  * @return string|null An HTML link if the author's url exist in user meta,
@@ -503 +505 @@
  * Helper function to clear the cache for number of authors.
  *
+ * @since 3.2.0
+ *
  * @private
  */

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

@@ -721 +721 @@
  * Default topic count scaling for tag links
  *
- * @param int $count number of posts with that tag
- * @return int scaled count
+ * @since 2.9.0
+ *
+ * @param int $count Number of posts with that tag.
+ * @return int Scaled count.
  */
 function default_topic_count_scale( $count ) {

trunk/src/wp-includes/functions.php

@@ -1922 +1922 @@
  * A non-filtered, non-cached version of wp_upload_dir() that doesn't check the path.
  *
+ * @since 4.5.0
  * @access private
  *
@@ -5109 +5110 @@
  * Test if a given path is a stream URL
  *
+ * @since 3.5.0
+ *
  * @param string $path The resource path or URL.
  * @return bool True if the path is a stream URL.

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

@@ -809 +809 @@
      * Filters the site icon URL.
      *
-     * @site 4.4.0
+     * @since 4.4.0
      *
      * @param string $url     Site icon URL.

trunk/src/wp-includes/kses.php

@@ -1450 +1450 @@
  * numeric entities in hex form.
  *
+ * @since 2.7.0
  * @access private
  *
@@ -1465 +1466 @@
 /**
  * Helper function to determine if a Unicode value is valid.
+ *
+ * @since 2.7.0
  *
  * @param int $i Unicode value
@@ -1498 +1501 @@
  * Regex callback for wp_kses_decode_entities()
  *
+ * @since 2.9.0
+ *
  * @param array $match preg match
  * @return string
@@ -1507 +1512 @@
 /**
  * Regex callback for wp_kses_decode_entities()
+ *
+ * @since 2.9.0
  *
  * @param array $match preg match

trunk/src/wp-includes/media.php

@@ -1045 +1045 @@
     /**
      * Let plugins pre-filter the image meta to be able to fix inconsistencies in the stored data.
+     *
+     * @since 4.5.0
      *
      * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.

trunk/src/wp-includes/ms-functions.php

@@ -2243 +2243 @@
  *  Update the network-wide counts for the current network.
  *
- *  @since 3.1.0
+ * @since 3.1.0
  */
 function wp_update_network_counts() {

trunk/src/wp-includes/nav-menu.php

@@ -97 +97 @@
  * Unregisters a navigation menu location for a theme.
  *
+ * @since 3.1.0
  * @global array $_wp_registered_nav_menus
  *

trunk/src/wp-includes/rest-api.php

@@ -988 +988 @@
 /**
  * Validate a value based on a schema.
+ *
+ * @since 4.7.0
  *
  * @param mixed  $value The value to validate.
@@ -1111 +1113 @@
  * Sanitize a value based on a schema.
  *
+ * @since 4.7.0
+ *
  * @param mixed $value The value to sanitize.
  * @param array $args  Schema array to use for sanitization.

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -1518 +1518 @@
      * "Protected: %s", as the REST API communicates the protected status of a post
      * in a machine readable format, we remove the "Protected: " prefix.
+     *
+     * @since 4.7.0
      *
      * @return string Protected title format.

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php

@@ -306 +306 @@
      * provide a wrapper sanitizer to whitelist the use of `null`.
      *
+     * @since 4.7.0
+     *
      * @param  mixed           $value   The value for the setting.
      * @param  WP_REST_Request $request The request object.

trunk/src/wp-includes/vars.php

@@ -121 +121 @@
  * Test if the current browser runs on a mobile device (smart phone, tablet, etc.)
  *
+ * @since 3.4.0
+ * 
  * @return bool
  */