WordPress.org
Get WordPress

Make WordPress Core

Changeset 53048


Ignore:
Timestamp:
04/01/2022 11:33:15 AM (3 years ago)
Author:
SergeyBiryukov
Message:

Docs: Remove HTML markup from WP_REST_URL_Details_Controller class method summaries.

Per the ​WordPress PHP documentation standards, no HTML markup or Markdown of any kind should be used in the summary. This ensures that the summary is displayed correctly in the ​WordPress Code Reference.

Props gvgvgvijayan, rsiddharth, azouamauriac, SergeyBiryukov.
Fixes #55506.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php

    r52582 r53048  
    125125
    126126    /**
    127      * Retrieves the contents of the `<title>` tag from the HTML response.
     127     * Retrieves the contents of the title tag from the HTML response.
    128128     *
    129129     * @since 5.9.0
    … …  
    189189
    190190    /**
    191      * Checks whether a given request has permission to read remote urls.
     191     * Checks whether a given request has permission to read remote URLs.
    192192     *
    193193     * @since 5.9.0
    … …  
    208208        return new WP_Error(
    209209            'rest_cannot_view_url_details',
    210             __( 'Sorry, you are not allowed to process remote urls.' ),
     210            __( 'Sorry, you are not allowed to process remote URLs.' ),
    211211            array( 'status' => rest_authorization_required_code() )
    212212        );
    … …  
    243243         * Filters the HTTP request args for URL data retrieval.
    244244         *
    245          * Can be used to adjust response size limit and other WP_Http::request args.
     245         * Can be used to adjust response size limit and other WP_Http::request() args.
    246246         *
    247247         * @since 5.9.0
    … …  
    277277
    278278    /**
    279      * Parses the `<title>` contents from the provided HTML.
     279     * Parses the title tag contents from the provided HTML.
    280280     *
    281281     * @since 5.9.0
    … …  
    483483
    484484    /**
    485      * Retrieves the `<head>` section.
     485     * Retrieves the head tag section.
    486486     *
    487487     * @since 5.9.0
    … …  
    520520
    521521    /**
    522      * Gets all the `<meta>` elements that have a `content` attribute.
     522     * Gets all the meta tag elements that have a 'content' attribute.
    523523     *
    524524     * @since 5.9.0
Note: See TracChangeset for help on using the changeset viewer.