Rename filter

westonruter · westonruter · commit f74f4f4b1b08 · 2024-12-16T11:19:18.000-08:00
diff --git a/plugins/image-prioritizer/helper.php b/plugins/image-prioritizer/helper.php
@@ -275,7 +275,7 @@ static function ( $host ) {
  *
  * @noinspection PhpDocMissingThrowsInspection
  */
-function image_prioritizer_filter_url_metric_data_pre_storage( $data ): array {
+function image_prioritizer_filter_store_url_metric_data( $data ): array {
 	if ( ! is_array( $data ) ) {
 		$data = array();
 	}
diff --git a/plugins/image-prioritizer/hooks.php b/plugins/image-prioritizer/hooks.php
@@ -13,4 +13,4 @@
 add_action( 'od_init', 'image_prioritizer_init' );
 add_filter( 'od_extension_module_urls', 'image_prioritizer_filter_extension_module_urls' );
 add_filter( 'od_url_metric_schema_root_additional_properties', 'image_prioritizer_add_element_item_schema_properties' );
-add_filter( 'od_url_metric_data_pre_storage', 'image_prioritizer_filter_url_metric_data_pre_storage' );
+add_filter( 'od_store_url_metric_data', 'image_prioritizer_filter_store_url_metric_data' );
diff --git a/plugins/image-prioritizer/tests/test-helper.php b/plugins/image-prioritizer/tests/test-helper.php
@@ -747,7 +747,7 @@ public function test_image_prioritizer_validate_background_image_url( Closure $s
 	 *
 	 * @return array<string, mixed>
 	 */
-	public function data_provider_to_test_image_prioritizer_filter_url_metric_data_pre_storage(): array {
+	public function data_provider_to_test_image_prioritizer_filter_store_url_metric_data(): array {
 		return array(
 			'invalid_external_bg_image' => array(
 				'set_up' => static function ( array $url_metric_data ): array {
@@ -835,17 +835,17 @@ static function ( $pre, $parsed_args, $url ) use ( $image_url ) {
 	}
 
 	/**
-	 * Tests image_prioritizer_filter_url_metric_data_pre_storage().
+	 * Tests image_prioritizer_filter_store_url_metric_data().
 	 *
-	 * @dataProvider data_provider_to_test_image_prioritizer_filter_url_metric_data_pre_storage
+	 * @dataProvider data_provider_to_test_image_prioritizer_filter_store_url_metric_data
 	 *
-	 * @covers ::image_prioritizer_filter_url_metric_data_pre_storage
+	 * @covers ::image_prioritizer_filter_store_url_metric_data
 	 * @covers ::image_prioritizer_validate_background_image_url
 	 */
-	public function test_image_prioritizer_filter_url_metric_data_pre_storage( Closure $set_up, Closure $assert ): void {
+	public function test_image_prioritizer_filter_store_url_metric_data( Closure $set_up, Closure $assert ): void {
 		$url_metric_data = $set_up( $this->get_sample_url_metric( array() )->jsonSerialize() );
 
-		$url_metric_data = image_prioritizer_filter_url_metric_data_pre_storage( $url_metric_data );
+		$url_metric_data = image_prioritizer_filter_store_url_metric_data( $url_metric_data );
 		$assert( $url_metric_data );
 	}
 
diff --git a/plugins/image-prioritizer/tests/test-hooks.php b/plugins/image-prioritizer/tests/test-hooks.php
@@ -14,6 +14,6 @@ public function test_hooks_added(): void {
 		$this->assertEquals( 10, has_action( 'od_init', 'image_prioritizer_init' ) );
 		$this->assertEquals( 10, has_filter( 'od_extension_module_urls', 'image_prioritizer_filter_extension_module_urls' ) );
 		$this->assertEquals( 10, has_filter( 'od_url_metric_schema_root_additional_properties', 'image_prioritizer_add_element_item_schema_properties' ) );
-		$this->assertEquals( 10, has_filter( 'od_url_metric_data_pre_storage', 'image_prioritizer_filter_url_metric_data_pre_storage' ) );
+		$this->assertEquals( 10, has_filter( 'od_store_url_metric_data', 'image_prioritizer_filter_store_url_metric_data' ) );
 	}
 }
diff --git a/plugins/optimization-detective/readme.txt b/plugins/optimization-detective/readme.txt
@@ -252,7 +252,7 @@ Filters the URL Metric data prior to validation for storage.
 
 This allows for custom sanitization and validation constraints to be applied beyond what can be expressed in JSON Schema. This filter only applies when storing a URL Metric via the REST API. It does not run when a stored URL Metric is loaded from the od_url_metrics post type. This means that sanitization and validation logic enforced via this filter can be more expensive, such as doing filesystem checks or HTTP requests.
 
-To fail validation for the provided URL Metric data, an OD_Data_Validation_Exception exception should be thrown. Otherwise, any filter callbacks must return an array consisting of the sanitized URL Metric data.
+To fail validation for the provided URL Metric data, an `OD_Data_Validation_Exception` exception should be thrown. Otherwise, any filter callbacks must return an array consisting of the sanitized URL Metric data.
 
 **Action:** `od_url_metric_stored` (argument: `OD_URL_Metric_Store_Request_Context`)
 
diff --git a/plugins/optimization-detective/storage/rest-api.php b/plugins/optimization-detective/storage/rest-api.php
@@ -216,7 +216,7 @@ function od_handle_rest_request( WP_REST_Request $request ) {
 		 *
 		 * @param array<string, mixed> $data URL Metric data. This is the Data type from OD_URL_Metric.
 		 */
-		$data = apply_filters( 'od_url_metric_data_pre_storage', $data );
+		$data = apply_filters( 'od_store_url_metric_data', $data );
 
 		// The "strict" URL Metric class is being used here to ensure additionalProperties of all objects are disallowed.
 		$url_metric = new OD_Strict_URL_Metric( $data );
diff --git a/plugins/optimization-detective/tests/storage/test-rest-api.php b/plugins/optimization-detective/tests/storage/test-rest-api.php
@@ -61,7 +61,7 @@ static function ( array $properties ) use ( $property_name ): array {
 			'rejected_by_generic_exception'    => array(
 				'set_up'          => function (): array {
 					add_filter(
-						'od_url_metric_data_pre_storage',
+						'od_store_url_metric_data',
 						static function ( $data ): array {
 							if ( count( $data ) > 0 ) {
 								throw new Exception( 'bad' );
@@ -77,7 +77,7 @@ static function ( $data ): array {
 			'rejected_by_validation_exception' => array(
 				'set_up'          => function (): array {
 					add_filter(
-						'od_url_metric_data_pre_storage',
+						'od_store_url_metric_data',
 						static function ( $data ): array {
 							if ( count( $data ) > 0 ) {
 								throw new OD_Data_Validation_Exception( 'bad' );
@@ -118,7 +118,7 @@ public function test_rest_request_good_params( Closure $set_up, bool $expect_sto
 		$filtered_url_metric_data = null;
 		$filter_called            = 0;
 		add_filter(
-			'od_url_metric_data_pre_storage',
+			'od_store_url_metric_data',
 			function ( $url_metric_data ) use ( &$filter_called, &$filtered_url_metric_data ) {
 				$this->assertIsArray( $url_metric_data );
 				$filtered_url_metric_data = $url_metric_data;

Original file line number	Diff line number	Diff line change
`@@ -275,7 +275,7 @@ static function ( $host ) {`
`275`	`275`	`*`
`276`	`276`	`* @noinspection PhpDocMissingThrowsInspection`
`277`	`277`	`*/`
`278`		`-function image_prioritizer_filter_url_metric_data_pre_storage( $data ): array {`
	`278`	`+function image_prioritizer_filter_store_url_metric_data( $data ): array {`
`279`	`279`	`if ( ! is_array( $data ) ) {`
`280`	`280`	`$data = array();`
`281`	`281`	`}`
Original file line number	Diff line number	Diff line change
`@@ -747,7 +747,7 @@ public function test_image_prioritizer_validate_background_image_url( Closure $s`
`747`	`747`	`*`
`748`	`748`	`* @return array<string, mixed>`
`749`	`749`	`*/`
`750`		`- public function data_provider_to_test_image_prioritizer_filter_url_metric_data_pre_storage(): array {`
	`750`	`+ public function data_provider_to_test_image_prioritizer_filter_store_url_metric_data(): array {`
`751`	`751`	`return array(`
`752`	`752`	`'invalid_external_bg_image' => array(`
`753`	`753`	`'set_up' => static function ( array $url_metric_data ): array {`
`@@ -835,17 +835,17 @@ static function ( $pre, $parsed_args, $url ) use ( $image_url ) {`
`835`	`835`	`}`
`836`	`836`
`837`	`837`	`/**`
`838`		`- * Tests image_prioritizer_filter_url_metric_data_pre_storage().`
	`838`	`+ * Tests image_prioritizer_filter_store_url_metric_data().`
`839`	`839`	`*`
`840`		`- * @dataProvider data_provider_to_test_image_prioritizer_filter_url_metric_data_pre_storage`
	`840`	`+ * @dataProvider data_provider_to_test_image_prioritizer_filter_store_url_metric_data`
`841`	`841`	`*`
`842`		`- * @covers ::image_prioritizer_filter_url_metric_data_pre_storage`
	`842`	`+ * @covers ::image_prioritizer_filter_store_url_metric_data`
`843`	`843`	`* @covers ::image_prioritizer_validate_background_image_url`
`844`	`844`	`*/`
`845`		`- public function test_image_prioritizer_filter_url_metric_data_pre_storage( Closure $set_up, Closure $assert ): void {`
	`845`	`+ public function test_image_prioritizer_filter_store_url_metric_data( Closure $set_up, Closure $assert ): void {`
`846`	`846`	`$url_metric_data = $set_up( $this->get_sample_url_metric( array() )->jsonSerialize() );`
`847`	`847`
`848`		`- $url_metric_data = image_prioritizer_filter_url_metric_data_pre_storage( $url_metric_data );`
	`848`	`+ $url_metric_data = image_prioritizer_filter_store_url_metric_data( $url_metric_data );`
`849`	`849`	`$assert( $url_metric_data );`
`850`	`850`	`}`
`851`	`851`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,6 @@ public function test_hooks_added(): void {`
`14`	`14`	`$this->assertEquals( 10, has_action( 'od_init', 'image_prioritizer_init' ) );`
`15`	`15`	`$this->assertEquals( 10, has_filter( 'od_extension_module_urls', 'image_prioritizer_filter_extension_module_urls' ) );`
`16`	`16`	`$this->assertEquals( 10, has_filter( 'od_url_metric_schema_root_additional_properties', 'image_prioritizer_add_element_item_schema_properties' ) );`
`17`		`- $this->assertEquals( 10, has_filter( 'od_url_metric_data_pre_storage', 'image_prioritizer_filter_url_metric_data_pre_storage' ) );`
	`17`	`+ $this->assertEquals( 10, has_filter( 'od_store_url_metric_data', 'image_prioritizer_filter_store_url_metric_data' ) );`
`18`	`18`	`}`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -216,7 +216,7 @@ function od_handle_rest_request( WP_REST_Request $request ) {`
`216`	`216`	`*`
`217`	`217`	`* @param array<string, mixed> $data URL Metric data. This is the Data type from OD_URL_Metric.`
`218`	`218`	`*/`
`219`		`- $data = apply_filters( 'od_url_metric_data_pre_storage', $data );`
	`219`	`+ $data = apply_filters( 'od_store_url_metric_data', $data );`
`220`	`220`
`221`	`221`	`// The "strict" URL Metric class is being used here to ensure additionalProperties of all objects are disallowed.`
`222`	`222`	`$url_metric = new OD_Strict_URL_Metric( $data );`