Issue #842: Use the constant CALLBACK_KEY.

Substitute all uses of 'remove_invalid_callback' With AMP_Validation_Utils::CALLBACK_KEY.
ampproject · Feb 20, 2018 · 6c587e2 · 6c587e2
1 parent afdefdf
commit 6c587e2
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 12 deletions.
diff --git a/includes/class-amp-theme-support.php b/includes/class-amp-theme-support.php
@@ -783,9 +783,9 @@ public static function prepare_response( $response, $args = array() ) {
 
 		$args = array_merge(
 			array(
-				'content_max_width'       => ! empty( $content_width ) ? $content_width : AMP_Post_Template::CONTENT_MAX_WIDTH, // Back-compat.
-				'use_document_element'    => true,
-				'remove_invalid_callback' => null,
+				'content_max_width'                => ! empty( $content_width ) ? $content_width : AMP_Post_Template::CONTENT_MAX_WIDTH, // Back-compat.
+				'use_document_element'             => true,
+				AMP_Validation_Utils::CALLBACK_KEY => null,
 			),
 			$args
 		);

diff --git a/includes/sanitizers/class-amp-base-sanitizer.php b/includes/sanitizers/class-amp-base-sanitizer.php
@@ -325,8 +325,8 @@ public function maybe_enforce_https_src( $src, $force_https = false ) {
 	 */
 	public function remove_invalid_child( $child ) {
 		$child->parentNode->removeChild( $child );
-		if ( isset( $this->args['remove_invalid_callback'] ) ) {
-			call_user_func( $this->args['remove_invalid_callback'], $child, $this->current_plugin_output );
+		if ( isset( $this->args[ AMP_Validation_Utils::CALLBACK_KEY ] ) ) {
+			call_user_func( $this->args[ AMP_Validation_Utils::CALLBACK_KEY ], $child, $this->current_plugin_output );
 		}
 	}
 
@@ -343,13 +343,13 @@ public function remove_invalid_child( $child ) {
 	 * @return void
 	 */
 	public function remove_invalid_attribute( $element, $attribute ) {
-		if ( isset( $this->args['remove_invalid_callback'] ) ) {
+		if ( isset( $this->args[ AMP_Validation_Utils::CALLBACK_KEY ] ) ) {
 			if ( is_string( $attribute ) ) {
 				$attribute = $element->getAttributeNode( $attribute );
 			}
 			if ( $attribute ) {
 				$element->removeAttributeNode( $attribute );
-				call_user_func( $this->args['remove_invalid_callback'], $attribute, $this->current_plugin_output );
+				call_user_func( $this->args[ AMP_Validation_Utils::CALLBACK_KEY ], $attribute, $this->current_plugin_output );
 			}
 		} elseif ( is_string( $attribute ) ) {
 			$element->removeAttribute( $attribute );

diff --git a/includes/utils/class-amp-validation-utils.php b/includes/utils/class-amp-validation-utils.php
@@ -125,8 +125,8 @@ public static function process_markup( $markup ) {
 		/** This filter is documented in wp-includes/post-template.php */
 		$markup = apply_filters( 'the_content', $markup );
 		$args   = array(
-			'content_max_width'       => ! empty( $content_width ) ? $content_width : AMP_Post_Template::CONTENT_MAX_WIDTH,
-			'remove_invalid_callback' => 'AMP_Validation_Utils::track_removed',
+			'content_max_width' => ! empty( $content_width ) ? $content_width : AMP_Post_Template::CONTENT_MAX_WIDTH,
+			self::CALLBACK_KEY  => 'AMP_Validation_Utils::track_removed',
 		);
 		AMP_Content_Sanitizer::sanitize( $markup, amp_get_content_sanitizers(), $args );
 	}

diff --git a/tests/test-class-amp-base-sanitizer.php b/tests/test-class-amp-base-sanitizer.php
@@ -256,7 +256,7 @@ public function test_remove_child() {
 
 		$this->assertEquals( $child, $parent->firstChild );
 		$sanitizer = new AMP_Iframe_Sanitizer( $dom_document, array(
-			'remove_invalid_callback' => 'AMP_Validation_Utils::track_removed',
+			AMP_Validation_Utils::CALLBACK_KEY => 'AMP_Validation_Utils::track_removed',
 		) );
 		$sanitizer->remove_invalid_child( $child );
 		$this->assertEquals( null, $parent->firstChild );
@@ -286,7 +286,7 @@ public function test_remove_attribute() {
 		$video->setAttribute( $attribute, 'someFunction()' );
 		$attr_node = $video->getAttributeNode( $attribute );
 		$args      = array(
-			'remove_invalid_callback' => 'AMP_Validation_Utils::track_removed',
+			AMP_Validation_Utils::CALLBACK_KEY => 'AMP_Validation_Utils::track_removed',
 		);
 		$sanitizer = new AMP_Video_Sanitizer( $dom_document, $args );
 		$sanitizer->remove_invalid_attribute( $video, $attribute );

diff --git a/tests/test-class-amp-theme-support.php b/tests/test-class-amp-theme-support.php
@@ -123,7 +123,7 @@ public function test_prepare_response() {
 		$original_html  = trim( ob_get_clean() );
 		$removed_nodes  = array();
 		$sanitized_html = AMP_Theme_Support::prepare_response( $original_html, array(
-			'remove_invalid_callback' => function( $node ) use ( &$removed_nodes ) {
+			AMP_Validation_Utils::CALLBACK_KEY => function( $node ) use ( &$removed_nodes ) {
 				$removed_nodes[ $node->nodeName ] = $node;
 			},
 		) );