WordPress.org
Get WordPress

Make WordPress Core

Changeset 51317


Ignore:
Timestamp:
07/02/2021 07:03:11 PM (3 years ago)
Author:
desrosj
Message:

Docs: Remove an empty line between @param and @return tags in some newly added REST API methods, per the documentation standards.

Follow-up to [48242], [49925], [51003], [51021].

Props SergeyBiryukov.
Merges [51289] to the 5.8 branch.
See #52628, #53461.

Location:
branches/5.8
Files:
9 edited

Legend:

Unmodified
Added
Removed

  • branches/5.8

  • branches/5.8/src/wp-includes/rest-api/class-wp-rest-server.php

    r51241 r51317  
    10811081     * @param string          $route    The matched route regex.
    10821082     * @param WP_Error|null   $response The current error object if any.
    1083      *
    10841083     * @return WP_REST_Response
    10851084     */

  • branches/5.8/src/wp-includes/rest-api/endpoints/class-wp-rest-block-directory-controller.php

    r49955 r51317  
    5050     *
    5151     * @param WP_REST_Request $request Full details about the request.
    52      *
    5352     * @return true|WP_Error True if the request has permission, WP_Error object otherwise.
    5453     */
    … …  
    7170     *
    7271     * @param WP_REST_Request $request Full details about the request.
    73      *
    7472     * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
    7573     */
    … …  
    115113     * @param array           $plugin  The plugin metadata.
    116114     * @param WP_REST_Request $request Request object.
    117      *
    118115     * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
    119116     */
    … …  
    157154     *
    158155     * @param array $plugin The plugin data from WordPress.org.
    159      *
    160156     * @return array
    161157     */
    … …  
    185181     *
    186182     * @param string $slug The WordPress.org directory slug for a plugin.
    187      *
    188183     * @return string The plugin file found matching it.
    189184     */

  • branches/5.8/src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php

    r51316 r51317  
    5757     *
    5858     * @param WP_REST_Request $request Full details about the request.
    59      *
    6059     * @return true|WP_Error True if the request has permission, WP_Error object otherwise.
    6160     */
    … …  
    8483     *
    8584     * @param WP_REST_Request $request Full details about the request.
    86      *
    8785     * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
    8886     */
    … …  
    205203     * @param object          $raw_pattern A pattern from api.wordpress.org, before any changes.
    206204     * @param WP_REST_Request $request     Request object.
    207      *
    208205     * @return WP_REST_Response
    209206     */

  • branches/5.8/src/wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

    r49955 r51317  
    663663     * @param string $new_status     The plugin's new status.
    664664     * @param string $current_status The plugin's current status.
    665      *
    666665     * @return true|WP_Error
    667666     */
    … …  
    773772     * @param WP_REST_Request $request The request to require the plugin matches against.
    774773     * @param array           $item    The plugin item.
    775      *
    776774     * @return bool
    777775     */

  • branches/5.8/src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php

    r51311 r51317  
    269269     * @param array           $raw_sidebar Sidebar instance.
    270270     * @param WP_REST_Request $request     Full details about the request.
    271      *
    272271     * @return WP_REST_Response Prepared response object.
    273272     */
    … …  
    345344     *
    346345     * @param array $sidebar Sidebar.
    347      *
    348346     * @return array Links for the given widget.
    349347     */

  • branches/5.8/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php

    r51221 r51317  
    146146     *
    147147     * @param WP_REST_Request $request The request instance.
    148      *
    149148     * @return WP_REST_Response
    150149     */
    … …  
    157156            $query['area'] = $request['area'];
    158157        }
     158
    159159        $templates = array();
    160160        foreach ( get_block_templates( $query, $this->post_type ) as $template ) {
    … …  
    184184     *
    185185     * @param WP_REST_Request $request The request instance.
    186      *
    187186     * @return WP_REST_Response|WP_Error
    188187     */
    … …  
    406405     * @param WP_Block_Template $template Template instance.
    407406     * @param WP_REST_Request   $request Request object.
    408      *
    409407     * @return WP_REST_Response $data
    410408     */

  • branches/5.8/src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php

    r51000 r51317  
    350350     * @param WP_Theme $theme_a First theme to compare.
    351351     * @param WP_Theme $theme_b Second theme to compare.
    352      *
    353352     * @return bool
    354353     */

  • branches/5.8/src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

    r51310 r51317  
    425425     * @param WP_REST_Request $request    Full details about the request.
    426426     * @param string          $sidebar_id ID of the sidebar the widget belongs to.
    427      *
    428427     * @return string|WP_Error The saved widget ID.
    429428     */
Note: See TracChangeset for help on using the changeset viewer.