Skip to content

Commit 33ba709

Browse files
Docs: Add missing variable names to @param tags in bundled themes.
Adds missing variable names to @param tags in Twenty Eleven, Twenty Ten, and Twenty Twenty themes
1 parent 6b7adc0 commit 33ba709

File tree

8 files changed

+10
-10
lines changed

8 files changed

+10
-10
lines changed

src/wp-content/themes/twentyeleven/category.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
*
3131
* @since Twenty Eleven 1.0
3232
*
33-
* @param string The default category description HTML.
33+
* @param string $html The default category description HTML.
3434
*/
3535
echo apply_filters( 'category_archive_meta', '<div class="category-archive-meta">' . $category_description . '</div>' );
3636
}

src/wp-content/themes/twentyeleven/functions.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,15 +188,15 @@ function twentyeleven_setup() {
188188
*
189189
* @since Twenty Eleven 1.0
190190
*
191-
* @param int The default header image width in pixels. Default 1000.
191+
* @param int $width The default header image width in pixels. Default 1000.
192192
*/
193193
'width' => apply_filters( 'twentyeleven_header_image_width', 1000 ),
194194
/**
195195
* Filters the Twenty Eleven default header image height.
196196
*
197197
* @since Twenty Eleven 1.0
198198
*
199-
* @param int The default header image height in pixels. Default 288.
199+
* @param int $height The default header image height in pixels. Default 288.
200200
*/
201201
'height' => apply_filters( 'twentyeleven_header_image_height', 288 ),
202202
// Support flexible heights.

src/wp-content/themes/twentyten/author.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
*
4646
* @since Twenty Ten 1.0
4747
*
48-
* @param int The height and width avatar dimensions in pixels. Default 60.
48+
* @param int $size The height and width avatar dimensions in pixels. Default 60.
4949
*/
5050
$author_bio_avatar_size = apply_filters( 'twentyten_author_bio_avatar_size', 60 );
5151
echo get_avatar( get_the_author_meta( 'user_email' ), $author_bio_avatar_size );

src/wp-content/themes/twentyten/loop-attachment.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,15 +127,15 @@
127127
*
128128
* @since Twenty Ten 1.0
129129
*
130-
* @param int The default attachment width in pixels. Default 900.
130+
* @param int $width The default attachment width in pixels. Default 900.
131131
*/
132132
$attachment_width = apply_filters( 'twentyten_attachment_size', 900 );
133133
/**
134134
* Filters the Twenty Ten default attachment height.
135135
*
136136
* @since Twenty Ten 1.0
137137
*
138-
* @param int The default attachment height in pixels. Default 900.
138+
* @param int $height The default attachment height in pixels. Default 900.
139139
*/
140140
$attachment_height = apply_filters( 'twentyten_attachment_height', 900 );
141141
// Filterable image width with, essentially, no limit for image height.

src/wp-content/themes/twentytwenty/functions.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -819,7 +819,7 @@ function twentytwenty_get_elements_array() {
819819
*
820820
* @since Twenty Twenty 1.0
821821
*
822-
* @param array Array of elements.
822+
* @param array $elements Array of elements.
823823
*/
824824
return apply_filters( 'twentytwenty_get_elements_array', $elements );
825825
}

src/wp-content/themes/twentytwenty/inc/template-tags.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ function twentytwenty_get_post_meta( $post_id = null, $location = 'single-top' )
266266
*
267267
* @since Twenty Twenty 1.0
268268
*
269-
* @param array Array of post types.
269+
* @param array $post_types Array of post types.
270270
*/
271271
$disallowed_post_types = apply_filters( 'twentytwenty_disallowed_post_types_for_meta_output', array( 'page' ) );
272272

src/wp-content/themes/twentytwenty/template-parts/content-cover.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
*
6060
* @since Twenty Twenty 1.0
6161
*
62-
* @param bool Whether to show the categories in article header. Default true.
62+
* @param bool $show_categories Whether to show the categories in article header. Default true.
6363
*/
6464
$show_categories = apply_filters( 'twentytwenty_show_categories_in_entry_header', true );
6565

src/wp-content/themes/twentytwenty/template-parts/entry-header.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
*
2626
* @since Twenty Twenty 1.0
2727
*
28-
* @param bool Whether to show the categories in header. Default true.
28+
* @param bool $show_categories Whether to show the categories in header. Default true.
2929
*/
3030
$show_categories = apply_filters( 'twentytwenty_show_categories_in_entry_header', true );
3131

0 commit comments

Comments
 (0)