<?php // phpcs:ignore WordPress.Files.FileName.NotHyphenatedLowercase
/**
* Open Graph Tags
*
* Add Open Graph tags so that Facebook (and any other service that supports them)
* can crawl the site better and we provide a better sharing experience.
*
* @link https://ogp.me/
* @link https://developers.facebook.com/docs/opengraph/
*
* @package automattic/jetpack
*/
use Automattic\Jetpack\Status\Host;
add_action( 'wp_head', 'jetpack_og_tags' );
add_action( 'web_stories_story_head', 'jetpack_og_tags' );
// Add a Fediverse Open Graph Tag when an author has connected their Mastodon account.
add_filter( 'jetpack_open_graph_tags', 'jetpack_add_fediverse_creator_open_graph_tag', 10, 1 );
add_filter( 'jetpack_open_graph_output', 'jetpack_filter_fediverse_cards_output', 10, 1 );
/**
* Outputs Open Graph tags generated by Jetpack.
*/
function jetpack_og_tags() {
global $post;
$data = $post; // so that we don't accidentally explode the global.
$is_amp_response = ( class_exists( 'Jetpack_AMP_Support' ) && Jetpack_AMP_Support::is_amp_request() );
// Disable the widont filter on WP.com to avoid stray  s.
$disable_widont = remove_filter( 'the_title', 'widont' );
$og_output = "\n";
if ( ! $is_amp_response ) { // Because AMP optimizes the order or the nodes in the head.
$og_output .= "<!-- Jetpack Open Graph Tags -->\n";
}
$tags = array();
/**
* Filter the minimum width of the images used in Jetpack Open Graph Meta Tags.
*
* @module sharedaddy, publicize
*
* @since 2.0.0
*
* @param int 200 Minimum image width used in Jetpack Open Graph Meta Tags.
*/
$image_width = absint( apply_filters( 'jetpack_open_graph_image_width', 200 ) );
/**
* Filter the minimum height of the images used in Jetpack Open Graph Meta Tags.
*
* @module sharedaddy, publicize
*
* @since 2.0.0
*
* @param int 200 Minimum image height used in Jetpack Open Graph Meta Tags.
*/
$image_height = absint( apply_filters( 'jetpack_open_graph_image_height', 200 ) );
$description_length = 197;
if ( is_home() || is_front_page() ) {
$site_type = Jetpack_Options::get_option_and_ensure_autoload( 'open_graph_protocol_site_type', '' );
$tags['og:type'] = ! empty( $site_type ) ? $site_type : 'website';
$tags['og:title'] = get_bloginfo( 'name' );
$tags['og:description'] = get_bloginfo( 'description' );
$front_page_id = get_option( 'page_for_posts' );
if ( 'page' === get_option( 'show_on_front' ) && $front_page_id && is_home() ) {
$tags['og:url'] = get_permalink( $front_page_id );
} else {
$tags['og:url'] = home_url( '/' );
}
// Associate a blog's root path with one or more Facebook accounts.
$facebook_admins = Jetpack_Options::get_option_and_ensure_autoload( 'facebook_admins', array() );
if ( ! empty( $facebook_admins ) ) {
$tags['fb:admins'] = $facebook_admins;
}
} elseif ( is_author() ) {
$tags['og:type'] = 'profile';
$author = get_queried_object();
if ( is_a( $author, 'WP_User' ) ) {
$tags['og:title'] = $author->display_name;
if ( ! empty( $author->user_url ) ) {
$tags['og:url'] = $author->user_url;
} else {
$tags['og:url'] = get_author_posts_url( $author->ID );
}
$tags['og:description'] = $author->description;
$tags['profile:first_name'] = get_the_author_meta( 'first_name', $author->ID );
$tags['profile:last_name'] = get_the_author_meta( 'last_name', $author->ID );
}
} elseif ( is_archive() ) {
$tags['og:type'] = 'website';
$tags['og:title'] = wp_get_document_title();
$archive = get_queried_object();
if ( $archive instanceof WP_Term ) {
$tags['og:url'] = get_term_link( $archive->term_id, $archive->taxonomy );
$tags['og:description'] = $archive->description;
} elseif ( ! empty( $archive ) && is_post_type_archive() ) {
$tags['og:url'] = get_post_type_archive_link( $archive->name );
$tags['og:description'] = $archive->description;
}
} elseif ( is_singular() && is_a( $data, 'WP_Post' ) ) {
$tags['og:type'] = 'article';
if ( empty( $data->post_title ) ) {
$tags['og:title'] = ' ';
} else {
/** This filter is documented in core/src/wp-includes/post-template.php */
$tags['og:title'] = wp_kses( apply_filters( 'the_title', $data->post_title, $data->ID ), array() );
}
$tags['og:url'] = get_permalink( $data->ID );
if ( ! post_password_required() ) {
/*
* If the post author set an excerpt, use that.
* Otherwise, pick the post content that comes before the More tag if there is one.
* Do not use the post content if it contains premium content.
*/
if ( ! empty( $data->post_excerpt ) ) {
$tags['og:description'] = jetpack_og_get_description( $data->post_excerpt );
} elseif ( ! has_block( 'premium-content/container', $data->post_content ) ) {
$excerpt = explode( '<!--more-->', $data->post_content )[0];
$tags['og:description'] = jetpack_og_get_description( $excerpt );
}
}
$tags['article:published_time'] = gmdate( 'c', strtotime( $data->post_date_gmt ) );
$tags['article:modified_time'] = gmdate( 'c', strtotime( $data->post_modified_gmt ) );
if ( post_type_supports( get_post_type( $data ), 'author' ) && isset( $data->post_author ) ) {
$publicize_facebook_user = get_post_meta( $data->ID, '_publicize_facebook_user', true );
if ( ! empty( $publicize_facebook_user ) ) {
$tags['article:author'] = esc_url( $publicize_facebook_user );
}
}
} elseif ( is_search() ) {
if ( '' !== get_query_var( 's', '' ) ) {
$tags['og:title'] = wp_get_document_title();
}
}
/**
* Allow plugins to inject additional template-specific Open Graph tags.
*
* @module sharedaddy, publicize
*
* @since 3.0.0
*
* @param array $tags Array of Open Graph Meta tags.
* @param array $args Array of image size parameters.
*/
$tags = apply_filters( 'jetpack_open_graph_base_tags', $tags, compact( 'image_width', 'image_height' ) );
// Re-enable widont if we had disabled it.
if ( $disable_widont ) {
add_filter( 'the_title', 'widont' );
}
/**
* Do not return any Open Graph Meta tags if we don't have any info about a post.
*
* @module sharedaddy, publicize
*
* @since 3.0.0
*
* @param bool true Do not return any Open Graph Meta tags if we don't have any info about a post.
*/
if ( empty( $tags ) && apply_filters( 'jetpack_open_graph_return_if_empty', true ) ) {
return;
}
$tags['og:site_name'] = get_bloginfo( 'name' );
// Get image info and build tags.
if ( ! post_password_required() ) {
$image_info = jetpack_og_get_image( $image_width, $image_height );
$tags['og:image'] = $image_info['src'];
if ( ! empty( $image_info['width'] ) ) {
$tags['og:image:width'] = (int) $image_info['width'];
}
if ( ! empty( $image_info['height'] ) ) {
$tags['og:image:height'] = (int) $image_info['height'];
}
// If we have an image, add the alt text even if it's empty.
if ( ! empty( $image_info['src'] ) && isset( $image_info['alt_text'] ) ) {
$tags['og:image:alt'] = esc_attr( $image_info['alt_text'] );
}
}
// Facebook whines if you give it an empty title.
if ( empty( $tags['og:title'] ) ) {
$tags['og:title'] = __( '(no title)', 'jetpack' );
}
// Shorten the description if it's too long.
if ( isset( $tags['og:description'] ) ) {
$tags['og:description'] = strlen( $tags['og:description'] ) > $description_length ? mb_substr( $tags['og:description'], 0, $description_length ) . '…' : $tags['og:description'];
}
// Try to add OG locale tag if the WP->FB data mapping exists.
if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
require_once JETPACK__GLOTPRESS_LOCALES_PATH;
$_locale = get_locale();
// We have to account for w.org vs WP.com locale divergence.
if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
$gp_locale = GP_Locales::by_field( 'slug', $_locale );
} else {
$gp_locale = GP_Locales::by_field( 'wp_locale', $_locale );
}
}
if ( isset( $gp_locale->facebook_locale ) && ! empty( $gp_locale->facebook_locale ) ) {
$tags['og:locale'] = $gp_locale->facebook_locale;
}
/**
* Allow the addition of additional Open Graph Meta tags, or modify the existing tags.
*
* @module sharedaddy, publicize
*
* @since 2.0.0
*
* @param array $tags Array of Open Graph Meta tags.
* @param array $args Array of image size parameters.
*/
$tags = apply_filters( 'jetpack_open_graph_tags', $tags, compact( 'image_width', 'image_height' ) );
// secure_urls need to go right after each og:image to work properly so we will abstract them here.
$tags['og:image:secure_url'] = ( empty( $tags['og:image:secure_url'] ) ) ? '' : $tags['og:image:secure_url'];
$secure = $tags['og:image:secure_url'];
unset( $tags['og:image:secure_url'] );
$secure_image_num = 0;
$allowed_empty_tags = array(
'og:image:alt',
);
foreach ( (array) $tags as $tag_property => $tag_content ) {
// to accommodate multiple images.
$tag_content = (array) $tag_content;
$tag_content = array_unique( array_filter( $tag_content, 'is_scalar' ) );
foreach ( $tag_content as $tag_content_single ) {
if ( empty( $tag_content_single ) && ! in_array( $tag_property, $allowed_empty_tags, true ) ) {
continue; // Only allow certain empty tags.
}
switch ( $tag_property ) {
case 'og:url':
case 'og:image':
case 'og:image:url':
case 'og:image:secure_url':
case 'og:audio':
case 'og:audio:url':
case 'og:audio:secure_url':
case 'og:video':
case 'og:video:url':
case 'og:video:secure_url':
$og_tag = sprintf( '<meta property="%s" content="%s" />', esc_attr( $tag_property ), esc_url( $tag_content_single ) );
break;
default:
$og_tag = sprintf( '<meta property="%s" content="%s" />', esc_attr( $tag_property ), esc_attr( $tag_content_single ) );
}
/**
* Filter the HTML Output of each Open Graph Meta tag.
*
* @module sharedaddy, publicize
*
* @since 2.0.0
*
* @param string $og_tag HTML HTML Output of each Open Graph Meta tag.
*/
$og_output .= apply_filters( 'jetpack_open_graph_output', $og_tag );
$og_output .= "\n";
if ( 'og:image' === $tag_property ) {
if ( is_array( $secure ) && ! empty( $secure[ $secure_image_num ] ) ) {
$og_tag = sprintf( '<meta property="og:image:secure_url" content="%s" />', esc_url( $secure[ $secure_image_num ] ) );
/** This filter is documented in functions.opengraph.php */
$og_output .= apply_filters( 'jetpack_open_graph_output', $og_tag );
$og_output .= "\n";
} elseif ( ! is_array( $secure ) && ! empty( $secure ) ) {
$og_tag = sprintf( '<meta property="og:image:secure_url" content="%s" />', esc_url( $secure ) );
/** This filter is documented in functions.opengraph.php */
$og_output .= apply_filters( 'jetpack_open_graph_output', $og_tag );
$og_output .= "\n";
}
++$secure_image_num;
}
}
}
if ( ! $is_amp_response ) { // Because AMP optimizes the order or the nodes in the head.
$og_output .= "\n<!-- End Jetpack Open Graph Tags -->";
}
$og_output .= "\n";
// This is trusted output or added by a filter.
echo $og_output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Returns an image used in social shares.
*
* @since 2.0.0
*
* @param int $width Minimum width for the image. Default is 200 based on Facebook's requirement.
* @param int $height Minimum height for the image. Default is 200 based on Facebook's requirement.
* @param null $deprecated Deprecated.
*
* @return array The source ('src'), 'width', and 'height' of the image.
*/
function jetpack_og_get_image( $width = 200, $height = 200, $deprecated = null ) {
if ( ! empty( $deprecated ) ) {
_deprecated_argument( __FUNCTION__, 'jetpack-6.6.0' );
}
$image = array();
if ( is_singular() && ! is_home() ) {
// Grab obvious image if post is an attachment page for an image.
if ( is_attachment( get_the_ID() ) && str_starts_with( get_post_mime_type(), 'image' ) ) {
$image['src'] = wp_get_attachment_url( get_the_ID() );
$image['alt_text'] = Jetpack_PostImages::get_alt_text( get_the_ID() );
}
// Attempt to find something good for this post using our generalized PostImages code.
if ( empty( $image ) && class_exists( 'Jetpack_PostImages' ) ) {
$post_image = Jetpack_PostImages::get_image(
get_the_ID(),
array(
'width' => $width,
'height' => $height,
)
);
if ( ! empty( $post_image ) && is_array( $post_image ) ) {
$image['src'] = $post_image['src'];
if ( isset( $post_image['src_width'] ) && isset( $post_image['src_height'] ) ) {
$image['width'] = $post_image['src_width'];
$image['height'] = $post_image['src_height'];
}
if ( ! empty( $post_image['alt_text'] ) ) {
$image['alt_text'] = $post_image['alt_text'];
}
}
}
} elseif ( is_author() ) {
$author = get_queried_object();
if ( is_a( $author, 'WP_User' ) ) {
$image['src'] = get_avatar_url(
$author->user_email,
array(
'size' => $width,
)
);
$image['alt_text'] = $author->display_name;
}
}
// First fall back, blavatar.
if ( empty( $image ) && function_exists( 'blavatar_domain' ) ) {
$blavatar_domain = blavatar_domain( site_url() );
if ( blavatar_exists( $blavatar_domain ) ) {
$image['src'] = blavatar_url( $blavatar_domain, 'img', $width, false, true );
$image['width'] = $width;
$image['height'] = $height;
}
}
// Second fall back, Site Logo.
if ( empty( $image ) && ( function_exists( 'jetpack_has_site_logo' ) && jetpack_has_site_logo() ) ) {
$image_id = jetpack_get_site_logo( 'id' );
$logo = wp_get_attachment_image_src( $image_id, 'full' );
if (
isset( $logo[0] ) && isset( $logo[1] ) && isset( $logo[2] )
&& ( _jetpack_og_get_image_validate_size( $logo[1], $logo[2], $width, $height ) )
) {
$image['src'] = $logo[0];
$image['width'] = $logo[1];
$image['height'] = $logo[2];
$image['alt_text'] = Jetpack_PostImages::get_alt_text( $image_id );
}
}
// Third fall back, Core Site Icon, if valid in size.
if ( empty( $image ) && has_site_icon() ) {
$image_id = get_option( 'site_icon' );
$icon = wp_get_attachment_image_src( $image_id, 'full' );
if (
isset( $icon[0] ) && isset( $icon[1] ) && isset( $icon[2] )
&& ( _jetpack_og_get_image_validate_size( $icon[1], $icon[2], $width, $height ) )
) {
$image['src'] = $icon[0];
$image['width'] = $icon[1];
$image['height'] = $icon[2];
$image['alt_text'] = Jetpack_PostImages::get_alt_text( $image_id );
}
}
// Final fall back, blank image.
if ( empty( $image ) ) {
/**
* Filter the default Open Graph Image tag, used when no Image can be found in a post.
*
* @since 3.0.0
*
* @param string $str Default Image URL.
*/
$image['src'] = apply_filters( 'jetpack_open_graph_image_default', 'https://s0.wp.com/i/blank.jpg' );
}
// If we didn't get an explicit alt tag from the image, set a default.
if ( empty( $image['alt_text'] ) ) {
/**
* Filter the default Open Graph image alt text, used when the Open Graph image from the post does not have an alt text.
*
* @since 10.4
*
* @param string $str Default Open Graph image alt text.
*/
$image['alt_text'] = apply_filters( 'jetpack_open_graph_image_default_alt_text', '' );
}
return $image;
}
/**
* Validate the width and height against required width and height
*
* @param int $width Width of the image.
* @param int $height Height of the image.
* @param int $req_width Required width to pass validation.
* @param int $req_height Required height to pass validation.
*
* @return bool - True if the image passed the required size validation
*/
function _jetpack_og_get_image_validate_size( $width, $height, $req_width, $req_height ) {
if ( ! $width || ! $height ) {
return false;
}
$valid_width = ( $width >= $req_width );
$valid_height = ( $height >= $req_height );
$is_image_acceptable = $valid_width && $valid_height;
return $is_image_acceptable;
}
/**
* Gets a gravatar URL of the specified size.
*
* @param string $email E-mail address to get gravatar for.
* @param int $width Size of returned gravatar.
* @return array|bool|mixed|string
*/
function jetpack_og_get_image_gravatar( $email, $width ) {
return get_avatar_url(
$email,
array(
'size' => $width,
)
);
}
/**
* Clean up text meant to be used as Description Open Graph tag.
*
* There should be:
* - no links
* - no shortcodes
* - no html tags or their contents
* - not too many words.
*
* @param string $description Text coming from WordPress (autogenerated or manually generated by author).
* @param WP_Post|null $data Information about our post.
*
* @return string $description Cleaned up description string.
*/
function jetpack_og_get_description( $description = '', $data = null ) {
// Remove tags such as <style or <script.
$description = wp_strip_all_tags( $description );
/*
* Clean up any plain text entities left into formatted entities.
* Intentionally not using a filter to prevent pollution.
* @see https://github.com/Automattic/jetpack/pull/2899#issuecomment-151957382
*/
$description = wp_kses(
trim(
convert_chars(
wptexturize( $description )
)
),
array()
);
// Remove shortcodes.
$description = strip_shortcodes( $description );
// Remove links.
$description = preg_replace(
'@https?://[\S]+@',
'',
$description
);
/*
* Limit things to a small text blurb.
* There isn't a hard limit set by Facebook, so let's rely on WP's own limit.
* (55 words or the localized equivalent).
* This limit can be customized with the wp_trim_words filter.
*/
$description = wp_trim_words( $description );
// Let's set a default if we have no text by now.
if ( empty( $description ) ) {
/**
* Filter the fallback `og:description` used when no excerpt information is provided.
*
* @module sharedaddy, publicize
*
* @since 3.9.0
*
* @param string $var Fallback og:description. Default is translated `Visit the post for more'.
* @param object $data Post object for the current post.
*/
$description = apply_filters(
'jetpack_open_graph_fallback_description',
__( 'Visit the post for more.', 'jetpack' ),
$data
);
}
return $description;
}
/**
* Display a Fediverse actor Open Graph tag when the post author has a Mastodon connection.
*
* @see https://blog.joinmastodon.org/2024/07/highlighting-journalism-on-mastodon/
*
* @since 13.8
*
* @param array $tags Current tags.
*
* @return array
*/
function jetpack_add_fediverse_creator_open_graph_tag( $tags ) {
/*
* Let's not do this on WordPress.com Simple for now,
* because of its performance impact.
* See p1723574138779019/1723572983.803009-slack-C01U2KGS2PQ
*/
if ( ( new Host() )->is_wpcom_simple() ) {
return $tags;
}
// Let's not add any tags when the ActivityPub plugin already adds its own.
$is_activitypub_opengraph_integration_active = get_option( 'activitypub_use_opengraph' );
if ( $is_activitypub_opengraph_integration_active ) {
return $tags;
}
// We pull the Mastodon connection data from Publicize.
if ( ! function_exists( 'publicize_init' ) ) {
return $tags;
}
$publicize = publicize_init();
global $post;
if (
! is_singular()
|| ! $post instanceof WP_Post
|| ! isset( $post->ID )
|| empty( $post->post_author )
) {
return $tags;
}
$post_mastodon_connections = array();
// Loop through active connections.
foreach ( (array) $publicize->get_services( 'connected' ) as $service_name => $connections ) {
if ( 'mastodon' !== $service_name ) {
continue;
}
// services can have multiple connections. Store them all in our array.
foreach ( $connections as $connection ) {
$connection_id = $publicize->get_connection_id( $connection );
$connection_meta = $publicize->get_connection_meta( $connection );
$connection_data = $connection_meta['connection_data'] ?? array();
$mastodon_handle = $connection_meta['external_display'] ?? '';
$connection_user_id = $connection_data['user_id'] ?? 0;
if ( empty( $mastodon_handle ) ) {
continue;
}
// Did we skip this connection for this post?
if ( get_post_meta( $post->ID, $publicize->POST_SKIP_PUBLICIZE . $connection_id, true ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
continue;
}
$post_mastodon_connections[] = array(
'user_id' => (int) $connection_user_id,
'connection_id' => (int) $connection_id,
'handle' => $mastodon_handle,
'global' => 0 === (int) $connection_user_id,
);
}
}
// If we have no Mastodon connections, skip.
if ( empty( $post_mastodon_connections ) ) {
return $tags;
}
/*
* Select a single Mastodon connection to use.
* It should be either the first connection belonging to the post author,
* or the first global connection.
*/
foreach ( $post_mastodon_connections as $mastodon_connection ) {
if ( (int) $post->post_author === $mastodon_connection['user_id'] ) {
$tags['fediverse:creator'] = esc_attr( $mastodon_connection['handle'] );
break;
}
if ( $mastodon_connection['global'] ) {
$tags['fediverse:creator'] = esc_attr( $mastodon_connection['handle'] );
break;
}
}
return $tags;
}
/**
* Update the markup for the Open Graph tag to match the expected output for Mastodon
* (name instead of property).
*
* @since 13.8
*
* @param string $og_tag A single OG tag.
*
* @return string Result of the OG tag.
*/
function jetpack_filter_fediverse_cards_output( $og_tag ) {
return ( str_contains( $og_tag, 'fediverse:' ) ) ? preg_replace( '/property="([^"]+)"/', 'name="\1"', $og_tag ) : $og_tag;
}