Add initial canonical AMP support #857
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,220 @@ | ||
| <?php | ||
| /** | ||
| * Class AMP_Canonical_Mode_Actions | ||
| * | ||
| * @package AMP | ||
| */ | ||
|
|
||
| /** | ||
| * Class AMP_Canonical_Mode_Actions | ||
| * | ||
| * Callbacks for adding AMP-related things to the theme when in canonical mode. | ||
| */ | ||
| class AMP_Canonical_Mode_Actions { | ||
|
|
||
| const COMPONENT_SCRIPTS_PLACEHOLDER = '<!--AMP_COMPONENT_SCRIPTS_PLACEHOLDER-->'; | ||
|
|
||
| /** | ||
| * Register hooks. | ||
| */ | ||
| public static function register_hooks() { | ||
|
|
||
| // Remove core actions which are invalid AMP. | ||
| remove_action( 'wp_head', 'locale_stylesheet' ); | ||
| remove_action( 'wp_head', 'print_emoji_detection_script', 7 ); | ||
| remove_action( 'wp_head', 'wp_print_styles', 8 ); | ||
| remove_action( 'wp_head', 'wp_print_head_scripts', 9 ); | ||
| remove_action( 'wp_head', 'wp_custom_css_cb', 101 ); | ||
| remove_action( 'wp_footer', 'wp_print_footer_scripts', 20 ); | ||
| remove_action( 'wp_print_styles', 'print_emoji_styles' ); | ||
|
|
||
| // Replace core's canonical link functionality with one that outputs links for non-singular queries as well. See WP Core #18660. | ||
| remove_action( 'wp_head', 'rel_canonical' ); | ||
| add_action( 'wp_head', array( __CLASS__, 'rel_canonical' ), 1 ); | ||
|
|
||
| // Add additional markup required by AMP <https://www.ampproject.org/docs/reference/spec#required-markup>. | ||
| add_action( 'wp_head', array( __CLASS__, 'print_meta_charset' ), 0 ); | ||
| add_action( 'wp_head', array( __CLASS__, 'print_meta_viewport' ), 2 ); | ||
| add_action( 'wp_head', array( __CLASS__, 'print_amp_boilerplate_code' ), 3 ); | ||
| add_action( 'wp_head', array( __CLASS__, 'print_amp_scripts' ), 4 ); | ||
| add_action( 'wp_head', array( __CLASS__, 'print_amp_custom_style' ), 5 ); | ||
|
There was a problem hiding this comment. Thinks like There was a problem hiding this comment. Just not implemented yet. |
||
|
|
||
| /* | ||
| * Disable admin bar because admin-bar.css (28K) and Dashicons (48K) alone | ||
| * combine to surpass the 50K limit imposed for the amp-custom style. | ||
| */ | ||
| add_filter( 'show_admin_bar', '__return_false', 100 ); | ||
|
|
||
| add_action( 'template_redirect', array( __CLASS__, 'start_output_buffering' ) ); | ||
|
There was a problem hiding this comment. We could probably add a lower priority to make sure we catch everything, just in case a template is loading using the |
||
|
|
||
| // @todo Add output buffering. | ||
| // @todo Add character conversion. | ||
| } | ||
|
|
||
| /** | ||
| * Print meta charset tag. | ||
| * | ||
| * @link https://www.ampproject.org/docs/reference/spec#chrs | ||
| */ | ||
| public static function print_meta_charset() { | ||
| echo '<meta charset="utf-8">'; | ||
| } | ||
|
|
||
| /** | ||
| * Print meta charset tag. | ||
| * | ||
| * @link https://www.ampproject.org/docs/reference/spec#vprt | ||
| */ | ||
| public static function print_meta_viewport() { | ||
| echo '<meta name="viewport" content="width=device-width,minimum-scale=1">'; | ||
| } | ||
|
|
||
| /** | ||
| * Print AMP boilerplate code. | ||
| * | ||
| * @link https://www.ampproject.org/docs/reference/spec#boilerplate | ||
| */ | ||
| public static function print_amp_boilerplate_code() { | ||
|
There was a problem hiding this comment. This is a duplicate of this method, it will make it difficult to maintain. |
||
| echo '<style amp-boilerplate>body{-webkit-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-moz-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-ms-animation:-amp-start 8s steps(1,end) 0s 1 normal both;animation:-amp-start 8s steps(1,end) 0s 1 normal both}@-webkit-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-moz-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-ms-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-o-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}</style>'; | ||
| echo '<noscript><style amp-boilerplate>body{-webkit-animation:none;-moz-animation:none;-ms-animation:none;animation:none}</style></noscript>'; | ||
| } | ||
|
|
||
| /** | ||
| * Print AMP script and placeholder for others. | ||
| * | ||
| * @link https://www.ampproject.org/docs/reference/spec#scrpt | ||
| */ | ||
| public static function print_amp_scripts() { | ||
| echo '<script async src="https://cdn.ampproject.org/v0.js"></script>'; // phpcs:ignore WordPress.WP.EnqueuedResources.NonEnqueuedScript | ||
|
|
||
| // Replaced after output buffering with all AMP component scripts. | ||
| echo self::COMPONENT_SCRIPTS_PLACEHOLDER; // phpcs:ignore WordPress.Security.EscapeOutput, WordPress.XSS.EscapeOutput | ||
| } | ||
|
|
||
| /** | ||
| * Add canonical link. | ||
| * | ||
| * Replaces `rel_canonical()` which only outputs canonical URLs for singular posts and pages. | ||
| * This can be removed once WP Core #18660 lands. | ||
| * | ||
| * @link https://www.ampproject.org/docs/reference/spec#canon. | ||
| * @link https://core.trac.wordpress.org/ticket/18660 | ||
| * | ||
| * @see rel_canonical() | ||
| * @global WP $wp | ||
| * @global WP_Rewrite $wp_rewrite | ||
| */ | ||
| public static function rel_canonical() { | ||
| global $wp, $wp_rewrite; | ||
|
|
||
| $url = null; | ||
| if ( is_singular() ) { | ||
| $url = wp_get_canonical_url(); | ||
| } | ||
|
|
||
| // For non-singular queries, make use of the request URI and public query vars to determine canonical URL. | ||
| if ( empty( $url ) ) { | ||
| $added_query_vars = $wp->query_vars; | ||
| if ( ! $wp_rewrite->permalink_structure || empty( $wp->request ) ) { | ||
| $url = home_url( '/' ); | ||
| } else { | ||
| $url = home_url( user_trailingslashit( $wp->request ) ); | ||
| parse_str( $wp->matched_query, $matched_query_vars ); | ||
| foreach ( $wp->query_vars as $key => $value ) { | ||
|
|
||
| // Remove query vars that were matched in the rewrite rules for the request. | ||
| if ( isset( $matched_query_vars[ $key ] ) ) { | ||
| unset( $added_query_vars[ $key ] ); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if ( ! empty( $added_query_vars ) ) { | ||
| $url = add_query_arg( $added_query_vars, $url ); | ||
| } | ||
|
|
||
| echo '<link rel="canonical" href="' . esc_url( $url ) . '">' . "\n"; | ||
| } | ||
|
|
||
| /** | ||
| * Print Custom AMP styles. | ||
| * | ||
| * @see wp_custom_css_cb() | ||
| */ | ||
| public static function print_amp_custom_style() { | ||
| echo '<style amp-custom>'; | ||
|
|
||
| // @todo Grab source of all enqueued styles and concatenate here? | ||
| // @todo Print contents of get_locale_stylesheet_uri()? | ||
| // @todo Allow this to be filtered after output buffering is complete so additional styles can be added by widgets and other components just-in-time? | ||
| $path = get_template_directory() . '/style.css'; // @todo Honor filter in get_stylesheet_directory_uri()? Style must be local. | ||
| $css = file_get_contents( $path ); // phpcs:ignore WordPress.WP.AlternativeFunctions -- It's not a remote file. | ||
| echo wp_strip_all_tags( $css ); // WPCS: XSS OK. | ||
|
|
||
| // Implement AMP version of wp_custom_css_cb(). | ||
| $custom_css = trim( wp_get_custom_css() ); | ||
| if ( ! empty( $custom_css ) ) { | ||
| echo '/* start:wp_get_custom_css */'; | ||
| echo wp_strip_all_tags( wp_get_custom_css() ); // WPCS: XSS OK. | ||
| echo '/* end:wp_get_custom_css */'; | ||
| } | ||
| echo '</style>'; | ||
| } | ||
|
|
||
| /** | ||
| * Determine required AMP scripts. | ||
| * | ||
| * @param string $html Output HTML. | ||
| * @return string Scripts to inject into the HEAD. | ||
| */ | ||
| public function get_required_amp_scripts( $html ) { | ||
|
|
||
| // @todo This should be integrated with the existing Sanitizer classes so that duplication is not done here. | ||
| $amp_scripts = array( | ||
| 'amp-form' => array( | ||
| 'pattern' => '#<(form|input)\b#i', | ||
| 'source' => 'https://cdn.ampproject.org/v0/amp-form-0.1.js', | ||
| ), | ||
| // @todo Add more. | ||
| ); | ||
|
|
||
| $scripts = ''; | ||
| foreach ( $amp_scripts as $component => $props ) { | ||
| if ( preg_match( '#<(form|input)\b#i', $html ) ) { | ||
| $scripts .= sprintf( | ||
| '<script async custom-element="%s" src="%s"></script>', // phpcs:ignore WordPress.WP.EnqueuedResources, WordPress.XSS.EscapeOutput.OutputNotEscaped | ||
| $component, | ||
| $props['source'] | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| return $scripts; | ||
| } | ||
|
|
||
| /** | ||
| * Start output buffering. | ||
| */ | ||
| public static function start_output_buffering() { | ||
| ob_start( array( __CLASS__, 'finish_output_buffering' ) ); | ||
| } | ||
|
|
||
| /** | ||
| * Finish output buffering. | ||
| * | ||
| * @param string $output Buffered output. | ||
| * @return string Finalized output. | ||
| */ | ||
| public static function finish_output_buffering( $output ) { | ||
| $output = preg_replace( | ||
| '#' . preg_quote( self::COMPONENT_SCRIPTS_PLACEHOLDER, '#' ) . '#', | ||
| self::get_required_amp_scripts( $output ), | ||
| $output, | ||
| 1 | ||
| ); | ||
|
|
||
| // @todo Add more validation checking and potentially the whitelist sanitizer. | ||
| return $output; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| <?php | ||
| /** | ||
| * Class AMP_Paired_Mode_Actions | ||
| * | ||
| * @package AMP | ||
| */ | ||
|
|
||
| /** | ||
| * Class AMP_Paired_Mode_Actions | ||
| * | ||
| * Callbacks for adding AMP-related things to the theme when in paired mode, for themes that support amp. | ||
| */ | ||
| class AMP_Paired_Mode_Actions { | ||
|
|
||
| /** | ||
| * Register hooks. | ||
| */ | ||
| public static function register_hooks() { | ||
| // @todo See https://github.com/Automattic/amp-wp/issues/849. | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't this apply to paired mode too?