Docs: Remove @return void from various DocBlocks.

SergeyBiryukov · SergeyBiryukov · commit 50f2d7da7d65 · 2022-05-02T13:11:07.000Z
Per the documentation standards, it should not be used outside of the default bundled themes. Follow-up to [38767], [47055], [49697], [50956], [51003], [52069], [53255]. See #54729. git-svn-id: https://develop.svn.wordpress.org/trunk@53331 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-includes/block-editor.php b/src/wp-includes/block-editor.php
@@ -533,8 +533,6 @@ function get_block_editor_settings( array $custom_settings, $block_editor_contex
  *
  * @param string[]                $preload_paths        List of paths to preload.
  * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
- *
- * @return void
  */
 function block_editor_rest_api_preload( array $preload_paths, $block_editor_context ) {
 	global $post, $wp_scripts, $wp_styles;
diff --git a/src/wp-includes/class-wp-customize-nav-menus.php b/src/wp-includes/class-wp-customize-nav-menus.php
@@ -1199,7 +1199,6 @@ public function available_items_template() {
 	 * @since 4.7.0
 	 *
 	 * @param array $available_item_type Menu item data to output, including title, type, and label.
-	 * @return void
 	 */
 	protected function print_post_type_container( $available_item_type ) {
 		$id = sprintf( 'available-menu-items-%s-%s', $available_item_type['type'], $available_item_type['object'] );
@@ -1240,8 +1239,6 @@ protected function print_post_type_container( $available_item_type ) {
 	 * Prints the markup for available menu item custom links.
 	 *
 	 * @since 4.7.0
-	 *
-	 * @return void
 	 */
 	protected function print_custom_links_available_menu_item() {
 		?>
diff --git a/src/wp-includes/pomo/translations.php b/src/wp-includes/pomo/translations.php
@@ -159,7 +159,6 @@ public function translate_plural( $singular, $plural, $count, $context = null )
 		 * Merge $other in the current object.
 		 *
 		 * @param Object $other Another Translation object, whose translations will be merged in this one (passed by reference).
-		 * @return void
 		 */
 		public function merge_with( &$other ) {
 			foreach ( $other->entries as $entry ) {
diff --git a/src/wp-includes/script-loader.php b/src/wp-includes/script-loader.php
@@ -2933,7 +2933,6 @@ static function () use ( $style ) {
  *
  * @param string $block_name The block-name, including namespace.
  * @param array  $args       An array of arguments [handle,src,deps,ver,media].
- * @return void
  */
 function wp_enqueue_block_style( $block_name, $args ) {
 	$args = wp_parse_args(
diff --git a/src/wp-includes/theme-templates.php b/src/wp-includes/theme-templates.php
@@ -105,8 +105,6 @@ function wp_filter_wp_template_unique_post_slug( $override_slug, $slug, $post_ID
  * @since 5.8.0
  *
  * @global string $_wp_current_template_content
- *
- * @return void
  */
 function the_block_template_skip_link() {
 	global $_wp_current_template_content;
diff --git a/tests/phpunit/tests/kses.php b/tests/phpunit/tests/kses.php
@@ -61,7 +61,6 @@ public function data_wp_filter_post_kses_address() {
 	 *
 	 * @param string $string        Test string for kses.
 	 * @param string $expect_string Expected result after passing through kses.
-	 * @return void
 	 */
 	public function test_wp_filter_post_kses_a( $string, $expect_string ) {
 		global $allowedposttags;
@@ -169,7 +168,6 @@ public function data_wp_kses_video() {
 	 *
 	 * @param string $string        Test string for kses.
 	 * @param string $expect_string Expected result after passing through kses.
-	 * @return void
 	 */
 	public function test_wp_filter_post_kses_abbr( $string, $expect_string ) {
 		global $allowedposttags;
diff --git a/tests/phpunit/tests/user/query.php b/tests/phpunit/tests/user/query.php
@@ -1969,15 +1969,12 @@ public function test_get_single_capability_multisite_blog_id() {
 
 	/**
 	 * @ticket 53177
-	 *
-	 * @param $field
-	 * @param $expected
-	 *
-	 * @return void
-	 *
 	 * @dataProvider data_returning_fields
 	 *
 	 * @covers WP_User_Query::prepare_query
+	 *
+	 * @param $field
+	 * @param $expected
 	 */
 	public function test_returning_fields( $field, $expected_values ) {
 		$q       = new WP_User_Query(
@@ -2101,8 +2098,6 @@ public function data_returning_fields() {
 	/**
 	 * @ticket 53177
 	 *
-	 * @return void
-	 *
 	 * @covers WP_User_Query::prepare_query
 	 */
 	public function test_returning_field_user_registered() {

Original file line number	Diff line number	Diff line change
`@@ -533,8 +533,6 @@ function get_block_editor_settings( array $custom_settings, $block_editor_contex`
`533`	`533`	`*`
`534`	`534`	`* @param string[] $preload_paths List of paths to preload.`
`535`	`535`	`* @param WP_Block_Editor_Context $block_editor_context The current block editor context.`
`536`		`- *`
`537`		`- * @return void`
`538`	`536`	`*/`
`539`	`537`	`function block_editor_rest_api_preload( array $preload_paths, $block_editor_context ) {`
`540`	`538`	`global $post, $wp_scripts, $wp_styles;`
Original file line number	Diff line number	Diff line change
`@@ -159,7 +159,6 @@ public function translate_plural( $singular, $plural, $count, $context = null )`
`159`	`159`	`* Merge $other in the current object.`
`160`	`160`	`*`
`161`	`161`	`* @param Object $other Another Translation object, whose translations will be merged in this one (passed by reference).`
`162`		`- * @return void`
`163`	`162`	`*/`
`164`	`163`	`public function merge_with( &$other ) {`
`165`	`164`	`foreach ( $other->entries as $entry ) {`
Original file line number	Diff line number	Diff line change
`@@ -2933,7 +2933,6 @@ static function () use ( $style ) {`
`2933`	`2933`	`*`
`2934`	`2934`	`* @param string $block_name The block-name, including namespace.`
`2935`	`2935`	`* @param array $args An array of arguments [handle,src,deps,ver,media].`
`2936`		`- * @return void`
`2937`	`2936`	`*/`
`2938`	`2937`	`function wp_enqueue_block_style( $block_name, $args ) {`
`2939`	`2938`	`$args = wp_parse_args(`
Original file line number	Diff line number	Diff line change
`@@ -105,8 +105,6 @@ function wp_filter_wp_template_unique_post_slug( $override_slug, $slug, $post_ID`
`105`	`105`	`* @since 5.8.0`
`106`	`106`	`*`
`107`	`107`	`* @global string $_wp_current_template_content`
`108`		`- *`
`109`		`- * @return void`
`110`	`108`	`*/`
`111`	`109`	`function the_block_template_skip_link() {`
`112`	`110`	`global $_wp_current_template_content;`