<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[39240] trunk: Themes: Remove front page restriction from video header functions.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/39240">39240</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/39240","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-11-15 07:15:20 +0000 (Tue, 15 Nov 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Themes: Remove front page restriction from video header functions.
Adds a callback for determining when video headers should be displayed in themes supporting custom headers. By default, video headers are only displayed on the front page of a site.
Theme authors may set a custom callback by passing `'video-active-callback' => 'mytheme_video_active_callback'` as an argument. The default callback is `is_front_page()`.
This introduces the new function `is_header_video_active()` - returns `true` on pages that should display video headers. The return value can be filtered using the new filter of the same name.
Props flixos90, bradyvercher, peterwilsoncc, joemcgill.
Fixes <a href="https://core.trac.wordpress.org/ticket/38738">#38738</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpcustomizemanagerphp">trunk/src/wp-includes/class-wp-customize-manager.php</a></li>
<li><a href="#trunksrcwpincludesthemephp">trunk/src/wp-includes/theme.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunitteststhemecustomHeaderphp">trunk/tests/phpunit/tests/theme/customHeader.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpcustomizemanagerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-customize-manager.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-manager.php 2016-11-15 05:38:21 UTC (rev 39239)
+++ trunk/src/wp-includes/class-wp-customize-manager.php 2016-11-15 07:15:20 UTC (rev 39240)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3491,7 +3491,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'frame_title' => __( 'Select Video' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'frame_button' => __( 'Choose Video' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'active_callback' => 'is_front_page',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'active_callback' => 'is_header_video_active',
</ins><span class="cx" style="display: block; padding: 0 10px"> ) ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->add_control( 'external_header_video', array(
</span></span></pre></div>
<a id="trunksrcwpincludesthemephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/theme.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/theme.php 2016-11-15 05:38:21 UTC (rev 39239)
+++ trunk/src/wp-includes/theme.php 2016-11-15 07:15:20 UTC (rev 39240)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1400,7 +1400,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if a custom header is set. False if not.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function has_custom_header() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( has_header_image() || ( is_front_page() && has_header_video() ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( has_header_image() || ( has_header_video() && is_header_video_active() ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1408,6 +1408,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks whether the custom header video is eligible to show on the current page.
+ *
+ * @since 4.7.0
+ *
+ * @return bool True if the custom header video should be shown. False if not.
+ */
+function is_header_video_active() {
+ if ( ! get_theme_support( 'custom-header', 'video' ) ) {
+ return false;
+ }
+
+ $video_active_cb = get_theme_support( 'custom-header', 'video-active-callback' );
+
+ if ( empty( $video_active_cb ) || ! is_callable( $video_active_cb ) ) {
+ $show_video = true;
+ } else {
+ $show_video = call_user_func( $video_active_cb );
+ }
+
+ /**
+ * Modify whether the custom header video is eligible to show on the current page.
+ *
+ * @since 4.7.0
+ *
+ * @param bool $show_video Whether the custom header video should be shown. Returns the value
+ * of the theme setting for the `custom-header`'s `video-active-callback`.
+ * If no callback is set, the default value is that of `is_front_page()`.
+ */
+ return apply_filters( 'is_header_video_active', $show_video );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Retrieve the markup for a custom header.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The container div will always be returned in the Customizer preview.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1442,7 +1474,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> echo $custom_header;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_front_page() && ( has_header_video() || is_customize_preview() ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_header_video_active() && ( has_header_video() || is_customize_preview() ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_script( 'wp-custom-header' );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_localize_script( 'wp-custom-header', '_wpCustomHeaderSettings', get_header_video_settings() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2058,6 +2090,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'admin-head-callback' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'admin-preview-callback' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'video' => false,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'video-active-callback' => 'is_front_page',
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $jit = isset( $args[0]['__jit'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2319,10 +2352,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! did_action( 'wp_loaded' ) )
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> $support = get_theme_support( 'custom-header' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $support[0]['wp-head-callback'] )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $support[0]['wp-head-callback'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> remove_action( 'wp_head', $support[0]['wp-head-callback'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- remove_action( 'admin_menu', array( $GLOBALS['custom_image_header'], 'init' ) );
- unset( $GLOBALS['custom_image_header'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
+ if ( isset( $GLOBALS['custom_image_header'] ) ) {
+ remove_action( 'admin_menu', array( $GLOBALS['custom_image_header'], 'init' ) );
+ unset( $GLOBALS['custom_image_header'] );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> case 'custom-background' :
</span></span></pre></div>
<a id="trunktestsphpunitteststhemecustomHeaderphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/theme/customHeader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/theme/customHeader.php (rev 0)
+++ trunk/tests/phpunit/tests/theme/customHeader.php 2016-11-15 07:15:20 UTC (rev 39240)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,125 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * @group themes
+ */
+class Tests_Theme_Custom_Header extends WP_UnitTestCase {
+
+ static $post;
+
+ public static function wpSetUpBeforeClass( $factory ) {
+ self::$post = self::factory()->post->create( array(
+ 'post_status' => 'publish',
+ ) );
+ }
+
+ function tearDown() {
+ remove_theme_support( 'custom-header' );
+ parent::tearDown();
+ }
+
+ /**
+ * @ticket 38738
+ */
+ function test_video_header_callback_front_page_from_front_page() {
+ $this->_add_theme_support( array(
+ 'video' => true,
+ ) );
+
+ $this->go_to( home_url() );
+
+ $result = is_header_video_active();
+
+ $this->assertTrue( $result );
+ }
+
+ /**
+ * @ticket 38738
+ */
+ function test_video_header_callback_front_page_from_elsewhere() {
+ $this->_add_theme_support( array(
+ 'video' => true,
+ ) );
+
+ $this->go_to( get_permalink( self::$post ) );
+
+ $result = is_header_video_active();
+
+ $this->assertFalse( $result );
+ }
+
+ /**
+ * @ticket 38738
+ */
+ function test_video_header_callback_globally_from_front_page() {
+ $this->_add_theme_support( array(
+ 'video' => true,
+ 'video-active-callback' => '__return_true',
+ ) );
+
+ $this->go_to( home_url() );
+
+ $result = is_header_video_active();
+
+ $this->assertTrue( $result );
+ }
+
+ /**
+ * @ticket 38738
+ */
+ function test_video_header_callback_globally_from_elsewhere() {
+ $this->_add_theme_support( array(
+ 'video' => true,
+ 'video-active-callback' => '__return_true',
+ ) );
+
+ $this->go_to( get_permalink( self::$post ) );
+
+ $result = is_header_video_active();
+
+ $this->assertTrue( $result );
+ }
+
+ /**
+ * @ticket 38738
+ */
+ function test_video_header_callback_globally_with_negative_filter() {
+ $this->_add_theme_support( array(
+ 'video' => true,
+ 'video-active-callback' => '__return_true',
+ ) );
+
+ $this->go_to( get_permalink( self::$post ) );
+
+ add_filter( 'is_header_video_active', '__return_false' );
+ $result = is_header_video_active();
+ remove_filter( 'is_header_video_active', '__return_false' );
+
+ $this->assertFalse( $result );
+ }
+
+ /**
+ * Adds arguments directly to the $_wp_theme_features global. Calling
+ * add_theme_support( 'custom-header' ) will poison subsequent tests since
+ * it defines constants.
+ */
+ function _add_theme_support( $args = array() ) {
+ global $_wp_theme_features;
+
+ $_wp_theme_features['custom-header'][0] = wp_parse_args( $args, array(
+ 'default-image' => '',
+ 'random-default' => false,
+ 'width' => 0,
+ 'height' => 0,
+ 'flex-height' => false,
+ 'flex-width' => false,
+ 'default-text-color' => '',
+ 'header-text' => true,
+ 'uploads' => true,
+ 'wp-head-callback' => '',
+ 'admin-head-callback' => '',
+ 'admin-preview-callback' => '',
+ 'video' => false,
+ 'video-active-callback' => 'is_front_page',
+ ) );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>