From 8c533a84421b5c82f346d7e163abab2db933a80f Mon Sep 17 00:00:00 2001 From: audrasjb Date: Mon, 5 Jun 2023 21:35:20 +0000 Subject: [PATCH] Docs: Various docblock improvements in Custom Header Image related functions, as per docblocks standards. See #57840. Built from https://develop.svn.wordpress.org/trunk@55882 git-svn-id: http://core.svn.wordpress.org/trunk@55394 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- .../includes/class-custom-image-header.php | 59 ++++++++++--------- wp-includes/version.php | 2 +- 2 files changed, 31 insertions(+), 30 deletions(-) diff --git a/wp-admin/includes/class-custom-image-header.php b/wp-admin/includes/class-custom-image-header.php index 630190ad88..bc7c2322e4 100644 --- a/wp-admin/includes/class-custom-image-header.php +++ b/wp-admin/includes/class-custom-image-header.php @@ -66,7 +66,7 @@ class Custom_Image_Header { } /** - * Set up the hooks for the Custom Header admin page. + * Sets up the hooks for the Custom Header admin page. * * @since 2.1.0 */ @@ -146,7 +146,7 @@ class Custom_Image_Header { } /** - * Get the current step. + * Gets the current step. * * @since 2.6.0 * @@ -169,7 +169,7 @@ class Custom_Image_Header { } /** - * Set up the enqueue for the JavaScript files. + * Sets up the enqueue for the JavaScript files. * * @since 2.1.0 */ @@ -188,7 +188,7 @@ class Custom_Image_Header { } /** - * Set up the enqueue for the CSS files + * Sets up the enqueue for the CSS files. * * @since 2.7.0 */ @@ -203,7 +203,7 @@ class Custom_Image_Header { } /** - * Execute custom header modification. + * Executes custom header modification. * * @since 2.6.0 */ @@ -262,7 +262,7 @@ class Custom_Image_Header { } /** - * Process the default headers + * Processes the default headers. * * @since 3.0.0 * @@ -299,9 +299,9 @@ class Custom_Image_Header { } /** - * Display UI for selecting one of several default headers. + * Displays UI for selecting one of several default headers. * - * Show the random image option if this theme has multiple header images. + * Shows the random image option if this theme has multiple header images. * Random image option is on by default if no header has been set. * * @since 3.0.0 @@ -346,7 +346,7 @@ class Custom_Image_Header { } /** - * Execute JavaScript depending on step. + * Executes JavaScript depending on step. * * @since 2.1.0 */ @@ -361,7 +361,7 @@ class Custom_Image_Header { } /** - * Display JavaScript based on Step 1 and 3. + * Displays JavaScript based on Step 1 and 3. * * @since 2.6.0 */ @@ -422,7 +422,7 @@ class Custom_Image_Header { } /** - * Display JavaScript based on Step 2. + * Displays JavaScript based on Step 2. * * @since 2.6.0 */ @@ -498,7 +498,7 @@ class Custom_Image_Header { } /** - * Display first step of custom header image page. + * Displays first step of custom header image page. * * @since 2.1.0 */ @@ -812,7 +812,7 @@ endif; } /** - * Display second step of custom header image page. + * Displays second step of custom header image page. * * @since 2.1.0 */ @@ -955,7 +955,7 @@ endif; /** - * Upload the file to be cropped in the second step. + * Uploads the file to be cropped in the second step. * * @since 3.4.0 */ @@ -996,7 +996,7 @@ endif; } /** - * Display third step of custom header image page. + * Displays third step of custom header image page. * * @since 2.1.0 * @since 4.4.0 Switched to using wp_get_attachment_url() instead of the guid @@ -1092,7 +1092,7 @@ endif; } /** - * Display last step of custom header image page. + * Displays last step of custom header image page. * * @since 2.1.0 */ @@ -1102,7 +1102,7 @@ endif; } /** - * Display the page based on the current step. + * Displays the page based on the current step. * * @since 2.1.0 */ @@ -1147,16 +1147,17 @@ endif; } /** - * Choose a header image, selected from existing uploaded and default headers, - * or provide an array of uploaded header data (either new, or from media library). + * Chooses a header image, selected from existing uploaded and default headers, + * or provides an array of uploaded header data (either new, or from media library). * * @since 3.4.0 * * @param mixed $choice Which header image to select. Allows for values of 'random-default-image', - * for randomly cycling among the default images; 'random-uploaded-image', for randomly cycling - * among the uploaded images; the key of a default image registered for that theme; and - * the key of an image uploaded for that theme (the attachment ID of the image). - * Or an array of arguments: attachment_id, url, width, height. All are required. + * for randomly cycling among the default images; 'random-uploaded-image', + * for randomly cycling among the uploaded images; the key of a default image + * registered for that theme; and the key of an image uploaded for that theme + * (the attachment ID of the image). Or an array of arguments: attachment_id, + * url, width, height. All are required. */ final public function set_header_image( $choice ) { if ( is_array( $choice ) || is_object( $choice ) ) { @@ -1209,7 +1210,7 @@ endif; } /** - * Remove a header image. + * Removes a header image. * * @since 3.4.0 */ @@ -1218,7 +1219,7 @@ endif; } /** - * Reset a header image to the default image for the theme. + * Resets a header image to the default image for the theme. * * This method does not do anything if the theme does not have a default header image. * @@ -1248,7 +1249,7 @@ endif; } /** - * Calculate width and height based on what the currently selected theme supports. + * Calculates width and height based on what the currently selected theme supports. * * @since 3.9.0 * @@ -1299,7 +1300,7 @@ endif; } /** - * Create an attachment 'object'. + * Creates an attachment 'object'. * * @since 3.9.0 * @@ -1328,7 +1329,7 @@ endif; } /** - * Insert an attachment and its metadata. + * Inserts an attachment and its metadata. * * @since 3.9.0 * @@ -1578,7 +1579,7 @@ endif; } /** - * Get the ID of a previous crop from the same base image. + * Gets the ID of a previous crop from the same base image. * * @since 4.9.0 * diff --git a/wp-includes/version.php b/wp-includes/version.php index a1983364cc..3ff8774080 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -16,7 +16,7 @@ * * @global string $wp_version */ -$wp_version = '6.3-alpha-55881'; +$wp_version = '6.3-alpha-55882'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.