[Experimental] Add $request to additional fields validation filter (w…

…oocommerce#43789)

* Add $request to additional fields filter

* Add changelog entry

* Add data to additional message

plugins/woocommerce-blocks/assets/js/data/utils/process-error-response.ts

@@ -78,6 +78,7 @@ export const getErrorDetails = (
 									message: decodeEntities(
 										additionalError.message
 									),
+									data,
 								},
 							];
 							if ( typeof additionalError.data !== 'undefined' ) {

plugins/woocommerce/changelog/43789-add-request-to-additional-field-validation-filter

@@ -0,0 +1,3 @@
+Significance: patch
+Type: dev
+Comment: Skipping changelog because this is behind a feature flag.

plugins/woocommerce/src/Blocks/Domain/Services/CheckoutFields.php

@@ -476,27 +476,28 @@ public function get_field_location( $field_key ) {
 	/**
 	 * Validate an additional field against any custom validation rules. The result should be a WP_Error or true.
 	 *
-	 * @param string $key          The key of the field.
-	 * @param mixed  $field_value  The value of the field.
-	 * @param array  $field_schema The schema of the field.
+	 * @param string           $key          The key of the field.
+	 * @param mixed            $field_value  The value of the field.
+	 * @param array            $field_schema The schema of the field.
+	 * @param \WP_REST_Request $request      The current API Request.
 	 *
 	 * @since 8.6.0
 	 */
-	public function validate_field( $key, $field_value, $field_schema ) {
+	public function validate_field( $key, $field_value, $field_schema, $request ) {
 
 		$error = new \WP_Error();
 		try {
 			/**
 			 * Filter the result of validating an additional field.
 			 *
-			 * @param \WP_Error $error A WP_Error that extensions may add errors to.
-			 * @param mixed $field_value The value of the field.
-			 * @param array $field_schema The schema of the field.
-			 * @param string $key The key of the field.
+			 * @param \WP_Error        $error        A WP_Error that extensions may add errors to.
+			 * @param mixed            $field_value  The value of the field.
+			 * @param array            $field_schema The schema of the field.
+			 * @param \WP_REST_Request $request      The current API Request.
 			 *
 			 * @since 8.6.0
 			 */
-			$filtered_result = apply_filters( 'woocommerce_blocks_validate_additional_field_' . $key, $error, $field_value, $field_schema, $key );
+			$filtered_result = apply_filters( 'woocommerce_blocks_validate_additional_field_' . $key, $error, $field_value, $field_schema, $request );
 
 			if ( $error !== $filtered_result ) {
 

plugins/woocommerce/src/StoreApi/Schemas/V1/AbstractAddressSchema.php

@@ -217,7 +217,7 @@ public function validate_callback( $address, $request, $param ) {
 			// Check if a field is in the list of additional fields then validate the value against the custom validation rules defined for it.
 			// Skip additional validation if the schema validation failed.
 			if ( true === $result && in_array( $key, $additional_keys, true ) ) {
-				$result = $this->additional_fields_controller->validate_field( $key, $address[ $key ], $properties[ $key ] );
+				$result = $this->additional_fields_controller->validate_field( $key, $address[ $key ], $properties[ $key ], $request );
 			}
 
 			if ( is_wp_error( $result ) && $result->has_errors() ) {

plugins/woocommerce/src/StoreApi/Schemas/V1/CheckoutSchema.php

@@ -373,7 +373,7 @@ public function validate_additional_fields( $fields, $request ) {
 
 			// Only allow custom validation on fields that pass the schema validation.
 			if ( true === $result ) {
-				$result = $this->additional_fields_controller->validate_field( $key, $field_value, $properties[ $key ] );
+				$result = $this->additional_fields_controller->validate_field( $key, $field_value, $properties[ $key ], $request );
 			}
 
 			if ( is_wp_error( $result ) && $result->has_errors() ) {