Introduce AMP_WP_Styles for doing enqueued scripts inline #887
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,216 @@ | ||
| <?php | ||
| /** | ||
| * Class AMP_WP_Styles | ||
| * | ||
| * @package AMP | ||
| */ | ||
|
|
||
| /** | ||
| * Extend WP_Styles with handling of CSS for AMP. | ||
| * | ||
| * @since 0.7 | ||
| */ | ||
| class AMP_WP_Styles extends WP_Styles { | ||
|
|
||
| /** | ||
| * Concatenation is always enabled for AMP. | ||
| * | ||
| * @since 0.7 | ||
| * @var bool | ||
| */ | ||
| public $do_concat = true; | ||
|
|
||
| /** | ||
| * Generates an enqueued style's fully-qualified file path. | ||
| * | ||
| * @since 0.7 | ||
| * @see WP_Styles::_css_href() | ||
| * | ||
| * @param string $src The source URL of the enqueued style. | ||
| * @param string $handle The style's registered handle. | ||
| * @return string|WP_Error Style's absolute validated filesystem path, or WP_Error when error. | ||
| */ | ||
| public function get_validated_css_file_path( $src, $handle ) { | ||
| if ( ! is_bool( $src ) && ! preg_match( '|^(https?:)?//|', $src ) && ! ( $this->content_url && 0 === strpos( $src, $this->content_url ) ) ) { | ||
|
There was a problem hiding this comment. Would be a bit more elegant to have the conditions with line breaks assigned to a variable. There was a problem hiding this comment. It's like this because it is forked/copied from core: https://github.com/WordPress/wordpress-develop/blob/4fb6c02b9961d41dcaaf0ea04e24223993fa8667/src/wp-includes/class.wp-styles.php#L327 |
||
| $src = $this->base_url . $src; | ||
| } | ||
|
|
||
| /** This filter is documented in wp-includes/class.wp-styles.php */ | ||
| $src = apply_filters( 'style_loader_src', $src, $handle ); | ||
|
|
||
| // Strip query and fragment from URL. | ||
| $src = preg_replace( ':[\?#].+:', '', $src ); | ||
|
|
||
| $src = esc_url_raw( $src ); | ||
|
There was a problem hiding this comment. Remove empty line above. |
||
|
|
||
| // @todo Explicitly not using includes_url() or content_url() since filters may point outside filesystem? | ||
| $includes_url = includes_url( '/' ); | ||
| $content_url = content_url( '/' ); | ||
| $admin_url = get_admin_url( null, '/' ); | ||
| $css_path = null; | ||
| if ( 0 === strpos( $src, $content_url ) ) { | ||
|
There was a problem hiding this comment. What if the assets are in root folder? For instance could use the filesystem to create dir and cache all CSS which is then enqueued. Here is a function which converts url to path, has be perfected over the years to fix all bugs reported on all sorts of various WP sites structure. Here are all the Unit Tests for it. There was a problem hiding this comment. No assets from core, themes or plugins would be in the root folder. So I don't think we should accommodate them. Since we're actually getting the file source from the filesystem (rather than relying on whether the requesting user has HTTP access) and outputting it, I think we should be very restrictive about what we allow. For example, if there was a There was a problem hiding this comment. Sounds good, I attempted to test on Windows as I recalled issues when doing URL to path replacements but gave up due to issues encountered when trying to run a stable local install on my virtual machine. I will leave that task to QA (Claudio). |
||
| $css_path = WP_CONTENT_DIR . substr( $src, strlen( $content_url ) - 1 ); | ||
| } elseif ( 0 === strpos( $src, $includes_url ) ) { | ||
| $css_path = ABSPATH . WPINC . substr( $src, strlen( $includes_url ) - 1 ); | ||
| } elseif ( 0 === strpos( $src, $admin_url ) ) { | ||
| $css_path = ABSPATH . 'wp-admin' . substr( $src, strlen( $admin_url ) - 1 ); | ||
| } | ||
|
|
||
| if ( ! preg_match( '/\.(css|less|scss|sass)$/i', $css_path ) ) { | ||
| /* translators: %1$s is stylesheet handle, %2$s is stylesheet URL */ | ||
| return new WP_Error( 'amp_css_bad_file_extension', sprintf( __( 'Skipped stylesheet %1$s which does not have recognized CSS file extension (%2$s).', 'amp' ), $handle, $src ) ); | ||
| } | ||
|
|
||
| if ( ! $css_path || false !== strpos( '../', $css_path ) || 0 !== validate_file( $css_path ) || ! file_exists( $css_path ) ) { | ||
| /* translators: %1$s is stylesheet handle, %2$s is stylesheet URL */ | ||
| return new WP_Error( 'amp_css_path_not_found', sprintf( __( 'Unable to locate filesystem path for stylesheet %1$s (%2$s).', 'amp' ), $handle, $src ) ); | ||
| } | ||
|
|
||
| return $css_path; | ||
| } | ||
|
|
||
| /** | ||
| * Processes a style dependency. | ||
| * | ||
| * @since 0.7 | ||
| * @see WP_Styles::do_item() | ||
| * | ||
| * @param string $handle The style's registered handle. | ||
| * @return bool True on success, false on failure. | ||
| */ | ||
| public function do_item( $handle ) { | ||
| if ( ! WP_Dependencies::do_item( $handle ) ) { | ||
| return false; | ||
| } | ||
| $obj = $this->registered[ $handle ]; | ||
|
|
||
| // Conditional styles and alternate styles aren't supported in AMP. | ||
| if ( isset( $obj->extra['conditional'] ) || isset( $obj->extra['alt'] ) ) { | ||
| return false; | ||
| } | ||
|
|
||
| if ( isset( $obj->args ) ) { | ||
| $media = esc_attr( $obj->args ); | ||
| } else { | ||
| $media = 'all'; | ||
| } | ||
|
|
||
| // A single item may alias a set of items, by having dependencies, but no source. | ||
| if ( ! $obj->src ) { | ||
| $inline_style = $this->print_inline_style( $handle, false ); | ||
| if ( $inline_style ) { | ||
| $this->print_code .= $inline_style; | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| $css_file_path = $this->get_validated_css_file_path( $obj->src, $handle ); | ||
| if ( is_wp_error( $css_file_path ) ) { | ||
| trigger_error( esc_html( $css_file_path->get_error_message() ), E_USER_WARNING ); // phpcs:ignore | ||
| return false; | ||
| } | ||
| $css_rtl_file_path = ''; | ||
|
|
||
| // Handle RTL styles. | ||
| if ( 'rtl' === $this->text_direction && isset( $obj->extra['rtl'] ) && $obj->extra['rtl'] ) { | ||
| if ( is_bool( $obj->extra['rtl'] ) || 'replace' === $obj->extra['rtl'] ) { | ||
| $suffix = isset( $obj->extra['suffix'] ) ? $obj->extra['suffix'] : ''; | ||
| $css_rtl_file_path = $this->get_validated_css_file_path( | ||
| str_replace( "{$suffix}.css", "-rtl{$suffix}.css", $obj->src ), | ||
| "$handle-rtl" | ||
| ); | ||
| } else { | ||
| $css_rtl_file_path = $this->get_validated_css_file_path( $obj->extra['rtl'], "$handle-rtl" ); | ||
| } | ||
|
|
||
| if ( is_wp_error( $css_rtl_file_path ) ) { | ||
| trigger_error( esc_html( $css_rtl_file_path->get_error_message() ), E_USER_WARNING ); // phpcs:ignore | ||
| $css_rtl_file_path = null; | ||
| } elseif ( 'replace' === $obj->extra['rtl'] ) { | ||
| $css_file_path = null; | ||
| } | ||
| } | ||
|
|
||
| // Load the CSS from the filesystem. | ||
| foreach ( array_filter( array( $css_file_path, $css_rtl_file_path ) ) as $css_path ) { | ||
| $css = file_get_contents( $css_path ); // phpcs:ignore -- It's a local filesystem path not a remote request. | ||
| if ( 'all' !== $media ) { | ||
| $css = sprintf( '@media %s { %s }', $media, $css ); | ||
| } | ||
| $this->print_code .= $css; | ||
| } | ||
|
|
||
| // Add inline styles. | ||
| $inline_style = $this->print_inline_style( $handle, false ); | ||
| if ( $inline_style ) { | ||
| $this->print_code .= $inline_style; | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * Whether the locale stylesheet was done. | ||
| * | ||
| * @since 0.7 | ||
| * @var bool | ||
| */ | ||
| protected $did_locale_stylesheet = false; | ||
|
There was a problem hiding this comment. I personally prefer keeping all variables declarations above the methods, specifically since it is the case in all the other plugin's classes. PS: this comment applies here too. |
||
|
|
||
| /** | ||
| * Get the locale stylesheet if it exists. | ||
| * | ||
| * @since 0.7 | ||
| * @see locale_stylesheet() | ||
| * @return bool Whether locale stylesheet was done. | ||
| */ | ||
| public function do_locale_stylesheet() { | ||
| if ( $this->did_locale_stylesheet ) { | ||
| return true; | ||
| } | ||
|
|
||
| $src = get_locale_stylesheet_uri(); | ||
| if ( ! $src ) { | ||
| return false; | ||
| } | ||
| $path = $this->get_validated_css_file_path( $src, get_stylesheet() . '-' . get_locale() ); | ||
| if ( is_wp_error( $path ) ) { | ||
| return false; | ||
| } | ||
| $this->print_code .= file_get_contents( $path ); // phpcs:ignore -- The path has been validated, and it is not a remote path. | ||
| $this->did_locale_stylesheet = true; | ||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * Whether the Custom CSS was done. | ||
| * | ||
| * @since 0.7 | ||
| * @var bool | ||
| */ | ||
| protected $did_custom_css = false; | ||
|
|
||
| /** | ||
| * Append Customizer Custom CSS. | ||
| * | ||
| * @since 0.7 | ||
| * @see wp_custom_css() | ||
| * @see wp_custom_css_cb() | ||
| * @return bool Whether locale Custom CSS was done. | ||
| */ | ||
| public function do_custom_css() { | ||
| if ( $this->did_custom_css ) { | ||
| return true; | ||
| } | ||
|
|
||
| $css = trim( wp_get_custom_css() ); | ||
| if ( ! $css ) { | ||
| return false; | ||
| } | ||
|
|
||
| $this->print_code .= $css; | ||
|
|
||
| $this->did_custom_css = true; | ||
| return true; | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
I think it would be safer to prevent the class from being initiated multiple times given that this method is
public static. It would be helpful to return the styles too, for testibily for example.