story_post_type = $story_post_type; } /** * Get the list of service IDs required for this service to be registered. * * Needed because the story post type needs to be registered first. * * @since 1.13.0 * * @return string[] List of required services. */ public static function get_requirements(): array { return [ 'story_post_type', 'product_meta' ]; } /** * Initialize discovery functionality. * * @since 1.0.0 */ public function register(): void { add_action( 'web_stories_story_head', [ $this, 'print_document_title' ] ); add_action( 'web_stories_story_head', [ $this, 'print_metadata' ] ); add_action( 'web_stories_story_head', [ $this, 'print_schemaorg_metadata' ] ); add_action( 'web_stories_story_head', [ $this, 'print_open_graph_metadata' ] ); add_action( 'web_stories_story_head', [ $this, 'print_twitter_metadata' ] ); add_action( 'web_stories_story_head', [ $this, 'print_feed_link' ], 4 ); add_action( 'wp_head', [ $this, 'print_feed_link' ], 4 ); // @todo Check if there's something to skip in the new version. add_action( 'web_stories_story_head', 'rest_output_link_wp_head', 10, 0 ); add_action( 'web_stories_story_head', 'wp_resource_hints', 2 ); add_action( 'web_stories_story_head', 'feed_links', 2 ); add_action( 'web_stories_story_head', 'feed_links_extra', 3 ); add_action( 'web_stories_story_head', 'rsd_link' ); add_action( 'web_stories_story_head', 'adjacent_posts_rel_link_wp_head', 10, 0 ); add_action( 'web_stories_story_head', 'wp_generator' ); add_action( 'web_stories_story_head', 'rel_canonical' ); add_action( 'web_stories_story_head', 'wp_shortlink_wp_head', 10, 0 ); add_action( 'web_stories_story_head', 'wp_site_icon', 99 ); add_action( 'web_stories_story_head', 'wp_oembed_add_discovery_links' ); add_action( 'web_stories_story_head', 'wp_robots', 1 ); } /** * Prints document title for stories. * * Adds the title regardless of theme support. * * AMP sanitization will ensure there is always just exactly one title tag present. * * @since 1.25.0 * * @link https://github.com/GoogleForCreators/web-stories-wp/issues/12139 * @link https://github.com/GoogleForCreators/web-stories-wp/issues/12487 * @link https://github.com/GoogleForCreators/web-stories-wp/issues/12655 */ public function print_document_title(): void { /** * Filters whether to print the document title. * * @since 1.25.0 * * @param bool $enable_open_graph Whether to print the document title. Default to true. */ $enable_metadata = apply_filters( 'web_stories_enable_document_title', true ); if ( ! $enable_metadata ) { return; } ?> <?php echo esc_html( wp_get_document_title() ); ?> get_schemaorg_metadata(); ?> get_open_graph_metadata(); foreach ( $metadata as $name => $value ) { printf( '', esc_attr( $name ), esc_attr( (string) $value ) ); } } /** * Prints Twitter card metadata. * * @since 1.0.0 */ public function print_twitter_metadata(): void { /** * Filters filter to enable / disable twitter metadata. * * @since 1.2.0 * * @param bool $enable_twitter_metadata Enable / disable twitter metadata. Default to true. */ $enable_twitter_metadata = apply_filters( 'web_stories_enable_twitter_metadata', true ); if ( ! $enable_twitter_metadata ) { return; } $metadata = $this->get_twitter_metadata(); foreach ( $metadata as $name => $value ) { printf( '', esc_attr( $name ), esc_attr( $value ) ); } } /** * Add RSS feed link for stories, if theme supports automatic-feed-links. * * @since 1.0.0 */ public function print_feed_link(): void { $enable_print_feed_link = current_theme_supports( 'automatic-feed-links' ) && ! is_post_type_archive( $this->story_post_type->get_slug() ); /** * Filters filter to enable / disable printing feed links. * * @since 1.29.0 * * @param bool $enable_print_feed_link Enable / disable printing feed links. Default to if automatic-feed-links is enabled. */ $enable_print_feed_link = apply_filters( 'web_stories_enable_print_feed_link', $enable_print_feed_link ); if ( ! $enable_print_feed_link ) { return; } $name = $this->story_post_type->get_label( 'name' ); if ( ! $name ) { return; } $feed = get_post_type_archive_feed_link( $this->story_post_type->get_slug() ); if ( ! $feed ) { return; } /* translators: Separator between blog name and feed type in feed links. */ $separator = _x( '»', 'feed link', 'web-stories' ); /* translators: 1: Blog name, 2: Separator (raquo), 3: Post type name. */ $post_type_title = esc_html__( '%1$s %2$s %3$s Feed', 'web-stories' ); $title = sprintf( $post_type_title, get_bloginfo( 'name' ), $separator, $name ); printf( '', esc_attr( feed_content_type() ), esc_attr( $title ), esc_url( $feed ) ); } /** * Get schema.org metadata for the current query. * * @since 1.0.0 * * @see https://developers.google.com/search/docs/guides/enable-web-stories * * @return array $metadata All schema.org metadata for the post. */ protected function get_schemaorg_metadata(): array { /** * We're expecting a post object. * * @var WP_Post|null $post */ $post = get_queried_object(); $story = new Story(); $story->load_from_post( $post ); $metadata = [ '@context' => 'http://schema.org', 'publisher' => [ '@type' => 'Organization', 'name' => $story->get_publisher_name(), ], ]; if ( $post instanceof WP_Post ) { $url = $story->get_publisher_logo_url(); $size = $story->get_publisher_logo_size(); if ( ! empty( $url ) && ! empty( $size ) ) { $metadata['publisher']['logo'] = [ '@type' => 'ImageObject', 'url' => $url, 'width' => $size[0], 'height' => $size[1], ]; } $poster = $story->get_poster_portrait(); $poster_size = $story->get_poster_portrait_size(); if ( $poster && $poster_size ) { $metadata['image'] = [ '@type' => 'ImageObject', 'url' => $poster, 'width' => $poster_size[0], 'height' => $poster_size[1], ]; } $metadata = array_merge( $metadata, [ '@type' => 'Article', 'mainEntityOfPage' => $story->get_url(), 'headline' => $story->get_title(), 'datePublished' => mysql2date( 'c', $post->post_date_gmt, false ), 'dateModified' => mysql2date( 'c', $post->post_modified_gmt, false ), ] ); $post_author = get_userdata( (int) $post->post_author ); if ( $post_author ) { $metadata['author'] = [ '@type' => 'Person', 'name' => html_entity_decode( $post_author->display_name, ENT_QUOTES, get_bloginfo( 'charset' ) ), ]; } /** * List of products. * * @phpstan-var Product[] $products */ $products = $story->get_products(); $product_metadata = $this->get_product_data( $products ); if ( $product_metadata ) { $metadata = array_merge( $product_metadata, $metadata ); } } /** * Filters the schema.org metadata for a given story. * * @since 1.0.0 * * @param array $metadata The structured data. * @param WP_Post|null $post The current post object if available. */ return apply_filters( 'web_stories_story_schema_metadata', $metadata, $post ); } /** * Get product schema data. * * @since 1.22.0 * * @param Product[] $products Array of products. * @return array>|string>> * * @phpstan-param Product[] $products */ protected function get_product_data( array $products ): array { if ( ! $products ) { return []; } $product_data = []; foreach ( $products as $product ) { $data = [ '@type' => 'Product', 'brand' => $product->get_brand(), 'productID' => $product->get_id(), 'url' => $product->get_url(), 'name' => $product->get_title(), 'description' => $product->get_details(), 'offers' => [ [ '@type' => 'Offer', 'price' => $product->get_price(), 'priceCurrency' => $product->get_price_currency(), ], ], ]; if ( $product->get_images() ) { $data['image'] = $product->get_images()[0]['url']; } $aggregate_rating = $product->get_aggregate_rating(); if ( ! empty( $aggregate_rating['review_count'] ) ) { $data['aggregateRating'] = [ '@type' => 'AggregateRating', 'ratingValue' => $aggregate_rating['rating_value'] ??= 0, 'reviewCount' => $aggregate_rating['review_count'], 'url' => $aggregate_rating['review_url'] ??= '', ]; } $product_data[] = $data; } return [ 'mainEntity' => [ '@type' => 'ItemList', 'numberOfItems' => (string) \count( $products ), 'itemListElement' => $product_data, ], ]; } /** * Get Open Graph metadata. * * @since 1.3.0 * * @return array */ protected function get_open_graph_metadata(): array { $metadata = [ 'og:locale' => get_bloginfo( 'language' ), 'og:site_name' => get_bloginfo( 'name' ), ]; /** * We're expecting a post object. * * @var WP_Post|null $post */ $post = get_queried_object(); if ( $post instanceof WP_Post ) { $story = new Story(); $story->load_from_post( $post ); $metadata['og:type'] = 'article'; $metadata['og:title'] = $story->get_title(); $metadata['og:url'] = $story->get_url(); $metadata['og:description'] = wp_strip_all_tags( get_the_excerpt( $post ) ); $metadata['article:published_time'] = (string) get_the_date( 'c', $post ); $metadata['article:modified_time'] = (string) get_the_modified_date( 'c', $post ); $poster_url = $story->get_poster_portrait(); $poster_sizes = $story->get_poster_portrait_size(); if ( $poster_url && $poster_sizes ) { $metadata['og:image'] = esc_url( $poster_url ); $metadata['og:image:width'] = $poster_sizes[0]; $metadata['og:image:height'] = $poster_sizes[1]; } } /** * Filters the open graph metadata for a given story. * * @since 1.3.0 * * @param array $metadata The structured data. * @param WP_Post|null $post The current post object if available. */ return apply_filters( 'web_stories_story_open_graph_metadata', $metadata, $post ); } /** * Get Twitter card metadata. * * @since 1.3.0 * * @return array Twitter card metadata. */ protected function get_twitter_metadata(): array { $metadata = [ 'twitter:card' => 'summary_large_image', ]; /** * We're expecting a post object. * * @var WP_Post|null $post */ $post = get_queried_object(); if ( $post instanceof WP_Post ) { $story = new Story(); $story->load_from_post( $post ); $poster = $story->get_poster_portrait(); if ( $poster ) { $metadata['twitter:image'] = esc_url( $poster ); $metadata['twitter:image:alt'] = $story->get_title(); } } /** * Filters the twitter metadata for a given story. * * @since 1.3.0 * * @param array $metadata The structured data. * @param WP_Post|null $post The current post object if available. */ return apply_filters( 'web_stories_story_twitter_metadata', $metadata, $post ); } }