WordPress.org

Make WordPress Core

Changeset 42678


Ignore:
Timestamp:
02/09/2018 04:54:58 PM (22 months ago)
Author:
johnbillion
Message:

Docs: Add missing code formatting to various @since entries.

See #42505

Location:
trunk/src
Files:
15 edited

Legend:

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

    r42648 r42678  
    220220     *
    221221     * @since 2.8.0
    222      * @since 4.9.0 Adds $plugin param.
     222     * @since 4.9.0 Added the `$plugin` parameter.
    223223     *
    224224     * @param string $plugin Plugin file.
     
    340340 * @param array $args {
    341341 *     Args. Note that all of the arg values are already unslashed. They are, however,
    342  *     coming straight from $_POST and are not validated or sanitized in any way.
     342 *     coming straight from `$_POST` and are not validated or sanitized in any way.
    343343 *
    344344 *     @type string $file       Relative path to file.
  • trunk/src/wp-includes/class-wp-customize-manager.php

    r42648 r42678  
    241241     *
    242242     * @since 3.4.0
    243      * @since 4.7.0 Added $args param.
     243     * @since 4.7.0 Added `$args` parameter.
    244244     *
    245245     * @param array $args {
     
    16841684     *
    16851685     * @since 4.1.1
    1686      * @since 4.7.0 Added $args param and merging with changeset values and stashed theme mods.
     1686     * @since 4.7.0 Added `$args` parameter and merging with changeset values and stashed theme mods.
    16871687     *
    16881688     * @param array $args {
  • trunk/src/wp-includes/class-wp-roles.php

    r42343 r42678  
    7777     *
    7878     * @since 2.0.0
    79      * @since 4.9.0 The $site_id argument was added.
     79     * @since 4.9.0 The `$site_id` argument was added.
    8080     *
    8181     * @global array $wp_user_roles Used to set the 'roles' property value.
  • trunk/src/wp-includes/comment.php

    r42662 r42678  
    25952595 *
    25962596 * @since 1.5.0
    2597  * @since 4.7.0 $post_id can be a WP_Post object.
     2597 * @since 4.7.0 `$post_id` can be a WP_Post object.
    25982598 *
    25992599 * @global wpdb $wpdb WordPress database abstraction object.
     
    26742674 *
    26752675 * @since 0.71
    2676  * @since 4.7.0 $post_id can be a WP_Post object.
     2676 * @since 4.7.0 `$post_id` can be a WP_Post object.
    26772677 *
    26782678 * @param string $content Post content to check for links. If empty will retrieve from post.
  • trunk/src/wp-includes/functions.php

    r42648 r42678  
    232232     *
    233233     * @since 2.8.0
    234      * @since 4.9.0 The `$number` and `$decimals` arguments were added.
     234     * @since 4.9.0 The `$number` and `$decimals` parameters were added.
    235235     *
    236236     * @param string $formatted Converted number in string format.
     
    37133713 *
    37143714 * @since 3.0.0
    3715  * @since 4.7.0 Uses WP_List_Util class.
     3715 * @since 4.7.0 Uses `WP_List_Util` class.
    37163716 *
    37173717 * @param array       $list     An array of objects to filter
     
    37463746 *
    37473747 * @since 3.1.0
    3748  * @since 4.7.0 Uses WP_List_Util class.
     3748 * @since 4.7.0 Uses `WP_List_Util` class.
    37493749 *
    37503750 * @param array  $list     An array of objects to filter.
     
    37743774 * @since 3.1.0
    37753775 * @since 4.0.0 $index_key parameter added.
    3776  * @since 4.7.0 Uses WP_List_Util class.
     3776 * @since 4.7.0 Uses `WP_List_Util` class.
    37773777 *
    37783778 * @param array      $list      List of objects or arrays
     
    45764576 *
    45774577 * @since 3.0.0
    4578  * @since 4.9.0 The $network_id parameter has been added.
     4578 * @since 4.9.0 The `$network_id` parameter was added.
    45794579 *
    45804580 * @param int $site_id    Optional. Site ID to test. Defaults to current site.
  • trunk/src/wp-includes/http.php

    r42343 r42678  
    664664 *
    665665 * @since 4.4.0
    666  * @since 4.7.0 The $component parameter was added for parity with PHP's parse_url().
     666 * @since 4.7.0 The `$component` parameter was added for parity with PHP's `parse_url()`.
    667667 *
    668668 * @link https://secure.php.net/manual/en/function.parse-url.php
  • trunk/src/wp-includes/link-template.php

    r42400 r42678  
    37143714 *
    37153715 * @since 2.9.0
    3716  * @since 4.6.0 Adjusted to use wp_get_canonical_url().
     3716 * @since 4.6.0 Adjusted to use `wp_get_canonical_url()`.
    37173717 */
    37183718function rel_canonical() {
  • trunk/src/wp-includes/ms-blogs.php

    r42343 r42678  
    7676 *
    7777 * @since MU (3.0.0)
    78  * @since 4.7.0 Converted to use get_sites().
     78 * @since 4.7.0 Converted to use `get_sites()`.
    7979 *
    8080 * @param string $slug A site's slug.
  • trunk/src/wp-includes/ms-functions.php

    r42570 r42678  
    102102 *
    103103 * @since MU (3.0.0)
    104  * @since 4.8.0 The $network_id parameter has been added.
     104 * @since 4.8.0 The `$network_id` parameter has been added.
    105105 *
    106106 * @param int|null $network_id ID of the network. Default is the current network.
     
    117117 *
    118118 * @since MU (3.0.0)
    119  * @since 3.7.0 The $network_id parameter has been deprecated.
    120  * @since 4.8.0 The $network_id parameter is now being used.
     119 * @since 3.7.0 The `$network_id` parameter has been deprecated.
     120 * @since 4.8.0 The `$network_id` parameter is now being used.
    121121 *
    122122 * @param int|null $network_id ID of the network. Default is the current network.
     
    24642464 *
    24652465 * @since 3.1.0
    2466  * @since 4.8.0 The $network_id parameter has been added.
     2466 * @since 4.8.0 The `$network_id` parameter has been added.
    24672467 *
    24682468 * @param int|null $network_id ID of the network. Default is the current network.
     
    24802480 *
    24812481 * @since 3.7.0
    2482  * @since 4.8.0 The $network_id parameter has been added.
     2482 * @since 4.8.0 The `$network_id` parameter has been added.
    24832483 *
    24842484 * @param int|null $network_id ID of the network. Default is the current network.
     
    25112511 *
    25122512 * @since 3.7.0
    2513  * @since 4.8.0 The $network_id parameter has been added.
     2513 * @since 4.8.0 The `$network_id` parameter has been added.
    25142514 *
    25152515 * @param int|null $network_id ID of the network. Default is the current network.
     
    25302530 *
    25312531 * @since 3.7.0
    2532  * @since 4.8.0 The $network_id parameter has been added.
     2532 * @since 4.8.0 The `$network_id` parameter has been added.
    25332533 *
    25342534 * @param int|null $network_id ID of the network. Default is the current network.
     
    25572557 *
    25582558 * @since 3.7.0
    2559  * @since 4.8.0 The $network_id parameter has been added.
     2559 * @since 4.8.0 The `$network_id` parameter has been added.
    25602560 *
    25612561 * @global wpdb $wpdb WordPress database abstraction object.
     
    26862686 *
    26872687 * @since 3.3.0
    2688  * @since 4.8.0 The $network_id parameter has been added.
     2688 * @since 4.8.0 The `$network_id` parameter has been added.
    26892689 *
    26902690 * @param string   $using      'sites or 'users'. Default is 'sites'.
     
    27042704         *
    27052705         * @since 3.3.0
    2706          * @since 4.8.0 The $network_id parameter has been added.
     2706         * @since 4.8.0 The `$network_id` parameter has been added.
    27072707         *
    27082708         * @param bool   $is_large_network Whether the network has more than 10000 users or sites.
  • trunk/src/wp-includes/post.php

    r42664 r42678  
    10051005 *
    10061006 * @since 3.0.0
    1007  * @since 4.6.0 Object returned is now an instance of WP_Post_Type.
     1007 * @since 4.6.0 Object returned is now an instance of `WP_Post_Type`.
    10081008 *
    10091009 * @global array $wp_post_types List of post types.
     
    10681068 * @since 4.4.0 The `show_ui` argument is now enforced on the post type listing
    10691069 *              screen and post editing screen.
    1070  * @since 4.6.0 Post type object returned is now an instance of WP_Post_Type.
    1071  * @since 4.7.0 Introduced `show_in_rest`, 'rest_base' and 'rest_controller_class'
     1070 * @since 4.6.0 Post type object returned is now an instance of `WP_Post_Type`.
     1071 * @since 4.7.0 Introduced `show_in_rest`, `rest_base` and `rest_controller_class`
    10721072 *              arguments to register the post type in REST API.
    10731073 *
     
    12151215     *
    12161216     * @since 3.3.0
    1217      * @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object.
     1217     * @since 4.6.0 Converted the `$post_type` parameter to accept a `WP_Post_Type` object.
    12181218     *
    12191219     * @param string       $post_type        Post type.
     
    14441444 * @since 4.4.0 Added the `archives`, `insert_into_item`, `uploaded_to_this_item`, `filter_items_list`,
    14451445 *              `items_list_navigation`, and `items_list` labels.
    1446  * @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object.
     1446 * @since 4.6.0 Converted the `$post_type` parameter to accept a `WP_Post_Type` object.
    14471447 * @since 4.7.0 Added the `view_items` and `attributes` labels.
    14481448 *
     
    17131713 * @since 4.4.0
    17141714 * @since 4.5.0 Added the ability to pass a post type name in addition to object.
    1715  * @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object.
     1715 * @since 4.6.0 Converted the `$post_type` parameter to accept a `WP_Post_Type` object.
    17161716 *
    17171717 * @param string|WP_Post_Type $post_type Post type name or object.
     
    42494249 *
    42504250 * @since 1.5.0
    4251  * @since 4.7.0 $post_id can be a WP_Post object.
    4252  * @since 4.7.0 $uri can be an array of URIs.
     4251 * @since 4.7.0 `$post_id` can be a WP_Post object.
     4252 * @since 4.7.0 `$uri` can be an array of URIs.
    42534253 *
    42544254 * @global wpdb $wpdb WordPress database abstraction object.
     
    43314331 * @since 1.5.0
    43324332 *
    4333  * @since 4.7.0 $post_id can be a WP_Post object.
     4333 * @since 4.7.0 `$post_id` can be a WP_Post object.
    43344334 *
    43354335 * @param int|WP_Post $post_id Post ID or object.
     
    43594359 *
    43604360 * @since 1.5.0
    4361  * @since 4.7.0 $post_id can be a WP_Post object.
     4361 * @since 4.7.0 `$post_id` can be a WP_Post object.
    43624362 *
    43634363 * @param int|WP_Post $post_id Post Object or ID
  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

    r42343 r42678  
    579579         *
    580580         * @since 4.7.0
    581          * @since 4.8.0 $prepared_comment can now be a WP_Error to shortcircuit insertion.
     581         * @since 4.8.0 `$prepared_comment` can now be a WP_Error to shortcircuit insertion.
    582582         *
    583583         * @param array|WP_Error  $prepared_comment The prepared comment data for wp_insert_comment().
  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

    r42343 r42678  
    12021202     *
    12031203     * @since 4.7.0
    1204      * @since 4.9.0 Introduced the $validate parameter.
     1204     * @since 4.9.0 Added the `$validate` parameter.
    12051205     *
    12061206     * @param string  $template Page template filename.
  • trunk/src/wp-includes/taxonomy.php

    r42649 r42678  
    32313231 *
    32323232 * @since 2.3.0
    3233  * @since 4.7.0 Returns a WP_Error object if get_term() returns an error for
     3233 * @since 4.7.0 Returns a `WP_Error` object if `get_term()` returns an error for
    32343234 *              any of the matched terms.
    32353235 *
  • trunk/src/wp-includes/template.php

    r42343 r42678  
    478478 * @since 4.7.0 The decoded form of `single-{post_type}-{post_name}.php` was added to the top of the
    479479 *              template hierarchy when the post name contains multibyte characters.
    480  * @since 4.7.0 {Post Type Template}.php was added to the top of the template hierarchy.
     480 * @since 4.7.0 `{Post Type Template}.php` was added to the top of the template hierarchy.
    481481 *
    482482 * @see get_query_template()
  • trunk/src/wp-includes/user.php

    r42343 r42678  
    594594 *
    595595 * @since 3.0.0
    596  * @since 4.7.0 Converted to use get_sites().
     596 * @since 4.7.0 Converted to use `get_sites()`.
    597597 *
    598598 * @global wpdb $wpdb WordPress database abstraction object.
Note: See TracChangeset for help on using the changeset viewer.