WordPress.org

Make WordPress Core

Changeset 46644


Ignore:
Timestamp:
11/03/2019 10:21:20 PM (12 months ago)
Author:
johnbillion
Message:

Docs: Fix some incorrect return tags in docblocks.

See #48303

Location:
trunk
Files:
16 edited

Legend:

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

    r46596 r46644  
    349349     * @param  array  $nested_files  Array of files as returned by WP_Filesystem::dirlist()
    350350     * @param  string $path          Relative path to prepend to child nodes. Optional.
    351      * @return array $files A flattened array of the $nested_files specified.
     351     * @return array A flattened array of the $nested_files specified.
    352352     */
    353353    protected function flatten_dirlist( $nested_files, $path = '' ) {
  • trunk/src/wp-admin/includes/deprecated.php

    r45932 r46644  
    10021002 * @see wp_get_themes()
    10031003 *
    1004  * @return array $themes Array of allowed themes.
     1004 * @return WP_Theme[] Array of WP_Theme objects keyed by their name.
    10051005 */
    10061006function get_allowed_themes() {
  • trunk/src/wp-admin/includes/image.php

    r46622 r46644  
    245245     *
    246246     * @param int    $threshold     The threshold value in pixels. Default 2560.
    247      * @param array  $imagesize     Indexed array of the image width and height (in that order).
     247     * @param array  $imagesize     {
     248     *     Indexed array of the image width and height in pixels.
     249     *
     250     *     @type int $0 The image width.
     251     *     @type int $0 The image height.
     252     * }
    248253     * @param string $file          Full path to the uploaded image file.
    249254     * @param int    $attachment_id Attachment post ID.
     
    536541         * @since 4.7.0
    537542         *
    538          * @param array $fallback_sizes An array of image size names.
    539          * @param array $metadata       Current attachment metadata.
     543         * @param string[] $fallback_sizes An array of image size names.
     544         * @param array    $metadata       Current attachment metadata.
    540545         */
    541546        $fallback_sizes = apply_filters( 'fallback_intermediate_image_sizes', $fallback_sizes, $metadata );
  • trunk/src/wp-admin/includes/nav-menu.php

    r46330 r46644  
    11271127 * @param int|string $nav_menu_selected_id (id, slug, or name ) of the currently-selected menu
    11281128 * @param string $nav_menu_selected_title Title of the currently-selected menu
    1129  * @return array $messages The menu updated message
     1129 * @return array The menu updated message
    11301130 */
    11311131function wp_nav_menu_update_menu_items( $nav_menu_selected_id, $nav_menu_selected_title ) {
  • trunk/src/wp-includes/class-wp-customize-widgets.php

    r46133 r46644  
    11051105     *
    11061106     * @param  array $nonces Array of nonces.
    1107      * @return array $nonces Array of nonces.
     1107     * @return array Array of nonces.
    11081108     */
    11091109    public function refresh_nonces( $nonces ) {
  • trunk/src/wp-includes/comment.php

    r46603 r46644  
    33943394 *
    33953395 * @param array $exporters An array of personal data exporters.
    3396  * @return array $exporters An array of personal data exporters.
     3396 * @return array An array of personal data exporters.
    33973397 */
    33983398function wp_register_comment_personal_data_exporter( $exporters ) {
     
    34123412 * @param string $email_address The comment author email address.
    34133413 * @param int    $page          Comment page.
    3414  * @return array $return An array of personal data.
     3414 * @return array An array of personal data.
    34153415 */
    34163416function wp_comments_personal_data_exporter( $email_address, $page = 1 ) {
     
    35043504 *
    35053505 * @param  array $erasers An array of personal data erasers.
    3506  * @return array $erasers An array of personal data erasers.
     3506 * @return array An array of personal data erasers.
    35073507 */
    35083508function wp_register_comment_personal_data_eraser( $erasers ) {
  • trunk/src/wp-includes/embed.php

    r46164 r46644  
    7777     * @since 2.9.0
    7878     *
    79      * @param array  $size An array of embed width and height values
    80      *                     in pixels (in that order).
     79     * @param array  $size {
     80     *     Indexed array of the embed width and height in pixels.
     81     *
     82     *     @type int $0 The embed width.
     83     *     @type int $0 The embed height.
     84     * }
    8185     * @param string $url  The URL that should be embedded.
    8286     */
  • trunk/src/wp-includes/functions.php

    r46633 r46644  
    63966396 *
    63976397 * @param array $response  The Heartbeat response.
    6398  * @return array $response The Heartbeat response with 'wp-auth-check' value set.
     6398 * @return array The Heartbeat response with 'wp-auth-check' value set.
    63996399 */
    64006400function wp_auth_check( $response ) {
  • trunk/src/wp-includes/media.php

    r46603 r46644  
    11081108 * @param string $size_name  Image size. Accepts any valid image size name ('thumbnail', 'medium', etc.).
    11091109 * @param array  $image_meta The image meta data.
    1110  * @return array|bool Array of width and height values in pixels (in that order)
    1111  *                    or false if the size doesn't exist.
     1110 * @return array|bool The image meta data as returned by `wp_get_attachment_metadata()`.
    11121111 */
    11131112function _wp_get_image_size_from_meta( $size_name, $image_meta ) {
  • trunk/src/wp-includes/ms-functions.php

    r46596 r46644  
    25782578 * @since 4.4.0
    25792579 *
    2580  * @return array $names Array of reserved subdirectory names.
     2580 * @return array Array of reserved subdirectory names.
    25812581 */
    25822582function get_subdirectory_reserved_names() {
  • trunk/src/wp-includes/rest-api.php

    r46586 r46644  
    11661166 * @param mixed $id_or_email The Gravatar to retrieve a URL for. Accepts a user_id, gravatar md5 hash,
    11671167 *                           user email, WP_User object, WP_Post object, or WP_Comment object.
    1168  * @return array $urls Gravatar url for each size.
     1168 * @return array Gravatar url for each size.
    11691169 */
    11701170function rest_get_avatar_urls( $id_or_email ) {
  • trunk/tests/phpunit/tests/ajax/PrivacyErasePersonalData.php

    r46586 r46644  
    178178     * @param array $erasers List of data erasers.
    179179     *
    180      * @return array $erasersList of data erasers.
     180     * @return array Array of data erasers.
    181181     */
    182182    public function filter_eraser_callback_value( $erasers ) {
     
    205205     * @param array $erasers Erasers.
    206206     *
    207      * @return array $erasers Erasers.
     207     * @return array Erasers.
    208208     */
    209209    public function filter_unset_eraser_index( $erasers ) {
     
    237237     * @param int    $page          Page number.
    238238     *
    239      * @return array $return Export data.
     239     * @return array Export data.
    240240     */
    241241    public function filter_unset_response_index( $email_address, $page = 1 ) {
     
    650650     * @param int    $page          Page number.
    651651     *
    652      * @return array $return Export data.
     652     * @return array Export data.
    653653     */
    654654    public function filter_response_messages_invalid( $email_address, $page = 1 ) {
     
    771771     * @param array $erasers An array of personal data erasers.
    772772     *
    773      * @return array $erasers An array of personal data erasers.
     773     * @return array An array of personal data erasers.
    774774     */
    775775    public function register_custom_personal_data_eraser( $erasers ) {
  • trunk/tests/phpunit/tests/ajax/PrivacyExportPersonalData.php

    r46586 r46644  
    189189     *
    190190     * @param array $exporters List of data exporters.
    191      * @return array $exporters List of data exporters.
     191     * @return array List of data exporters.
    192192     */
    193193    public function filter_exporter_callback_value( $exporters ) {
     
    212212     * @param array $exporters List of data exporters.
    213213     *
    214      * @return array $exporters List of data exporters.
     214     * @return array List of data exporters.
    215215     */
    216216    public function filter_unset_exporter_key( $exporters ) {
     
    590590     * @param int    $page          Page number.
    591591     *
    592      * @return array $return Export data.
     592     * @return array Export data.
    593593     */
    594594    public function callback_missing_data_response( $email_address, $page = 1 ) {
     
    626626     * @param  int    $page          Page number.
    627627     *
    628      * @return array $return Export data.
     628     * @return array Export data.
    629629     */
    630630    public function callback_missing_data_array_response( $email_address, $page = 1 ) {
     
    661661     * @param int    $page          Page number.
    662662     *
    663      * @return array $return Export data.
     663     * @return array Export data.
    664664     */
    665665    public function callback_missing_done_response( $email_address, $page = 1 ) {
     
    740740     * @param string $exporter_key    The key (slug) of the exporter that provided this data.
    741741     *
    742      * @return array $response The personal data for the given exporter and page.
     742     * @return array The personal data for the given exporter and page.
    743743     */
    744744    public function filter_exporter_data_response( $response, $exporter_index, $email_address, $page, $request_id, $send_as_email, $exporter_key ) {
     
    768768     * @param array $exporters An array of personal data exporters.
    769769     *
    770      * @return array $exporters An array of personal data exporters.
     770     * @return array An array of personal data exporters.
    771771     */
    772772    public function filter_register_custom_personal_data_exporter( $exporters ) {
     
    786786     * @param int    $page          Page number.
    787787     *
    788      * @return array $response Export data response.
     788     * @return array Export data response.
    789789     */
    790790    public function callback_custom_personal_data_exporter( $email_address, $page = 1 ) {
  • trunk/tests/phpunit/tests/comment/isAvatarCommentType.php

    r46586 r46644  
    7272     *
    7373     * @param  array $types An array of content types.
    74      * @return array $types An array of content types.
     74     * @return array An array of content types.
    7575     */
    7676    public function _filter_avatar_comment_types( $types ) {
  • trunk/tests/phpunit/tests/functions/doEnclose.php

    r46586 r46644  
    234234     * @param  array $post_links An array of enclosure links.
    235235     * @param  int   $post_id    Post ID.
    236      * @return array $post_links An array of enclosure links.
     236     * @return array An array of enclosure links.
    237237     */
    238238    public function filter_enclosure_links( $enclosure_links, $post_id ) {
  • trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php

    r46586 r46644  
    211211     *
    212212     * @param  array $exporters An array of personal data exporters.
    213      * @return array $exporters An array of personal data exporters.
     213     * @return array An array of personal data exporters.
    214214     */
    215215    public function filter_register_custom_personal_data_exporters( $exporters ) {
Note: See TracChangeset for help on using the changeset viewer.