| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548 |
- <?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
- use Automattic\Jetpack\Assets;
- use Automattic\Jetpack\Sync\Functions;
- /**
- * Manages compatibility with the amp-wp plugin
- *
- * @see https://github.com/Automattic/amp-wp
- */
- class Jetpack_AMP_Support {
- /**
- * Apply custom AMP changes on the front-end.
- */
- public static function init() {
- // Add Stats tracking pixel on Jetpack sites when the Stats module is active.
- if (
- Jetpack::is_module_active( 'stats' )
- && ! ( defined( 'IS_WPCOM' ) && IS_WPCOM )
- ) {
- add_action( 'amp_post_template_footer', array( 'Jetpack_AMP_Support', 'add_stats_pixel' ) );
- }
- /**
- * Remove this during the init hook in case users have enabled it during
- * the after_setup_theme hook, which triggers before init.
- */
- remove_theme_support( 'jetpack-devicepx' );
- // Sharing.
- add_filter( 'jetpack_sharing_display_markup', array( 'Jetpack_AMP_Support', 'render_sharing_html' ), 10, 2 );
- add_filter( 'sharing_enqueue_scripts', array( 'Jetpack_AMP_Support', 'amp_disable_sharedaddy_css' ) );
- add_action( 'wp_enqueue_scripts', array( 'Jetpack_AMP_Support', 'amp_enqueue_sharing_css' ) );
- // Sharing for Reader mode.
- if ( function_exists( 'jetpack_social_menu_include_svg_icons' ) ) {
- add_action( 'amp_post_template_footer', 'jetpack_social_menu_include_svg_icons' );
- }
- add_action( 'amp_post_template_css', array( 'Jetpack_AMP_Support', 'amp_reader_sharing_css' ), 10, 0 );
- // enforce freedom mode for videopress.
- add_filter( 'videopress_shortcode_options', array( 'Jetpack_AMP_Support', 'videopress_enable_freedom_mode' ) );
- // include Jetpack og tags when rendering native AMP head.
- add_action( 'amp_post_template_head', array( 'Jetpack_AMP_Support', 'amp_post_jetpack_og_tags' ) );
- // Post rendering changes for legacy AMP.
- add_action( 'pre_amp_render_post', array( 'Jetpack_AMP_Support', 'amp_disable_the_content_filters' ) );
- // Disable Comment Likes.
- add_filter( 'jetpack_comment_likes_enabled', array( 'Jetpack_AMP_Support', 'comment_likes_enabled' ) );
- // Transitional mode AMP should not have comment likes.
- add_filter( 'the_content', array( 'Jetpack_AMP_Support', 'disable_comment_likes_before_the_content' ) );
- // Remove the Likes button from the admin bar.
- add_filter( 'jetpack_admin_bar_likes_enabled', array( 'Jetpack_AMP_Support', 'disable_likes_admin_bar' ) );
- // Add post template metadata for legacy AMP.
- add_filter( 'amp_post_template_metadata', array( 'Jetpack_AMP_Support', 'amp_post_template_metadata' ), 10, 2 );
- // Filter photon image args for AMP Stories.
- add_filter( 'jetpack_photon_post_image_args', array( 'Jetpack_AMP_Support', 'filter_photon_post_image_args_for_stories' ), 10, 2 );
- // Sync the amp-options.
- add_filter( 'jetpack_options_whitelist', array( 'Jetpack_AMP_Support', 'filter_jetpack_options_safelist' ) );
- }
- /**
- * Disable the Comment Likes feature on AMP views.
- *
- * @param bool $enabled Should comment likes be enabled.
- */
- public static function comment_likes_enabled( $enabled ) {
- return $enabled && ! self::is_amp_request();
- }
- /**
- * Apply custom AMP changes in wp-admin.
- */
- public static function admin_init() {
- // disable Likes metabox for post editor if AMP canonical disabled.
- add_filter( 'post_flair_disable', array( 'Jetpack_AMP_Support', 'is_amp_canonical' ), 99 );
- }
- /**
- * Is the page in AMP 'canonical mode'.
- * Used when themes register support for AMP with `add_theme_support( 'amp' )`.
- *
- * @return bool is_amp_canonical
- */
- public static function is_amp_canonical() {
- return function_exists( 'amp_is_canonical' ) && amp_is_canonical();
- }
- /**
- * Is AMP available for this request
- * This returns false for admin, CLI requests etc.
- *
- * @return bool is_amp_available
- */
- public static function is_amp_available() {
- return ( function_exists( 'amp_is_available' ) && amp_is_available() );
- }
- /**
- * Does the page return AMP content.
- *
- * @return bool $is_amp_request Are we on am AMP view.
- */
- public static function is_amp_request() {
- $is_amp_request = ( function_exists( 'is_amp_endpoint' ) && is_amp_endpoint() );
- /**
- * Returns true if the current request should return valid AMP content.
- *
- * @since 6.2.0
- *
- * @param boolean $is_amp_request Is this request supposed to return valid AMP content?
- */
- return apply_filters( 'jetpack_is_amp_request', $is_amp_request );
- }
- /**
- * Remove content filters added by Jetpack.
- */
- public static function amp_disable_the_content_filters() {
- if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
- add_filter( 'videopress_show_2015_player', '__return_true' );
- add_filter( 'protected_embeds_use_form_post', '__return_false' );
- remove_filter( 'the_title', 'widont' );
- }
- remove_filter( 'pre_kses', array( 'Filter_Embedded_HTML_Objects', 'filter' ), 11 );
- remove_filter( 'pre_kses', array( 'Filter_Embedded_HTML_Objects', 'maybe_create_links' ), 100 );
- }
- /**
- * Do not add comment likes on AMP requests.
- *
- * @param string $content Post content.
- */
- public static function disable_comment_likes_before_the_content( $content ) {
- if ( self::is_amp_request() ) {
- remove_filter( 'comment_text', 'comment_like_button', 12, 2 );
- }
- return $content;
- }
- /**
- * Do not display the Likes' Admin bar on AMP requests.
- *
- * @param bool $is_admin_bar_button_visible Should the Like button be visible in the Admin bar. Default to true.
- */
- public static function disable_likes_admin_bar( $is_admin_bar_button_visible ) {
- if ( self::is_amp_request() ) {
- return false;
- }
- return $is_admin_bar_button_visible;
- }
- /**
- * Add Jetpack stats pixel.
- *
- * @since 6.2.1
- */
- public static function add_stats_pixel() {
- if ( ! has_action( 'wp_footer', 'stats_footer' ) ) {
- return;
- }
- stats_render_amp_footer( stats_build_view_data() );
- }
- /**
- * Add publisher and image metadata to legacy AMP post.
- *
- * @since 6.2.0
- *
- * @param array $metadata Metadata array.
- * @param WP_Post $post Post.
- * @return array Modified metadata array.
- */
- public static function amp_post_template_metadata( $metadata, $post ) {
- if ( isset( $metadata['publisher'] ) && ! isset( $metadata['publisher']['logo'] ) ) {
- $metadata = self::add_site_icon_to_metadata( $metadata );
- }
- if ( ! isset( $metadata['image'] ) && ! empty( $post ) ) {
- $metadata = self::add_image_to_metadata( $metadata, $post );
- }
- return $metadata;
- }
- /**
- * Add blavatar to legacy AMP post metadata.
- *
- * @since 6.2.0
- *
- * @param array $metadata Metadata.
- *
- * @return array Metadata.
- */
- private static function add_site_icon_to_metadata( $metadata ) {
- $size = 60;
- $site_icon_url = class_exists( 'Automattic\\Jetpack\\Sync\\Functions' ) ? Functions::site_icon_url( $size ) : '';
- if ( function_exists( 'blavatar_domain' ) ) {
- $metadata['publisher']['logo'] = array(
- '@type' => 'ImageObject',
- 'url' => blavatar_url( blavatar_domain( site_url() ), 'img', $size, self::staticize_subdomain( 'https://wordpress.com/i/favicons/apple-touch-icon-60x60.png' ) ),
- 'width' => $size,
- 'height' => $size,
- );
- } elseif ( $site_icon_url ) {
- $metadata['publisher']['logo'] = array(
- '@type' => 'ImageObject',
- 'url' => $site_icon_url,
- 'width' => $size,
- 'height' => $size,
- );
- }
- return $metadata;
- }
- /**
- * Add image to legacy AMP post metadata.
- *
- * @since 6.2.0
- *
- * @param array $metadata Metadata.
- * @param WP_Post $post Post.
- * @return array Metadata.
- */
- private static function add_image_to_metadata( $metadata, $post ) {
- $image = Jetpack_PostImages::get_image(
- $post->ID,
- array(
- 'fallback_to_avatars' => true,
- 'avatar_size' => 200,
- // AMP already attempts these.
- 'from_thumbnail' => false,
- 'from_attachment' => false,
- )
- );
- if ( empty( $image ) ) {
- return self::add_fallback_image_to_metadata( $metadata );
- }
- if ( ! isset( $image['src_width'] ) ) {
- $dimensions = self::extract_image_dimensions_from_getimagesize(
- array(
- $image['src'] => false,
- )
- );
- if ( false !== $dimensions[ $image['src'] ] ) {
- $image['src_width'] = $dimensions['width'];
- $image['src_height'] = $dimensions['height'];
- }
- }
- $metadata['image'] = array(
- '@type' => 'ImageObject',
- 'url' => $image['src'],
- );
- if ( isset( $image['src_width'] ) ) {
- $metadata['image']['width'] = $image['src_width'];
- }
- if ( isset( $image['src_width'] ) ) {
- $metadata['image']['height'] = $image['src_height'];
- }
- return $metadata;
- }
- /**
- * Add fallback image to legacy AMP post metadata.
- *
- * @since 6.2.0
- *
- * @param array $metadata Metadata.
- * @return array Metadata.
- */
- private static function add_fallback_image_to_metadata( $metadata ) {
- /** This filter is documented in functions.opengraph.php */
- $default_image = apply_filters( 'jetpack_open_graph_image_default', 'https://wordpress.com/i/blank.jpg' );
- $metadata['image'] = array(
- '@type' => 'ImageObject',
- 'url' => self::staticize_subdomain( $default_image ),
- 'width' => 200,
- 'height' => 200,
- );
- return $metadata;
- }
- /**
- * Return static WordPress.com domain to use to load resources from WordPress.com.
- *
- * @param string $domain Asset URL.
- */
- private static function staticize_subdomain( $domain ) {
- // deal with WPCOM vs Jetpack.
- if ( function_exists( 'staticize_subdomain' ) ) {
- return staticize_subdomain( $domain );
- } else {
- return Assets::staticize_subdomain( $domain );
- }
- }
- /**
- * Extract image dimensions via wpcom/imagesize, only on WPCOM
- *
- * @since 6.2.0
- *
- * @param array $dimensions Dimensions.
- * @return array Dimensions.
- */
- private static function extract_image_dimensions_from_getimagesize( $dimensions ) {
- if ( ! ( defined( 'IS_WPCOM' ) && IS_WPCOM && function_exists( 'jetpack_require_lib' ) ) ) {
- return $dimensions;
- }
- jetpack_require_lib( 'wpcom/imagesize' );
- foreach ( $dimensions as $url => $value ) {
- if ( is_array( $value ) ) {
- continue;
- }
- $result = wpcom_getimagesize( $url );
- if ( is_array( $result ) ) {
- $dimensions[ $url ] = array(
- 'width' => $result[0],
- 'height' => $result[1],
- );
- }
- }
- return $dimensions;
- }
- /**
- * Display Open Graph Meta tags in AMP views.
- */
- public static function amp_post_jetpack_og_tags() {
- if ( ! ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ) {
- Jetpack::init()->check_open_graph();
- }
- if ( function_exists( 'jetpack_og_tags' ) ) {
- jetpack_og_tags();
- }
- }
- /**
- * Force Freedom mode in VideoPress.
- *
- * @param array $options Array of VideoPress shortcode options.
- */
- public static function videopress_enable_freedom_mode( $options ) {
- if ( self::is_amp_request() ) {
- $options['freedom'] = true;
- }
- return $options;
- }
- /**
- * Display custom markup for the sharing buttons when in an AMP view.
- *
- * @param string $markup Content markup of the Jetpack sharing links.
- * @param array $sharing_enabled Array of Sharing Services currently enabled.
- */
- public static function render_sharing_html( $markup, $sharing_enabled ) {
- global $post;
- if ( empty( $post ) ) {
- return '';
- }
- if ( ! self::is_amp_request() ) {
- return $markup;
- }
- remove_action( 'wp_footer', 'sharing_add_footer' );
- if ( empty( $sharing_enabled ) ) {
- return $markup;
- }
- $sharing_links = array();
- foreach ( $sharing_enabled['visible'] as $service ) {
- $sharing_link = $service->get_amp_display( $post );
- if ( ! empty( $sharing_link ) ) {
- $sharing_links[] = $sharing_link;
- }
- }
- // Replace the existing unordered list with AMP sharing buttons.
- $markup = preg_replace( '#<ul>(.+)</ul>#', implode( '', $sharing_links ), $markup );
- // Remove any lingering share-end list items.
- $markup = str_replace( '<li class="share-end"></li>', '', $markup );
- return $markup;
- }
- /**
- * Tells Jetpack not to enqueue CSS for share buttons.
- *
- * @param bool $enqueue Whether or not to enqueue.
- * @return bool Whether or not to enqueue.
- */
- public static function amp_disable_sharedaddy_css( $enqueue ) {
- if ( self::is_amp_request() ) {
- $enqueue = false;
- }
- return $enqueue;
- }
- /**
- * Enqueues the AMP specific sharing styles for the sharing icons.
- */
- public static function amp_enqueue_sharing_css() {
- if ( self::is_amp_request() ) {
- wp_enqueue_style( 'sharedaddy-amp', plugin_dir_url( __DIR__ ) . 'modules/sharedaddy/amp-sharing.css', array( 'social-logos' ), JETPACK__VERSION );
- }
- }
- /**
- * For the AMP Reader mode template, include styles that we need.
- */
- public static function amp_reader_sharing_css() {
- // If sharing is not enabled, we should not proceed to render the CSS.
- if ( ! defined( 'JETPACK_SOCIAL_LOGOS_DIR' ) | ! defined( 'JETPACK_SOCIAL_LOGOS_URL' ) || ! defined( 'WP_SHARING_PLUGIN_DIR' ) ) {
- return;
- }
- /*
- * We'll need to output the full contents of the 2 files
- * in the head on AMP views. We can't rely on regular enqueues here.
- * @todo As of AMP plugin v1.5, you can actually rely on regular enqueues thanks to https://github.com/ampproject/amp-wp/pull/4299. Once WPCOM upgrades AMP, then this method can be eliminated.
- *
- * phpcs:disable WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
- * phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
- */
- $css = file_get_contents( JETPACK_SOCIAL_LOGOS_DIR . 'social-logos.css' );
- $css = preg_replace( '#(?<=url\(")(?=social-logos\.)#', JETPACK_SOCIAL_LOGOS_URL, $css ); // Make sure font files get their absolute paths.
- echo $css;
- echo file_get_contents( WP_SHARING_PLUGIN_DIR . 'amp-sharing.css' );
- /*
- * phpcs:enable WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
- * phpcs:enable WordPress.Security.EscapeOutput.OutputNotEscaped
- */
- }
- /**
- * Ensure proper Photon image dimensions for AMP Stories.
- *
- * @param array $args Array of Photon Arguments.
- * @param array $details {
- * Array of image details.
- *
- * @type string $tag Image tag (Image HTML output).
- * @type string $src Image URL.
- * @type string $src_orig Original Image URL.
- * @type int|false $width Image width.
- * @type int|false $height Image height.
- * @type int|false $width_orig Original image width before constrained by content_width.
- * @type int|false $height_orig Original Image height before constrained by content_width.
- * @type string $transform_orig Original transform before constrained by content_width.
- * }
- * @return array Args.
- */
- public static function filter_photon_post_image_args_for_stories( $args, $details ) {
- if ( ! is_singular( 'amp_story' ) ) {
- return $args;
- }
- // Percentage-based dimensions are not allowed in AMP, so this shouldn't happen, but short-circuit just in case.
- if ( false !== strpos( $details['width_orig'], '%' ) || false !== strpos( $details['height_orig'], '%' ) ) {
- return $args;
- }
- $max_height = 1280; // See image size with the slug \AMP_Story_Post_Type::MAX_IMAGE_SIZE_SLUG.
- $transform = $details['transform_orig'];
- $width = $details['width_orig'];
- $height = $details['height_orig'];
- // If height is available, constrain to $max_height.
- if ( false !== $height ) {
- if ( $height > $max_height && false !== $height ) {
- $width = ( $max_height * $width ) / $height;
- $height = $max_height;
- } elseif ( $height > $max_height ) {
- $height = $max_height;
- }
- }
- /*
- * Set a height if none is found.
- * If height is set in this manner and height is available, use `fit` instead of `resize` to prevent skewing.
- */
- if ( false === $height ) {
- $height = $max_height;
- if ( false !== $width ) {
- $transform = 'fit';
- }
- }
- // Build array of Photon args and expose to filter before passing to Photon URL function.
- $args = array();
- if ( false !== $width && false !== $height ) {
- $args[ $transform ] = $width . ',' . $height;
- } elseif ( false !== $width ) {
- $args['w'] = $width;
- } elseif ( false !== $height ) {
- $args['h'] = $height;
- }
- return $args;
- }
- /**
- * Adds amp-options to the list of options to sync, if AMP is available
- *
- * @param array $options_safelist Safelist of options to sync.
- *
- * @return array Updated options safelist
- */
- public static function filter_jetpack_options_safelist( $options_safelist ) {
- if ( function_exists( 'is_amp_endpoint' ) ) {
- $options_safelist[] = 'amp-options';
- }
- return $options_safelist;
- }
- }
- add_action( 'init', array( 'Jetpack_AMP_Support', 'init' ), 1 );
- add_action( 'admin_init', array( 'Jetpack_AMP_Support', 'admin_init' ), 1 );
|