Various PHPStan Fixes

bin/baseline.neon

@@ -1,11 +1,5 @@
 parameters:
 	ignoreErrors:
-		-
-			message: '#^Action callback returns array but should not return anything\.$#'
-			identifier: return.void
-			count: 1
-			path: ../includes/acf-bidirectional-functions.php
-
 		-
 			message: '#^@param array \$sub_field does not accept actual type of parameter\: int\|false\.$#'
 			identifier: parameter.phpDocType
@@ -42,18 +36,6 @@ parameters:
 			count: 2
 			path: ../includes/acf-field-functions.php
 
-		-
-			message: '#^Function acf_set_filters\(\) should return array but return statement is missing\.$#'
-			identifier: return.missing
-			count: 1
-			path: ../includes/acf-helper-functions.php
-
-		-
-			message: '#^Action callback returns mixed but should not return anything\.$#'
-			identifier: return.void
-			count: 1
-			path: ../includes/acf-hook-functions.php
-
 		-
 			message: '#^Function acf_checkbox_input\(\) should return string but return statement is missing\.$#'
 			identifier: return.missing
@@ -96,60 +78,6 @@ parameters:
 			count: 1
 			path: ../includes/acf-input-functions.php
 
-		-
-			message: '#^Result of function acf_add_validation_error \(void\) is used\.$#'
-			identifier: function.void
-			count: 1
-			path: ../includes/acf-internal-post-type-functions.php
-
-		-
-			message: '#^Result of function acf_copy_metadata \(void\) is used\.$#'
-			identifier: function.void
-			count: 1
-			path: ../includes/acf-meta-functions.php
-
-		-
-			message: '#^One or more @param tags has an invalid name or invalid syntax\.$#'
-			identifier: phpDoc.parseError
-			count: 1
-			path: ../includes/acf-user-functions.php
-
-		-
-			message: '#^Action callback returns string but should not return anything\.$#'
-			identifier: return.void
-			count: 1
-			path: ../includes/admin/admin-internal-post-type-list.php
-
-		-
-			message: '#^Action callback returns string but should not return anything\.$#'
-			identifier: return.void
-			count: 1
-			path: ../includes/admin/admin-internal-post-type.php
-
-		-
-			message: '#^Filter callback return statement is missing\.$#'
-			identifier: return.missing
-			count: 1
-			path: ../includes/admin/admin-internal-post-type.php
-
-		-
-			message: '#^Action callback returns string but should not return anything\.$#'
-			identifier: return.void
-			count: 1
-			path: ../includes/admin/admin-tools.php
-
-		-
-			message: '#^Action callback returns string but should not return anything\.$#'
-			identifier: return.void
-			count: 2
-			path: ../includes/admin/admin-upgrade.php
-
-		-
-			message: '#^Action callback returns string but should not return anything\.$#'
-			identifier: return.void
-			count: 1
-			path: ../includes/admin/admin.php
-
 		-
 			message: '#^Access to an undefined property ACF_Admin_Field_Groups\:\:\$not_found_label\.$#'
 			identifier: property.notFound

includes/acf-bidirectional-functions.php

@@ -15,6 +15,8 @@
  * @param integer|string $post_id         The ACF encoded origin post, user or term ID.
  * @param array          $field           The field being updated on the origin post, user or term ID.
  * @param string|false   $target_prefix   The ACF prefix for a post, user or term ID required for the update_field call for this field type.
