Merge pull request #6545 from ampproject/update/class-constant-usage

Use class constants instead of classes as string literals

Author: westonruter

includes/admin/functions.php

@@ -16,11 +16,11 @@
 function amp_init_customizer() {
 
 	// Fire up the AMP Customizer.
-	add_action( 'customize_register', [ 'AMP_Template_Customizer', 'init' ], 500 );
+	add_action( 'customize_register', [ AMP_Template_Customizer::class, 'init' ], 500 );
 
 	if ( amp_is_legacy() ) {
 		// Add some basic design settings + controls to the Customizer.
-		add_action( 'amp_init', [ 'AMP_Customizer_Design_Settings', 'init' ] );
+		add_action( 'amp_init', [ AMP_Customizer_Design_Settings::class, 'init' ] );
 	}
 
 	// Add a link to the AMP Customizer in Reader mode.

includes/amp-helper-functions.php

@@ -115,7 +115,7 @@ function amp_init() {
 	 */
 	do_action( 'amp_init' );
 
-	add_filter( 'allowed_redirect_hosts', [ 'AMP_HTTP', 'filter_allowed_redirect_hosts' ] );
+	add_filter( 'allowed_redirect_hosts', [ AMP_HTTP::class, 'filter_allowed_redirect_hosts' ] );
 	AMP_HTTP::purge_amp_query_vars();
 	AMP_HTTP::send_cors_headers();
 	AMP_HTTP::handle_xhr_request();
@@ -1322,27 +1322,27 @@ function amp_get_content_embed_handlers( $post = null ) {
 	return apply_filters(
 		'amp_content_embed_handlers',
 		[
-			'AMP_Core_Block_Handler'         => [],
-			'AMP_Twitter_Embed_Handler'      => [],
-			'AMP_YouTube_Embed_Handler'      => [],
-			'AMP_Crowdsignal_Embed_Handler'  => [],
-			'AMP_DailyMotion_Embed_Handler'  => [],
-			'AMP_Vimeo_Embed_Handler'        => [],
-			'AMP_SoundCloud_Embed_Handler'   => [],
-			'AMP_Instagram_Embed_Handler'    => [],
-			'AMP_Issuu_Embed_Handler'        => [],
-			'AMP_Meetup_Embed_Handler'       => [],
-			'AMP_Facebook_Embed_Handler'     => [],
-			'AMP_Pinterest_Embed_Handler'    => [],
-			'AMP_Playlist_Embed_Handler'     => [],
-			'AMP_Reddit_Embed_Handler'       => [],
-			'AMP_TikTok_Embed_Handler'       => [],
-			'AMP_Tumblr_Embed_Handler'       => [],
-			'AMP_Gallery_Embed_Handler'      => [],
-			'AMP_Gfycat_Embed_Handler'       => [],
-			'AMP_Imgur_Embed_Handler'        => [],
-			'AMP_Scribd_Embed_Handler'       => [],
-			'AMP_WordPress_TV_Embed_Handler' => [],
+			AMP_Core_Block_Handler::class         => [],
+			AMP_Twitter_Embed_Handler::class      => [],
+			AMP_YouTube_Embed_Handler::class      => [],
+			AMP_Crowdsignal_Embed_Handler::class  => [],
+			AMP_DailyMotion_Embed_Handler::class  => [],
+			AMP_Vimeo_Embed_Handler::class        => [],
+			AMP_SoundCloud_Embed_Handler::class   => [],
+			AMP_Instagram_Embed_Handler::class    => [],
+			AMP_Issuu_Embed_Handler::class        => [],
+			AMP_Meetup_Embed_Handler::class       => [],
+			AMP_Facebook_Embed_Handler::class     => [],
+			AMP_Pinterest_Embed_Handler::class    => [],
+			AMP_Playlist_Embed_Handler::class     => [],
+			AMP_Reddit_Embed_Handler::class       => [],
+			AMP_TikTok_Embed_Handler::class       => [],
+			AMP_Tumblr_Embed_Handler::class       => [],
+			AMP_Gallery_Embed_Handler::class      => [],
+			AMP_Gfycat_Embed_Handler::class       => [],
+			AMP_Imgur_Embed_Handler::class        => [],
+			AMP_Scribd_Embed_Handler::class       => [],
+			AMP_WordPress_TV_Embed_Handler::class => [],
 		],
 		$post
 	);
@@ -1478,60 +1478,60 @@ function amp_get_content_sanitizers( $post = null ) {
 	$native_post_forms_allowed = amp_is_native_post_form_allowed();
 
 	$sanitizers = [
-		'AMP_Embed_Sanitizer'             => [
+		AMP_Embed_Sanitizer::class             => [
 			'amp_to_amp_linking_enabled' => $amp_to_amp_linking_enabled,
 		],
-		'AMP_Core_Theme_Sanitizer'        => [
+		AMP_Core_Theme_Sanitizer::class        => [
 			'template'        => get_template(),
 			'stylesheet'      => get_stylesheet(),
 			'theme_features'  => [
 				'force_svg_support' => [], // Always replace 'no-svg' class with 'svg' if it exists.
 			],
 			'native_img_used' => $native_img_used,
 		],
-		'AMP_Srcset_Sanitizer'            => [],
-		'AMP_Img_Sanitizer'               => [
+		AMP_Srcset_Sanitizer::class            => [],
+		AMP_Img_Sanitizer::class               => [
 			'align_wide_support' => current_theme_supports( 'align-wide' ),
 			'native_img_used'    => $native_img_used,
 		],
-		'AMP_Form_Sanitizer'              => [
+		AMP_Form_Sanitizer::class              => [
 			'native_post_forms_allowed' => $native_post_forms_allowed,
 		],
-		'AMP_Comments_Sanitizer'          => [
+		AMP_Comments_Sanitizer::class          => [
 			'comments_live_list' => ! empty( $theme_support_args['comments_live_list'] ),
 		],
-		'AMP_Video_Sanitizer'             => [],
-		'AMP_O2_Player_Sanitizer'         => [],
-		'AMP_Audio_Sanitizer'             => [],
-		'AMP_Playbuzz_Sanitizer'          => [],
-		'AMP_Object_Sanitizer'            => [],
-		'AMP_Iframe_Sanitizer'            => [
+		AMP_Video_Sanitizer::class             => [],
+		AMP_O2_Player_Sanitizer::class         => [],
+		AMP_Audio_Sanitizer::class             => [],
+		AMP_Playbuzz_Sanitizer::class          => [],
+		AMP_Object_Sanitizer::class            => [],
+		AMP_Iframe_Sanitizer::class            => [
 			'add_placeholder'    => true,
 			'current_origin'     => $current_origin,
 			'align_wide_support' => current_theme_supports( 'align-wide' ),
 		],
-		'AMP_Gallery_Block_Sanitizer'     => [ // Note: Gallery block sanitizer must come after image sanitizers since itś logic is using the already sanitized images.
+		AMP_Gallery_Block_Sanitizer::class     => [ // Note: Gallery block sanitizer must come after image sanitizers since itś logic is using the already sanitized images.
 			'carousel_required' => ! is_array( $theme_support_args ), // For back-compat.
 			'native_img_used'   => $native_img_used,
 		],
-		'AMP_Block_Sanitizer'             => [], // Note: Block sanitizer must come after embed / media sanitizers since its logic is using the already sanitized content.
-		'AMP_Script_Sanitizer'            => [],
-		'AMP_Style_Sanitizer'             => [],
-		'AMP_Meta_Sanitizer'              => [],
-		'AMP_Layout_Sanitizer'            => [],
-		'AMP_Accessibility_Sanitizer'     => [],
+		AMP_Block_Sanitizer::class             => [], // Note: Block sanitizer must come after embed / media sanitizers since its logic is using the already sanitized content.
+		AMP_Script_Sanitizer::class            => [],
+		AMP_Style_Sanitizer::class             => [],
+		AMP_Meta_Sanitizer::class              => [],
+		AMP_Layout_Sanitizer::class            => [],
+		AMP_Accessibility_Sanitizer::class     => [],
 		// Note: This validating sanitizer must come at the end to clean up any remaining issues the other sanitizers didn't catch.
-		'AMP_Tag_And_Attribute_Sanitizer' => [
+		AMP_Tag_And_Attribute_Sanitizer::class => [
 			'prefer_bento' => amp_is_bento_enabled(),
 		],
 	];
 
 	if ( ! empty( $theme_support_args['nav_menu_toggle'] ) ) {
-		$sanitizers['AMP_Nav_Menu_Toggle_Sanitizer'] = $theme_support_args['nav_menu_toggle'];
+		$sanitizers[ AMP_Nav_Menu_Toggle_Sanitizer::class ] = $theme_support_args['nav_menu_toggle'];
 	}
 
 	if ( ! empty( $theme_support_args['nav_menu_dropdown'] ) ) {
-		$sanitizers['AMP_Nav_Menu_Dropdown_Sanitizer'] = $theme_support_args['nav_menu_dropdown'];
+		$sanitizers[ AMP_Nav_Menu_Dropdown_Sanitizer::class ] = $theme_support_args['nav_menu_dropdown'];
 	}
 
 	if ( $amp_to_amp_linking_enabled && AMP_Theme_Support::STANDARD_MODE_SLUG !== AMP_Options_Manager::get_option( Option::THEME_SUPPORT ) ) {
@@ -1550,7 +1550,7 @@ function amp_get_content_sanitizers( $post = null ) {
 		 */
 		$excluded_urls = apply_filters( 'amp_to_amp_excluded_urls', [] );
 
-		$sanitizers['AMP_Link_Sanitizer'] = array_merge(
+		$sanitizers[ AMP_Link_Sanitizer::class ] = array_merge(
 			[ 'paired' => ! amp_is_canonical() ],
 			compact( 'excluded_urls' )
 		);
@@ -1601,7 +1601,7 @@ function amp_get_content_sanitizers( $post = null ) {
 
 		$sanitizers = array_merge(
 			[
-				'AMP_Dev_Mode_Sanitizer' => [
+				AMP_Dev_Mode_Sanitizer::class => [
 					'element_xpaths' => $dev_mode_xpaths,
 				],
 			],
@@ -1618,10 +1618,10 @@ function amp_get_content_sanitizers( $post = null ) {
 	 * @since 1.5.0
 	 * @param bool $transient_caching_allowed Transient caching allowed.
 	 */
-	$sanitizers['AMP_Style_Sanitizer']['allow_transient_caching'] = apply_filters( 'amp_parsed_css_transient_caching_allowed', true );
+	$sanitizers[ AMP_Style_Sanitizer::class ]['allow_transient_caching'] = apply_filters( 'amp_parsed_css_transient_caching_allowed', true );
 
 	// Force layout, style, meta, and validating sanitizers to be at the end.
-	foreach ( [ 'AMP_Layout_Sanitizer', 'AMP_Style_Sanitizer', 'AMP_Meta_Sanitizer', 'AMP_Tag_And_Attribute_Sanitizer' ] as $class_name ) {
+	foreach ( [ AMP_Layout_Sanitizer::class, AMP_Style_Sanitizer::class, AMP_Meta_Sanitizer::class, AMP_Tag_And_Attribute_Sanitizer::class ] as $class_name ) {
 		if ( isset( $sanitizers[ $class_name ] ) ) {
 			$sanitizer = $sanitizers[ $class_name ];
 			unset( $sanitizers[ $class_name ] );

includes/amp-post-template-functions.php

@@ -26,7 +26,7 @@ function amp_post_template_init_hooks() {
 	add_action( 'amp_post_template_css', 'amp_post_template_add_styles', 99 );
 	add_action( 'amp_post_template_footer', 'amp_post_template_add_analytics_data' );
 
-	add_action( 'admin_bar_init', [ 'AMP_Theme_Support', 'init_admin_bar' ] );
+	add_action( 'admin_bar_init', [ AMP_Theme_Support::class, 'init_admin_bar' ] );
 	add_action( 'amp_post_template_footer', 'wp_admin_bar_render' );
 
 	// Printing scripts here is done primarily for the benefit of the admin bar. Note that wp_enqueue_scripts() is not called.

includes/class-amp-comment-walker.php

@@ -8,7 +8,7 @@
  */
 
 /* translators: 1: AMP_Comment_Walker. 2: AMP_Comments_Sanitizer. */
-_deprecated_file( __FILE__, '1.1', null, sprintf( esc_html__( '%1$s functionality has been moved to %2$s.', 'amp' ), 'AMP_Comment_Walker', 'AMP_Comments_Sanitizer' ) );
+_deprecated_file( __FILE__, '1.1', null, esc_html( sprintf( __( '%1$s functionality has been moved to %2$s.', 'amp' ), AMP_Comment_Walker::class, AMP_Comments_Sanitizer::class ) ) );
 
 /**
  * Class AMP_Comment_Walker

includes/class-amp-theme-support.php

@@ -351,7 +351,7 @@ static function() {
 		self::$sanitizer_classes = amp_get_content_sanitizers();
 		self::$sanitizer_classes = AMP_Validation_Manager::filter_sanitizer_args( self::$sanitizer_classes );
 		self::$embed_handlers    = self::register_content_embed_handlers();
-		self::$sanitizer_classes['AMP_Embed_Sanitizer']['embed_handlers'] = self::$embed_handlers;
+		self::$sanitizer_classes[ AMP_Embed_Sanitizer::class ]['embed_handlers'] = self::$embed_handlers;
 
 		foreach ( self::$sanitizer_classes as $sanitizer_class => $args ) {
 			if ( method_exists( $sanitizer_class, 'add_buffering_hooks' ) ) {
@@ -994,10 +994,10 @@ public static function register_content_embed_handlers() {
 					__METHOD__,
 					esc_html(
 						sprintf(
-							/* translators: 1: embed handler. 2: AMP_Embed_Handler */
+							/* translators: 1: embed handler. 2: AMP_Base_Embed_Handler */
 							__( 'Embed Handler (%1$s) must extend `%2$s`', 'amp' ),
 							esc_html( $embed_handler_class ),
-							'AMP_Embed_Handler'
+							AMP_Base_Embed_Handler::class
 						)
 					),
 					'0.1'

includes/templates/class-amp-content-sanitizer.php

@@ -99,7 +99,7 @@ public static function sanitize_document( Document $dom, $sanitizer_classes, $ar
 							/* translators: 1: sanitizer class. 2: AMP_Base_Sanitizer */
 							__( 'Sanitizer (%1$s) must extend `%2$s`', 'amp' ),
 							esc_html( $sanitizer_class ),
-							'AMP_Base_Sanitizer'
+							AMP_Base_Sanitizer::class
 						)
 					),
 					'0.1'

includes/templates/class-amp-content.php

@@ -78,7 +78,7 @@ public function __construct( $content, $embed_handler_classes, $sanitizer_classe
 		$this->embed_handlers    = $this->register_embed_handlers( $embed_handler_classes );
 		$this->sanitizer_classes = $sanitizer_classes;
 
-		$this->sanitizer_classes['AMP_Embed_Sanitizer']['embed_handlers'] = $this->embed_handlers;
+		$this->sanitizer_classes[ AMP_Embed_Sanitizer::class ]['embed_handlers'] = $this->embed_handlers;
 
 		$this->transform();
 	}
@@ -175,10 +175,10 @@ private function register_embed_handlers( $embed_handler_classes ) {
 					__METHOD__,
 					esc_html(
 						sprintf(
-							/* translators: 1: embed handler. 2: AMP_Embed_Handler */
+							/* translators: 1: embed handler. 2: AMP_Base_Embed_Handler */
 							__( 'Embed Handler (%1$s) must extend `%2$s`', 'amp' ),
 							esc_html( $embed_handler_class ),
-							'AMP_Embed_Handler'
+							AMP_Base_Embed_Handler::class
 						)
 					),
 					'0.1'

includes/validation/class-amp-validation-callback-wrapper.php

@@ -88,7 +88,7 @@ protected function prepare( ...$args ) {
 		// Wrap the markup output of (action) hooks in source comments.
 		AMP_Validation_Manager::$hook_source_stack[] = $this->callback['source'];
 		if ( ! $is_filter && AMP_Validation_Manager::can_output_buffer() ) {
-			$has_buffer_started = ob_start( [ 'AMP_Validation_Manager', 'wrap_buffer_with_source_comments' ] );
+			$has_buffer_started = ob_start( [ AMP_Validation_Manager::class, 'wrap_buffer_with_source_comments' ] );
 		} else {
 			$has_buffer_started = false;
 		}

includes/validation/class-amp-validation-manager.php

@@ -1699,8 +1699,8 @@ public static function filter_sanitizer_args( $sanitizers ) {
 			$args['validation_error_callback'] = __CLASS__ . '::add_validation_error';
 		}
 
-		if ( isset( $sanitizers['AMP_Style_Sanitizer'] ) ) {
-			$sanitizers['AMP_Style_Sanitizer']['should_locate_sources'] = self::$is_validate_request;
+		if ( isset( $sanitizers[ AMP_Style_Sanitizer::class ] ) ) {
+			$sanitizers[ AMP_Style_Sanitizer::class ]['should_locate_sources'] = self::$is_validate_request;
 
 			$css_validation_errors = [];
 			foreach ( self::$validation_error_status_overrides as $slug => $status ) {
@@ -1722,7 +1722,7 @@ public static function filter_sanitizer_args( $sanitizers ) {
 				}
 			}
 			if ( ! empty( $css_validation_errors ) ) {
-				$sanitizers['AMP_Style_Sanitizer']['parsed_cache_variant'] = md5( wp_json_encode( $css_validation_errors ) );
+				$sanitizers[ AMP_Style_Sanitizer::class ]['parsed_cache_variant'] = md5( wp_json_encode( $css_validation_errors ) );
 			}
 		}