Embeds: Introduce embed templates into the template hierarchy via theme-compat.

Splits wp-includes/embed-template.php, introduced in 4.4, into five new templates that can be individually overridden by themes:

* embed.php
* embed-404.php
* embed-content.php
* header-embed.php
* footer-embed.php

Also introduces a new template tag for outputting the site title, `the_embed_site_title()`.

The five new templates live in theme-compat, allowing for graceful fallbacks should themes prefer not to override any or all of them.

Props swissspidy, imath, ocean90, DrewAPicture.
See #34561.

Built from https://develop.svn.wordpress.org/trunk@36693


git-svn-id: http://core.svn.wordpress.org/trunk@36660 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-02-24 20:57:26 +00:00
parent f3b2eacf33
commit 0fc00feec3
11 changed files with 277 additions and 209 deletions

View File

@ -1,202 +1,13 @@
<?php
/**
* Contains the post embed template.
*
* When a post is embedded in an iframe, this file is used to
* create the output.
* Back-compat placeholder for the base embed template
*
* @package WordPress
* @subpackage oEmbed
* @since 4.4.0
* @deprecated 4.5.0 Moved to wp-includes/theme-compat/embed-template.php
*/
if ( ! headers_sent() ) {
header( 'X-WP-embed: true' );
}
_deprecated_file( basename( __FILE__ ), '4.5', 'wp-includes/theme-compat/embed.php' );
?>
<!DOCTYPE html>
<html <?php language_attributes(); ?> class="no-js">
<head>
<title><?php echo wp_get_document_title(); ?></title>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<?php
/**
* Print scripts or data in the embed template <head> tag.
*
* @since 4.4.0
*/
do_action( 'embed_head' );
?>
</head>
<body <?php body_class(); ?>>
<?php
if ( have_posts() ) :
while ( have_posts() ) : the_post();
// Add post thumbnail to response if available.
$thumbnail_id = false;
if ( has_post_thumbnail() ) {
$thumbnail_id = get_post_thumbnail_id();
}
if ( 'attachment' === get_post_type() && wp_attachment_is_image() ) {
$thumbnail_id = get_the_ID();
}
if ( $thumbnail_id ) {
$aspect_ratio = 1;
$measurements = array( 1, 1 );
$image_size = 'full'; // Fallback.
$meta = wp_get_attachment_metadata( $thumbnail_id );
if ( ! empty( $meta['sizes'] ) ) {
foreach ( $meta['sizes'] as $size => $data ) {
if ( $data['width'] / $data['height'] > $aspect_ratio ) {
$aspect_ratio = $data['width'] / $data['height'];
$measurements = array( $data['width'], $data['height'] );
$image_size = $size;
}
}
}
/**
* Filter the thumbnail image size for use in the embed template.
*
* @since 4.4.0
*
* @param string $image_size Thumbnail image size.
*/
$image_size = apply_filters( 'embed_thumbnail_image_size', $image_size );
$shape = $measurements[0] / $measurements[1] >= 1.75 ? 'rectangular' : 'square';
/**
* Filter the thumbnail shape for use in the embed template.
*
* Rectangular images are shown above the title
* while square images are shown next to the content.
*
* @since 4.4.0
*
* @param string $shape Thumbnail image shape. Either 'rectangular' or 'square'.
*/
$shape = apply_filters( 'embed_thumbnail_image_shape', $shape );
}
?>
<div <?php post_class( 'wp-embed' ); ?>>
<?php if ( $thumbnail_id && 'rectangular' === $shape ) : ?>
<div class="wp-embed-featured-image rectangular">
<a href="<?php the_permalink(); ?>" target="_top">
<?php echo wp_get_attachment_image( $thumbnail_id, $image_size ); ?>
</a>
</div>
<?php endif; ?>
<p class="wp-embed-heading">
<a href="<?php the_permalink(); ?>" target="_top">
<?php the_title(); ?>
</a>
</p>
<?php if ( $thumbnail_id && 'square' === $shape ) : ?>
<div class="wp-embed-featured-image square">
<a href="<?php the_permalink(); ?>" target="_top">
<?php echo wp_get_attachment_image( $thumbnail_id, $image_size ); ?>
</a>
</div>
<?php endif; ?>
<div class="wp-embed-excerpt"><?php the_excerpt_embed(); ?></div>
<?php
/**
* Print additional content after the embed excerpt.
*
* @since 4.4.0
*/
do_action( 'embed_content' );
?>
<div class="wp-embed-footer">
<div class="wp-embed-site-title">
<?php
$site_title = sprintf(
'<a href="%s" target="_top"><img src="%s" srcset="%s 2x" width="32" height="32" alt="" class="wp-embed-site-icon"/><span>%s</span></a>',
esc_url( home_url() ),
esc_url( get_site_icon_url( 32, includes_url( 'images/w-logo-blue.png' ) ) ),
esc_url( get_site_icon_url( 64, includes_url( 'images/w-logo-blue.png' ) ) ),
esc_html( get_bloginfo( 'name' ) )
);
/**
* Filter the site title HTML in the embed footer.
*
* @since 4.4.0
*
* @param string $site_title The site title HTML.
*/
echo apply_filters( 'embed_site_title_html', $site_title );
?>
</div>
<div class="wp-embed-meta">
<?php
/**
* Print additional meta content in the embed template.
*
* @since 4.4.0
*/
do_action( 'embed_content_meta');
?>
</div>
</div>
</div>
<?php
endwhile;
else :
?>
<div class="wp-embed">
<p class="wp-embed-heading"><?php _e( 'Oops! That embed can&#8217;t be found.' ); ?></p>
<div class="wp-embed-excerpt">
<p>
<?php
printf(
/* translators: %s: a link to the embedded site */
__( 'It looks like nothing was found at this location. Maybe try visiting %s directly?' ),
'<strong><a href="' . esc_url( home_url() ) . '">' . esc_html( get_bloginfo( 'name' ) ) . '</a></strong>'
);
?>
</p>
</div>
<div class="wp-embed-footer">
<div class="wp-embed-site-title">
<?php
$site_title = sprintf(
'<a href="%s" target="_top"><img src="%s" srcset="%s 2x" width="32" height="32" alt="" class="wp-embed-site-icon"/><span>%s</span></a>',
esc_url( home_url() ),
esc_url( get_site_icon_url( 32, includes_url( 'images/w-logo-blue.png' ) ) ),
esc_url( get_site_icon_url( 64, includes_url( 'images/w-logo-blue.png' ) ) ),
esc_html( get_bloginfo( 'name' ) )
);
/** This filter is documented in wp-includes/embed-template.php */
echo apply_filters( 'embed_site_title_html', $site_title );
?>
</div>
</div>
</div>
<?php
endif;
/**
* Print scripts or data before the closing body tag in the embed template.
*
* @since 4.4.0
*/
do_action( 'embed_footer' );
?>
</body>
</html>
include( ABSPATH . WPINC . '/theme-compat/embed.php' );