+ *
+ * @return void
  */
 function acf_update_bidirectional_values( $target_item_ids, $post_id, $field, $target_prefix = false ) {
 
@@ -201,14 +203,16 @@ function ( $field_group ) {
 	return $results;
 }
 
-add_action( 'acf/fields/select/query/key=_acf_bidirectional_target', 'acf_build_bidirectional_relationship_field_target_args', 10, 2 );
+add_filter( 'acf/fields/select/query/key=_acf_bidirectional_target', 'acf_build_bidirectional_relationship_field_target_args', 10, 2 );
 
 /**
  * Renders the field settings required for bidirectional fields
  *
  * @since ACF 6.2
  *
  * @param array $field The field object passed into field setting functions.
+ *
+ * @return void
  */
 function acf_render_bidirectional_field_settings( $field ) {
 	if ( ! acf_get_setting( 'enable_bidirection' ) ) {

includes/acf-helper-functions.php

@@ -201,7 +201,7 @@ function acf_get_filters() {
  * @since   ACF 5.4.0
  *
  * @param   array $filters An Array of modifiers.
- * @return  array
+ * @return  void
  */
 function acf_set_filters( $filters = array() ) {
 	acf_get_store( 'filters' )->set( $filters );

includes/acf-hook-functions.php

@@ -60,6 +60,7 @@ function acf_add_action_variations( $action = '', $variations = array(), $index
 
 	// Add generic handler.
 	// Use a priority of 10, and accepted args of 10 (ignored by WP).
+	// @phpstan-ignore return.void
 	add_action( $action, '_acf_apply_hook_variations', 10, 10 );
 }
 
@@ -105,7 +106,7 @@ function _acf_apply_hook_variations() {
 		}
 
 		// Apply filters.
-		if ( $type === 'filter' ) {
+		if ( 'filters' === $type ) {
 			$args[0] = apply_filters_ref_array( "$filter/$variation=$value", $args );
 
 			// Or do action.

includes/acf-internal-post-type-functions.php

@@ -642,7 +642,7 @@ function acf_add_internal_post_type_validation_error( $name, $message = '', $pos
 		$name = "{$input_prefix}[$name]";
 	}
 
-	return acf_add_validation_error( $name, $message );
+	acf_add_validation_error( $name, $message );
 }
 
 /**

includes/acf-meta-functions.php

@@ -284,7 +284,7 @@ function acf_copy_metadata( $from_post_id = 0, $to_post_id = 0 ) {
  * @return  void
  */
 function acf_copy_postmeta( $from_post_id = 0, $to_post_id = 0 ) {
-	return acf_copy_metadata( $from_post_id, $to_post_id );
+	acf_copy_metadata( $from_post_id, $to_post_id );
 }
 
 /**

includes/acf-user-functions.php

@@ -92,11 +92,8 @@ function acf_get_user_role_labels( $roles = array() ) {
 }
 
 /**
- * acf_allow_unfiltered_html
- *
  * Returns true if the current user is allowed to save unfiltered HTML.
  *
- * @date    9/1/19
  * @since   ACF 5.7.10
  *
  * @return  boolean
@@ -112,7 +109,7 @@ function acf_allow_unfiltered_html() {
 	 * @date    9/1/19
 	 * @since   ACF 5.7.10
 	 *
-	 * @param   bool allow_unfiltered_html The result.
+	 * @param   bool $allow_unfiltered_html Can the current user save unfiltered HTML.
 	 */
 	return apply_filters( 'acf/allow_unfiltered_html', $allow_unfiltered_html );
 }

includes/admin/admin-internal-post-type-list.php

@@ -146,7 +146,7 @@ public function current_screen() {
 
 			// Add hooks.
 			add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) );
-			add_action( 'admin_body_class', array( $this, 'admin_body_class' ) );
+			add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
 			add_filter( "views_edit-{$this->post_type}", array( $this, 'admin_table_views' ), 10, 1 );
 			add_filter( "manage_{$this->post_type}_posts_columns", array( $this, 'admin_table_columns' ), 10, 1 );
 			add_action( "manage_{$this->post_type}_posts_custom_column", array( $this, 'admin_table_columns_html' ), 10, 2 );

includes/admin/admin-internal-post-type.php

@@ -91,7 +91,7 @@ public function current_screen() {
 			acf_disable_filters();
 			acf_enqueue_scripts();
 
-			add_action( 'admin_body_class', array( $this, 'admin_body_class' ) );
+			add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
 			add_action( 'acf/input/admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) );
 			add_action( 'acf/input/admin_head', array( $this, 'admin_head' ) );
 			add_action( 'acf/input/form_data', array( $this, 'form_data' ) );
@@ -164,10 +164,11 @@ public function admin_footer() {
 		 * @since   ACF 5.3.8
 		 *
 		 * @param array $l10n The array of translated strings.
-		 * @return void
+		 * @return mixed
 		 */
 		public function admin_l10n( $l10n ) {
 			// Override as necessary.
+			return $l10n;
 		}
 
 		/**

includes/admin/admin-tools.php

@@ -122,7 +122,7 @@ public function admin_menu() {
 		 */
 		public function load() {
 
-			add_action( 'admin_body_class', array( $this, 'admin_body_class' ) );
+			add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
 
 			// disable filters (default to raw data)
 			acf_disable_filters();

includes/admin/admin-upgrade.php

@@ -174,7 +174,7 @@ public function check_for_network_upgrades() {
 		 */
 		public function admin_load() {
 
-			add_action( 'admin_body_class', array( $this, 'admin_body_class' ) );
+			add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
 
 			// remove prompt
 			remove_action( 'admin_notices', array( $this, 'admin_notices' ) );
@@ -195,7 +195,7 @@ public function admin_load() {
 		 */
 		public function network_admin_load() {
 
-			add_action( 'admin_body_class', array( $this, 'admin_body_class' ) );
+			add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
 
 			// remove prompt
 			remove_action( 'network_admin_notices', array( $this, 'network_admin_notices' ) );

includes/admin/admin.php

@@ -17,7 +17,7 @@ class ACF_Admin {
 		public function __construct() {
 			add_action( 'admin_menu', array( $this, 'admin_menu' ) );
 			add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) );
-			add_action( 'admin_body_class', array( $this, 'admin_body_class' ) );
+			add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
 			add_action( 'current_screen', array( $this, 'current_screen' ) );
 			add_action( 'admin_notices', array( $this, 'maybe_show_escaped_html_notice' ) );
 			add_action( 'admin_init', array( $this, 'dismiss_escaped_html_notice' ) );