WordPress.org

Make WordPress Core

Changeset 39638


Ignore:
Timestamp:
12/27/2016 09:20:11 AM (17 months 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:
12 edited

Legend:

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

    r39600 r39638  
    183183 * If the author has a home page set, return an HTML link, otherwise just return the
    184184 * author's name.
     185 *
     186 * @since 3.0.0
    185187 *
    186188 * @return string|null An HTML link if the author's url exist in user meta,
     
    503505 * Helper function to clear the cache for number of authors.
    504506 *
     507 * @since 3.2.0
     508 *
    505509 * @private
    506510 */
  • trunk/src/wp-includes/category-template.php

    r39593 r39638  
    721721 * Default topic count scaling for tag links
    722722 *
    723  * @param int $count number of posts with that tag
    724  * @return int scaled count
     723 * @since 2.9.0
     724 *
     725 * @param int $count Number of posts with that tag.
     726 * @return int Scaled count.
    725727 */
    726728function default_topic_count_scale( $count ) {
  • trunk/src/wp-includes/functions.php

    r39323 r39638  
    19221922 * A non-filtered, non-cached version of wp_upload_dir() that doesn't check the path.
    19231923 *
     1924 * @since 4.5.0
    19241925 * @access private
    19251926 *
     
    51095110 * Test if a given path is a stream URL
    51105111 *
     5112 * @since 3.5.0
     5113 *
    51115114 * @param string $path The resource path or URL.
    51125115 * @return bool True if the path is a stream URL.
  • trunk/src/wp-includes/general-template.php

    r39326 r39638  
    809809     * Filters the site icon URL.
    810810     *
    811      * @site 4.4.0
     811     * @since 4.4.0
    812812     *
    813813     * @param string $url     Site icon URL.
  • trunk/src/wp-includes/kses.php

    r38785 r39638  
    14501450 * numeric entities in hex form.
    14511451 *
     1452 * @since 2.7.0
    14521453 * @access private
    14531454 *
     
    14651466/**
    14661467 * Helper function to determine if a Unicode value is valid.
     1468 *
     1469 * @since 2.7.0
    14671470 *
    14681471 * @param int $i Unicode value
     
    14981501 * Regex callback for wp_kses_decode_entities()
    14991502 *
     1503 * @since 2.9.0
     1504 *
    15001505 * @param array $match preg match
    15011506 * @return string
     
    15071512/**
    15081513 * Regex callback for wp_kses_decode_entities()
     1514 *
     1515 * @since 2.9.0
    15091516 *
    15101517 * @param array $match preg match
  • trunk/src/wp-includes/media.php

    r39612 r39638  
    10451045    /**
    10461046     * Let plugins pre-filter the image meta to be able to fix inconsistencies in the stored data.
     1047     *
     1048     * @since 4.5.0
    10471049     *
    10481050     * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
  • trunk/src/wp-includes/ms-functions.php

    r39323 r39638  
    22432243 *  Update the network-wide counts for the current network.
    22442244 *
    2245  *  @since 3.1.0
     2245 * @since 3.1.0
    22462246 */
    22472247function wp_update_network_counts() {
  • trunk/src/wp-includes/nav-menu.php

    r38928 r39638  
    9797 * Unregisters a navigation menu location for a theme.
    9898 *
     99 * @since 3.1.0
    99100 * @global array $_wp_registered_nav_menus
    100101 *
  • trunk/src/wp-includes/rest-api.php

    r39400 r39638  
    988988/**
    989989 * Validate a value based on a schema.
     990 *
     991 * @since 4.7.0
    990992 *
    991993 * @param mixed  $value The value to validate.
     
    11111113 * Sanitize a value based on a schema.
    11121114 *
     1115 * @since 4.7.0
     1116 *
    11131117 * @param mixed $value The value to sanitize.
    11141118 * @param array $args  Schema array to use for sanitization.
  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

    r39621 r39638  
    15181518     * "Protected: %s", as the REST API communicates the protected status of a post
    15191519     * in a machine readable format, we remove the "Protected: " prefix.
     1520     *
     1521     * @since 4.7.0
    15201522     *
    15211523     * @return string Protected title format.
  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php

    r39106 r39638  
    306306     * provide a wrapper sanitizer to whitelist the use of `null`.
    307307     *
     308     * @since 4.7.0
     309     *
    308310     * @param  mixed           $value   The value for the setting.
    309311     * @param  WP_REST_Request $request The request object.
  • trunk/src/wp-includes/vars.php

    r38468 r39638  
    121121 * Test if the current browser runs on a mobile device (smart phone, tablet, etc.)
    122122 *
     123 * @since 3.4.0
     124 *
    123125 * @return bool
    124126 */
Note: See TracChangeset for help on using the changeset viewer.