Make WordPress Core

Changeset 54284


Ignore:
Timestamp:
09/21/2022 08:22:53 PM (18 months ago)
Author:
johnbillion
Message:

Docs: Updates and corrections to various inline docs added in 6.1.

See #55646

Location:
trunk/src
Files:
7 edited

Legend:

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

    r54205 r54284  
    24872487         * @since 6.1.0
    24882488         *
    2489          * @param string $notes              The notes appended to the health check description.
    2490          * @param array $available_services The list of available persistent object cache services.
     2489         * @param string   $notes              The notes appended to the health check description.
     2490         * @param string[] $available_services The list of available persistent object cache services.
    24912491         */
    24922492        $notes = apply_filters( 'site_status_persistent_object_cache_notes', $notes, $available_services );
     
    33503350         * @since 6.1.0
    33513351         *
    3352          * @param array $thresholds The list of threshold names and numbers.
     3352         * @param int[] $thresholds The list of threshold numbers keyed by threshold name.
    33533353         */
    33543354        $thresholds = apply_filters(
     
    34093409     * @since 6.1.0
    34103410     *
    3411      * @return array The list of available persistent object cache services.
     3411     * @return string[] The list of available persistent object cache services.
    34123412     */
    34133413    private function available_object_cache_services() {
     
    34323432         * @since 6.1.0
    34333433         *
    3434          * @param array $services The list of available persistent object cache services.
     3434         * @param string[] $services The list of available persistent object cache services.
    34353435         */
    34363436        return apply_filters( 'site_status_available_object_cache_services', $services );
  • trunk/src/wp-includes/blocks/comments.php

    r54257 r54284  
    214214     * the block has multiple styles.
    215215     */
     216    /** This filter is documented in wp-includes/blocks.php */
    216217    $metadata = apply_filters( 'block_type_metadata', $metadata );
    217218
  • trunk/src/wp-includes/class-wp-theme-json-resolver.php

    r54272 r54284  
    435435        }
    436436
    437         /**
    438          * Filters the data provided by the user for global styles & settings.
    439          *
    440          * @since 6.1.0
    441          *
    442          * @param WP_Theme_JSON_Data Class to access and update the underlying data.
    443          */
     437        /** This filter is documented in wp-includes/class-wp-theme-json-resolver.php */
    444438        $theme_json   = apply_filters( 'theme_json_user', new WP_Theme_JSON_Data( $config, 'custom' ) );
    445439        $config       = $theme_json->get_data();
  • trunk/src/wp-includes/pluggable.php

    r54249 r54284  
    22462246     *
    22472247     * @since 2.5.0
    2248      * @since 6.1.0 Added `action` argument.
    2249      *
    2250      * @param string|int $action Optional. The current nonce action. Default -1.
     2248     * @since 6.1.0 Added `$action` argument.
     2249     *
     2250     * @param string|int $action Optional. The nonce action. Default -1.
    22512251     * @return float Float value rounded up to the next highest integer.
    22522252     */
     
    22562256         *
    22572257         * @since 2.5.0
    2258          * @since 6.1.0 Added `action` argument to allow for more targeted filters.
     2258         * @since 6.1.0 Added `$action` argument to allow for more targeted filters.
    22592259         *
    22602260         * @param int        $lifespan Lifespan of nonces in seconds. Default 86,400 seconds, or one day.
    2261          * @param string|int $action   The current nonce action.
     2261         * @param string|int $action   The nonce action, or -1 if none was provided.
    22622262         */
    22632263        $nonce_life = apply_filters( 'nonce_life', DAY_IN_SECONDS, $action );
     
    22912291             * @since 3.5.0
    22922292             *
    2293              * @param int    $uid    ID of the nonce-owning user.
    2294              * @param string $action The nonce action.
     2293             * @param int        $uid    ID of the nonce-owning user.
     2294             * @param string|int $action The nonce action, or -1 if none was provided.
    22952295             */
    22962296            $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
  • trunk/src/wp-includes/post-template.php

    r54208 r54284  
    556556     * @since 6.1.0
    557557     *
    558      * @param array    $taxonomies List of all public taxonomies to generate classes for.
     558     * @param string[] $taxonomies List of all taxonomy names to generate classes for.
    559559     * @param int      $post_id    The post ID.
    560560     * @param string[] $classes    An array of post class names.
  • trunk/src/wp-includes/post.php

    r54271 r54284  
    33863386     * @since 4.4.0
    33873387     *
    3388      * @param WP_Post|false|null $delete       Whether to go forward with deletion. @TODO description
     3388     * @param WP_Post|false|null $delete       Whether to go forward with deletion.
    33893389     * @param WP_Post            $post         Post object.
    33903390     * @param bool               $force_delete Whether to bypass the Trash.
     
    63736373     * @since 5.5.0
    63746374     *
    6375      * @param WP_Post|false|null $delete       Whether to go forward with deletion. @TODO description
     6375     * @param WP_Post|false|null $delete       Whether to go forward with deletion.
    63766376     * @param WP_Post            $post         Post object.
    63776377     * @param bool               $force_delete Whether to bypass the Trash.
  • trunk/src/wp-includes/update.php

    r54116 r54284  
    683683     * @since 4.5.0 The default value of the `$locales` parameter changed to include all locales.
    684684     *
    685      * @param array $locales Theme locales. Default is all available locales of the site.
     685     * @param string[] $locales Theme locales. Default is all available locales of the site.
    686686     */
    687687    $locales = apply_filters( 'themes_update_check_locales', $locales );
     
    789789         * @param array       $theme_data       Theme headers.
    790790         * @param string      $theme_stylesheet Theme stylesheet.
    791          * @param array       $locales          Installed locales to look up translations for.
     791         * @param string[]    $locales          Installed locales to look up translations for.
    792792         */
    793793        $update = apply_filters( "update_themes_{$hostname}", false, $theme_data, $theme_stylesheet, $locales );
Note: See TracChangeset for help on using the changeset viewer.