View File

@ -1046,3 +1046,29 @@ function print_embed_sharing_dialog() {
</div>
<?php
}
/**
* Prints the necessary markup for the site title.
*
* @since 4.5.0
*/
function the_embed_site_title() {
$site_title = sprintf(
'<a href="%s" target="_top"><img src="%s" srcset="%s 2x" width="32" height="32" alt="" class="wp-embed-site-icon"/><span>%s</span></a>',
esc_url( home_url() ),
esc_url( get_site_icon_url( 32, admin_url( 'images/w-logo-blue.png' ) ) ),
esc_url( get_site_icon_url( 64, admin_url( 'images/w-logo-blue.png' ) ) ),
esc_html( get_bloginfo( 'name' ) )
);
$site_title = '<div class="wp-embed-site-title">' . $site_title . '</div>';
/**
* Filter the site title HTML in the embed footer.
*
* @since 4.4.0
*
* @param string $site_title The site title HTML.
*/
echo apply_filters( 'embed_site_title_html', $site_title );
}

View File

@ -36,14 +36,13 @@ function get_header( $name = null ) {
$templates = array();
$name = (string) $name;
if ( '' !== $name )
if ( '' !== $name ) {
$templates[] = "header-{$name}.php";
}
$templates[] = 'header.php';
// Backward compat code will be removed in a future release
if ('' == locate_template($templates, true))
load_template( ABSPATH . WPINC . '/theme-compat/header.php');
locate_template( $templates, true );
}
/**
@ -76,14 +75,13 @@ function get_footer( $name = null ) {
$templates = array();
$name = (string) $name;
if ( '' !== $name )
if ( '' !== $name ) {
$templates[] = "footer-{$name}.php";
}
$templates[] = 'footer.php';
$templates[] = 'footer.php';
// Backward compat code will be removed in a future release
if ('' == locate_template($templates, true))
load_template( ABSPATH . WPINC . '/theme-compat/footer.php');
locate_template( $templates, true );
}
/**
@ -121,9 +119,7 @@ function get_sidebar( $name = null ) {
$templates[] = 'sidebar.php';
// Backward compat code will be removed in a future release
if ('' == locate_template($templates, true))
load_template( ABSPATH . WPINC . '/theme-compat/sidebar.php');
locate_template( $templates, true );
}
/**

View File

@ -40,12 +40,13 @@ elseif ( is_trackback() ) :
include( ABSPATH . 'wp-trackback.php' );
return;
elseif ( is_embed() ) :
$template = ABSPATH . WPINC . '/embed-template.php';
$template = ABSPATH . WPINC . '/theme-compat/embed.php';
/**
* Filter the template used for embedded posts.
*
* @since 4.4.0
* @since 4.5.0 The default template path changed to wp-includes/theme-compat/embed.php
*
* @param string $template Path to the template file.
*/

View File

@ -468,8 +468,8 @@ function get_attachment_template() {
/**
* Retrieve the name of the highest priority template file that exists.
*
* Searches in the STYLESHEETPATH before TEMPLATEPATH so that themes which
* inherit from a parent theme can just overload one file.
* Searches in the STYLESHEETPATH before TEMPLATEPATH and wp-includes/theme-compat
* so that themes which inherit from a parent theme can just overload one file.
*
* @since 2.7.0
*
@ -489,6 +489,9 @@ function locate_template($template_names, $load = false, $require_once = true )
} elseif ( file_exists(TEMPLATEPATH . '/' . $template_name) ) {
$located = TEMPLATEPATH . '/' . $template_name;
break;
} elseif ( file_exists( ABSPATH . WPINC . '/theme-compat/' . $template_name ) ) {
$located = ABSPATH . WPINC . '/theme-compat/' . $template_name;
break;
}
}

View File

@ -0,0 +1,37 @@
<?php
/**
* Contains the post embed content template part.
*
* When a post is embedded in an iframe, this file is used to
* create the content template part output if the active theme does not include
* a content-embed.php template.
*
* @package WordPress
* @subpackage Theme_Compat
* @since 4.5.0
*/
?>
<div class="wp-embed">
<p class="wp-embed-heading"><?php _e( 'Oops! That embed can&#8217;t be found.' ); ?></p>
<div class="wp-embed-excerpt">
<p>
<?php
printf(
/* translators: %s: a link to the embedded site */
__( 'It looks like nothing was found at this location. Maybe try visiting %s directly?' ),
'<strong><a href="' . esc_url( home_url() ) . '">' . esc_html( get_bloginfo( 'name' ) ) . '</a></strong>'
);
?>
</p>
</div>
<?php
/** This filter is documented in wp-includes/theme-compat/embed-content.php */
do_action( 'embed_content' );
?>
<div class="wp-embed-footer">
<?php the_embed_site_title() ?>
</div>
</div>

View File

@ -0,0 +1,116 @@
<?php
/**
* Contains the post embed content template part.
*
* When a post is embedded in an iframe, this file is used to
* create the content template part output if the active theme does not include
* a content-embed.php template.
*
* @package WordPress
* @subpackage Theme_Compat
* @since 4.5.0
*/
?>
<div <?php post_class( 'wp-embed' ); ?>>
<?php
$thumbnail_id = 0;
if ( has_post_thumbnail() ) {
$thumbnail_id = get_post_thumbnail_id();
}
if ( 'attachment' === get_post_type() && wp_attachment_is_image() ) {
$thumbnail_id = get_the_ID();
}
$aspect_ratio = 1;
$measurements = array( 1, 1 );
$image_size = 'full'; // Fallback.
$meta = wp_get_attachment_metadata( $thumbnail_id );
if ( is_array( $meta ) ) {
foreach ( $meta['sizes'] as $size => $data ) {
if ( $data['width'] / $data['height'] > $aspect_ratio ) {
$aspect_ratio = $data['width'] / $data['height'];
$measurements = array( $data['width'], $data['height'] );
$image_size = $size;
}
}
}
/**
* Filter the thumbnail image size for use in the embed template.
*
* @since 4.4.0
* @since 4.5.0 Added `$thumbnail_id` parameter.
*
* @param string $image_size Thumbnail image size.
* @param int $thumbnail_id Attachment ID.
*/
$image_size = apply_filters( 'embed_thumbnail_image_size', $image_size, $thumbnail_id );
$shape = $measurements[0] / $measurements[1] >= 1.75 ? 'rectangular' : 'square';
/**
* Filter the thumbnail shape for use in the embed template.
*
* Rectangular images are shown above the title while square images
* are shown next to the content.
*
* @since 4.4.0
* @since 4.5.0 Added `$thumbnail_id` parameter.
*
* @param string $shape Thumbnail image shape. Either 'rectangular' or 'square'.
* @param int $thumbnail_id Attachment ID.
*/
$shape = apply_filters( 'embed_thumbnail_image_shape', $shape, $thumbnail_id );
if ( 'rectangular' === $shape ) : ?>
<div class="wp-embed-featured-image rectangular">
<a href="<?php the_permalink(); ?>" target="_top">
<?php echo wp_get_attachment_image( $thumbnail_id, $image_size ); ?>
</a>
</div>
<?php endif; ?>
<p class="wp-embed-heading">
<a href="<?php the_permalink(); ?>" target="_top">
<?php the_title(); ?>
</a>
</p>
<?php if ( 'square' === $shape ) : ?>
<div class="wp-embed-featured-image square">
<a href="<?php the_permalink(); ?>" target="_top">
<?php echo wp_get_attachment_image( $thumbnail_id, $image_size ); ?>
</a>
</div>
<?php endif; ?>
<div class="wp-embed-excerpt"><?php the_excerpt_embed(); ?></div>
<?php
/**
* Print additional content after the embed excerpt.
*
* @since 4.4.0
*/
do_action( 'embed_content' );
?>
<div class="wp-embed-footer">
<?php the_embed_site_title() ?>
<div class="wp-embed-meta">
<?php
/**
* Print additional meta content in the embed template.
*
* @since 4.4.0
*/
do_action( 'embed_content_meta');
?>
</div>
</div>
</div>
<?php

View File

@ -0,0 +1,23 @@
<?php
/**
* Contains the post embed template.
*
* When a post is embedded in an iframe, this file is used to
* create the output.
*
* @package WordPress
* @subpackage oEmbed
* @since 4.4.0
*/
get_header( 'embed' );
if ( have_posts() ) :
while ( have_posts() ) : the_post();
get_template_part( 'embed', 'content' );
endwhile;
else :
get_template_part( 'embed', '404' );
endif;
get_footer( 'embed' );

View File

@ -0,0 +1,22 @@
<?php
/**
* Contains the post embed footer template.
*
* When a post is embedded in an iframe, this file is used to
* create the footer output if the active theme does not include
* a footer-embed.php template.
*
* @package WordPress
* @subpackage Theme_Compat
* @since 4.5.0
*/
/**
* Print scripts or data before the closing body tag in the embed template.
*
* @since 4.4.0
*/
do_action( 'embed_footer' );
?>
</body>
</html>

View File

@ -0,0 +1,33 @@
<?php
/**
* Contains the post embed header template.
*
* When a post is embedded in an iframe, this file is used to
* create the header output if the active theme does not include
* a header-embed.php template.
*
* @package WordPress
* @subpackage Theme_Compat
* @since 4.5.0
*/
if ( ! headers_sent() ) {
header( 'X-WP-embed: true' );
}
?>
<!DOCTYPE html>
<html <?php language_attributes(); ?> class="no-js">
<head>
<title><?php echo wp_get_document_title(); ?></title>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<?php
/**
* Print scripts or data in the embed template <head> tag.
*
* @since 4.4.0
*/
do_action( 'embed_head' );
?>
</head>
<body <?php body_class(); ?>>

View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.5-alpha-36692';
$wp_version = '4.5-alpha-36693';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.