diff --git a/src/wp-admin/customize.php b/src/wp-admin/customize.php index 425af6ff1e..aa949e5440 100644 --- a/src/wp-admin/customize.php +++ b/src/wp-admin/customize.php @@ -20,22 +20,15 @@ if ( ! current_user_can( 'customize' ) ) { ); } -wp_reset_vars( array( 'url', 'return' ) ); -$url = wp_unslash( $url ); -$url = wp_validate_redirect( $url, home_url( '/' ) ); -if ( $return ) { - $return = wp_unslash( $return ); - $return = remove_query_arg( wp_removable_query_args(), $return ); - $return = wp_validate_redirect( $return ); +wp_reset_vars( array( 'url', 'return', 'autofocus' ) ); +if ( ! empty( $url ) ) { + $wp_customize->set_preview_url( wp_unslash( $url ) ); } -if ( ! $return ) { - if ( $url ) { - $return = $url; - } elseif ( current_user_can( 'edit_theme_options' ) || current_user_can( 'switch_themes' ) ) { - $return = admin_url( 'themes.php' ); - } else { - $return = admin_url(); - } +if ( ! empty( $return ) ) { + $wp_customize->set_return_url( wp_unslash( $return ) ); +} +if ( ! empty( $autofocus ) && is_array( $autofocus ) ) { + $wp_customize->set_autofocus( wp_unslash( $autofocus ) ); } /** @@ -83,9 +76,7 @@ if ( wp_is_mobile() ) : ?>is_ios() ) { $body_class .= ' ios'; } @@ -94,18 +85,12 @@ if ( is_rtl() ) { } $body_class .= ' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_locale() ) ) ); -if ( $wp_customize->is_theme_active() ) { - $document_title_tmpl = _x( 'Customize: %s', 'Placeholder is the document title from the preview' ); -} else { - $document_title_tmpl = _x( 'Live Preview: %s', 'Placeholder is the document title from the preview' ); -} -$document_title_tmpl = html_entity_decode( $document_title_tmpl, ENT_QUOTES, 'UTF-8' ); // because exported to JS and assigned to document.title -$admin_title = sprintf( $document_title_tmpl, __( 'Loading…' ) ); +$admin_title = sprintf( $wp_customize->get_document_title_template(), __( 'Loading…' ) ); ?><?php echo $admin_title; ?> - + @@ -172,134 +157,13 @@ do_action( 'customize_controls_print_scripts' );
render_panel_templates(); - $wp_customize->render_section_templates(); - $wp_customize->render_control_templates(); - /** - * Print Customizer control scripts in the footer. + * Print templates, control scripts, and settings in the footer. * * @since 3.4.0 */ do_action( 'customize_controls_print_footer_scripts' ); - - /* - * If the frontend and the admin are served from the same domain, load the - * preview over ssl if the Customizer is being loaded over ssl. This avoids - * insecure content warnings. This is not attempted if the admin and frontend - * are on different domains to avoid the case where the frontend doesn't have - * ssl certs. Domain mapping plugins can allow other urls in these conditions - * using the customize_allowed_urls filter. - */ - - $allowed_urls = array( home_url('/') ); - $admin_origin = parse_url( admin_url() ); - $home_origin = parse_url( home_url() ); - $cross_domain = ( strtolower( $admin_origin[ 'host' ] ) != strtolower( $home_origin[ 'host' ] ) ); - - if ( is_ssl() && ! $cross_domain ) - $allowed_urls[] = home_url( '/', 'https' ); - - /** - * Filter the list of URLs allowed to be clicked and followed in the Customizer preview. - * - * @since 3.4.0 - * - * @param array $allowed_urls An array of allowed URLs. - */ - $allowed_urls = array_unique( apply_filters( 'customize_allowed_urls', $allowed_urls ) ); - - $login_url = add_query_arg( array( - 'interim-login' => 1, - 'customize-login' => 1 - ), wp_login_url() ); - - // Prepare Customizer settings to pass to JavaScript. - $settings = array( - 'theme' => array( - 'stylesheet' => $wp_customize->get_stylesheet(), - 'active' => $wp_customize->is_theme_active(), - ), - 'url' => array( - 'preview' => esc_url_raw( $url ? $url : home_url( '/' ) ), - 'parent' => esc_url_raw( admin_url() ), - 'activated' => esc_url_raw( home_url( '/' ) ), - 'ajax' => esc_url_raw( admin_url( 'admin-ajax.php', 'relative' ) ), - 'allowed' => array_map( 'esc_url_raw', $allowed_urls ), - 'isCrossDomain' => $cross_domain, - 'home' => esc_url_raw( home_url( '/' ) ), - 'login' => esc_url_raw( $login_url ), - ), - 'browser' => array( - 'mobile' => wp_is_mobile(), - 'ios' => $is_ios, - ), - 'settings' => array(), - 'controls' => array(), - 'panels' => array(), - 'sections' => array(), - 'nonce' => array( - 'save' => wp_create_nonce( 'save-customize_' . $wp_customize->get_stylesheet() ), - 'preview' => wp_create_nonce( 'preview-customize_' . $wp_customize->get_stylesheet() ) - ), - 'autofocus' => array(), - 'documentTitleTmpl' => $document_title_tmpl, - ); - - // Prepare Customize Setting objects to pass to JavaScript. - foreach ( $wp_customize->settings() as $id => $setting ) { - if ( $setting->check_capabilities() ) { - $settings['settings'][ $id ] = array( - 'value' => $setting->js_value(), - 'transport' => $setting->transport, - 'dirty' => $setting->dirty, - ); - } - } - - // Prepare Customize Control objects to pass to JavaScript. - foreach ( $wp_customize->controls() as $id => $control ) { - if ( $control->check_capabilities() ) { - $settings['controls'][ $id ] = $control->json(); - } - } - - // Prepare Customize Section objects to pass to JavaScript. - foreach ( $wp_customize->sections() as $id => $section ) { - if ( $section->check_capabilities() ) { - $settings['sections'][ $id ] = $section->json(); - } - } - - // Prepare Customize Panel objects to pass to JavaScript. - foreach ( $wp_customize->panels() as $panel_id => $panel ) { - if ( $panel->check_capabilities() ) { - $settings['panels'][ $panel_id ] = $panel->json(); - foreach ( $panel->sections as $section_id => $section ) { - if ( $section->check_capabilities() ) { - $settings['sections'][ $section_id ] = $section->json(); - } - } - } - } - - // Pass to frontend the Customizer construct being deeplinked - if ( isset( $_GET['autofocus'] ) ) { - $autofocus = wp_unslash( $_GET['autofocus'] ); - if ( is_array( $autofocus ) ) { - foreach ( $autofocus as $type => $id ) { - if ( isset( $settings[ $type . 's' ][ $id ] ) ) { - $settings['autofocus'][ $type ] = $id; - } - } - } - } - ?> - diff --git a/src/wp-includes/class-wp-customize-manager.php b/src/wp-includes/class-wp-customize-manager.php index 0234b176f7..00c54c7d49 100644 --- a/src/wp-includes/class-wp-customize-manager.php +++ b/src/wp-includes/class-wp-customize-manager.php @@ -93,6 +93,33 @@ final class WP_Customize_Manager { */ protected $registered_control_types = array(); + /** + * Initial URL being previewed. + * + * @since 4.4.0 + * @access protected + * @var string + */ + protected $preview_url; + + /** + * URL to link the user to when closing the Customizer. + * + * @since 4.4.0 + * @access protected + * @var string + */ + protected $return_url; + + /** + * Mapping of 'panel', 'section', 'control' to the ID which should be autofocused. + * + * @since 4.4.0 + * @access protected + * @var array + */ + protected $autofocus = array(); + /** * Unsanitized values for Customize Settings parsed from $_POST['customized']. * @@ -139,6 +166,14 @@ final class WP_Customize_Manager { add_action( 'customize_register', array( $this, 'register_dynamic_settings' ), 11 ); // allow code to create settings first add_action( 'customize_controls_init', array( $this, 'prepare_controls' ) ); add_action( 'customize_controls_enqueue_scripts', array( $this, 'enqueue_control_scripts' ) ); + + // Render Panel, Section, and Control templates. + add_action( 'customize_controls_print_footer_scripts', array( $this, 'render_panel_templates' ), 1 ); + add_action( 'customize_controls_print_footer_scripts', array( $this, 'render_section_templates' ), 1 ); + add_action( 'customize_controls_print_footer_scripts', array( $this, 'render_control_templates' ), 1 ); + + // Export the settings to JS via the _wpCustomizeSettings variable. + add_action( 'customize_controls_print_footer_scripts', array( $this, 'customize_pane_settings' ), 1000 ); } /** @@ -621,7 +656,6 @@ final class WP_Customize_Manager { */ public function customize_preview_settings() { $settings = array( - 'values' => array(), 'channel' => wp_unslash( $_POST['customize_messenger_channel'] ), 'activePanels' => array(), 'activeSections' => array(), @@ -638,11 +672,6 @@ final class WP_Customize_Manager { ); } - foreach ( $this->settings as $id => $setting ) { - if ( $setting->check_capabilities() ) { - $settings['values'][ $id ] = $setting->js_value(); - } - } foreach ( $this->panels as $panel_id => $panel ) { if ( $panel->check_capabilities() ) { $settings['activePanels'][ $panel_id ] = $panel->active(); @@ -667,6 +696,25 @@ final class WP_Customize_Manager { ?> is_theme_active() ) { + $document_title_tmpl = _x( 'Customize: %s', 'Placeholder is the document title from the preview' ); + } else { + $document_title_tmpl = _x( 'Live Preview: %s', 'Placeholder is the document title from the preview' ); + } + $document_title_tmpl = html_entity_decode( $document_title_tmpl, ENT_QUOTES, 'UTF-8' ); // Because exported to JS and assigned to document.title. + return $document_title_tmpl; + } + + /** + * Set the initial URL to be previewed. + * + * URL is validated. + * + * @since 4.4.0 + * @access public + * + * @param string $preview_url URL to be previewed. + */ + public function set_preview_url( $preview_url ) { + $this->preview_url = wp_validate_redirect( $preview_url, home_url( '/' ) ); + } + + /** + * Get the initial URL to be previewed. + * + * @since 4.4.0 + * @access public + * + * @return string + */ + public function get_preview_url() { + if ( empty( $this->preview_url ) ) { + $preview_url = home_url( '/' ); + } else { + $preview_url = $this->preview_url; + } + return $preview_url; + } + + /** + * Set URL to link the user to when closing the Customizer. + * + * URL is validated. + * + * @since 4.4.0 + * @access public + * + * @param string $return_url URL for return link. + */ + public function set_return_url( $return_url ) { + $return_url = remove_query_arg( wp_removable_query_args(), $return_url ); + $return_url = wp_validate_redirect( $return_url ); + $this->return_url = $return_url; + } + + /** + * Get URL to link the user to when closing the Customizer. + * + * @since 4.4.0 + * @access public + * + * @return string + */ + public function get_return_url() { + if ( $this->return_url ) { + $return_url = $this->return_url; + } else if ( $this->preview_url ) { + $return_url = $this->preview_url; + } else if ( current_user_can( 'edit_theme_options' ) || current_user_can( 'switch_themes' ) ) { + $return_url = admin_url( 'themes.php' ); + } else { + $return_url = admin_url(); + } + return $return_url; + } + + /** + * Set the autofocused constructs. + * + * @param array $autofocus { + * Mapping of 'panel', 'section', 'control' to the ID which should be autofocused. + * + * @type string [$control] ID for control to be autofocused. + * @type string [$section] ID for section to be autofocused. + * @type string [$panel] ID for panel to be autofocused. + * } + */ + public function set_autofocus( $autofocus ) { + $this->autofocus = array_filter( wp_array_slice_assoc( $autofocus, array( 'panel', 'section', 'control' ) ), 'is_string' ); + } + + /** + * Get the autofocused constructs. + * + * @since 4.4.0 + * @access public + * + * @return array { + * Mapping of 'panel', 'section', 'control' to the ID which should be autofocused. + * + * @type string [$control] ID for control to be autofocused. + * @type string [$section] ID for section to be autofocused. + * @type string [$panel] ID for panel to be autofocused. + * } + */ + public function get_autofocus() { + return $this->autofocus; + } + + /** + * Print JavaScript settings for parent window. + * + * @since 4.3.0 + */ + public function customize_pane_settings() { + /* + * If the frontend and the admin are served from the same domain, load the + * preview over ssl if the Customizer is being loaded over ssl. This avoids + * insecure content warnings. This is not attempted if the admin and frontend + * are on different domains to avoid the case where the frontend doesn't have + * ssl certs. Domain mapping plugins can allow other urls in these conditions + * using the customize_allowed_urls filter. + */ + + $allowed_urls = array( home_url( '/' ) ); + $admin_origin = parse_url( admin_url() ); + $home_origin = parse_url( home_url() ); + $cross_domain = ( strtolower( $admin_origin['host'] ) !== strtolower( $home_origin['host'] ) ); + + if ( is_ssl() && ! $cross_domain ) { + $allowed_urls[] = home_url( '/', 'https' ); + } + + /** + * Filter the list of URLs allowed to be clicked and followed in the Customizer preview. + * + * @since 3.4.0 + * + * @param array $allowed_urls An array of allowed URLs. + */ + $allowed_urls = array_unique( apply_filters( 'customize_allowed_urls', $allowed_urls ) ); + + $login_url = add_query_arg( array( + 'interim-login' => 1, + 'customize-login' => 1, + ), wp_login_url() ); + + // Prepare Customizer settings to pass to JavaScript. + $settings = array( + 'theme' => array( + 'stylesheet' => $this->get_stylesheet(), + 'active' => $this->is_theme_active(), + ), + 'url' => array( + 'preview' => esc_url_raw( $this->get_preview_url() ), + 'parent' => esc_url_raw( admin_url() ), + 'activated' => esc_url_raw( home_url( '/' ) ), + 'ajax' => esc_url_raw( admin_url( 'admin-ajax.php', 'relative' ) ), + 'allowed' => array_map( 'esc_url_raw', $allowed_urls ), + 'isCrossDomain' => $cross_domain, + 'home' => esc_url_raw( home_url( '/' ) ), + 'login' => esc_url_raw( $login_url ), + ), + 'browser' => array( + 'mobile' => wp_is_mobile(), + 'ios' => $this->is_ios(), + ), + 'panels' => array(), + 'sections' => array(), + 'nonce' => array( + 'save' => wp_create_nonce( 'save-customize_' . $this->get_stylesheet() ), + 'preview' => wp_create_nonce( 'preview-customize_' . $this->get_stylesheet() ), + ), + 'autofocus' => array(), + 'documentTitleTmpl' => $this->get_document_title_template(), + ); + + // Prepare Customize Section objects to pass to JavaScript. + foreach ( $this->sections() as $id => $section ) { + if ( $section->check_capabilities() ) { + $settings['sections'][ $id ] = $section->json(); + } + } + + // Prepare Customize Panel objects to pass to JavaScript. + foreach ( $this->panels() as $panel_id => $panel ) { + if ( $panel->check_capabilities() ) { + $settings['panels'][ $panel_id ] = $panel->json(); + foreach ( $panel->sections as $section_id => $section ) { + if ( $section->check_capabilities() ) { + $settings['sections'][ $section_id ] = $section->json(); + } + } + } + } + + // Pass to frontend the Customizer construct being deeplinked. + foreach ( $this->get_autofocus() as $type => $id ) { + $can_autofocus = ( + ( 'control' === $type && $this->get_control( $id ) && $this->get_control( $id )->check_capabilities() ) + || + ( 'section' === $type && isset( $settings['sections'][ $id ] ) ) + || + ( 'panel' === $type && isset( $settings['panels'][ $id ] ) ) + ); + if ( $can_autofocus ) { + $settings['autofocus'][ $type ] = $id; + } + } + + ?> + + undefined = new stdClass(); } + /** + * Tear down test. + */ function tearDown() { $this->manager = null; unset( $GLOBALS['wp_customize'] ); @@ -156,6 +181,10 @@ class Tests_WP_Customize_Manager extends WP_UnitTestCase { /** * In lieu of closures, callback for customize_dynamic_setting_args filter added for test_register_dynamic_settings(). + * + * @param array $setting_args Setting args. + * @param string $setting_id Setting ID. + * @return array */ function filter_customize_dynamic_setting_args_for_test_dynamic_settings( $setting_args, $setting_id ) { $this->assertEquals( false, $setting_args, 'Expected $setting_args to be false by default.' ); @@ -168,6 +197,11 @@ class Tests_WP_Customize_Manager extends WP_UnitTestCase { /** * In lieu of closures, callback for customize_dynamic_setting_class filter added for test_register_dynamic_settings(). + * + * @param string $setting_class Setting class. + * @param string $setting_id Setting ID. + * @param array $setting_args Setting args. + * @return string */ function filter_customize_dynamic_setting_class_for_test_dynamic_settings( $setting_class, $setting_id, $setting_args ) { $this->assertEquals( 'WP_Customize_Setting', $setting_class ); @@ -175,4 +209,122 @@ class Tests_WP_Customize_Manager extends WP_UnitTestCase { $this->assertInternalType( 'array', $setting_args ); return $setting_class; } + + /** + * Test is_ios() method. + * + * @see WP_Customize_Manager::is_ios() + */ + function test_is_ios() { + $this->markTestSkipped( 'WP_Customize_Manager::is_ios() cannot be tested because it uses wp_is_mobile() which contains a static var.' ); + } + + /** + * Test get_document_title_template() method. + * + * @see WP_Customize_Manager::get_document_title_template() + */ + function test_get_document_title_template() { + $tpl = $this->manager->get_document_title_template(); + $this->assertContains( '%s', $tpl ); + } + + /** + * Test get_preview_url()/set_preview_url methods. + * + * @see WP_Customize_Manager::get_preview_url() + * @see WP_Customize_Manager::set_preview_url() + */ + function test_preview_url() { + $this->assertEquals( home_url( '/' ), $this->manager->get_preview_url() ); + $preview_url = home_url( '/foo/bar/baz/' ); + $this->manager->set_preview_url( $preview_url ); + $this->assertEquals( $preview_url, $this->manager->get_preview_url() ); + $this->manager->set_preview_url( 'http://illegalsite.example.com/food/' ); + $this->assertEquals( home_url( '/' ), $this->manager->get_preview_url() ); + } + + /** + * Test get_return_url()/set_return_url() methods. + * + * @see WP_Customize_Manager::get_return_url() + * @see WP_Customize_Manager::set_return_url() + */ + function test_return_url() { + wp_set_current_user( $this->factory->user->create( array( 'role' => 'author' ) ) ); + $this->assertEquals( get_admin_url(), $this->manager->get_return_url() ); + + wp_set_current_user( $this->factory->user->create( array( 'role' => 'administrator' ) ) ); + $this->assertTrue( current_user_can( 'edit_theme_options' ) ); + $this->assertEquals( admin_url( 'themes.php' ), $this->manager->get_return_url() ); + + $preview_url = home_url( '/foo/' ); + $this->manager->set_preview_url( $preview_url ); + $this->assertEquals( $preview_url, $this->manager->get_return_url() ); + + $this->manager->set_return_url( admin_url( 'edit.php?trashed=1' ) ); + $this->assertEquals( admin_url( 'edit.php' ), $this->manager->get_return_url() ); + } + + /** + * Test get_autofocus()/set_autofocus() methods. + * + * @see WP_Customize_Manager::get_autofocus() + * @see WP_Customize_Manager::set_autofocus() + */ + function test_autofocus() { + $this->assertEmpty( $this->manager->get_autofocus() ); + + $this->manager->set_autofocus( array( 'unrecognized' => 'food' ) ); + $this->assertEmpty( $this->manager->get_autofocus() ); + + $autofocus = array( 'control' => 'blogname' ); + $this->manager->set_autofocus( $autofocus ); + $this->assertEquals( $autofocus, $this->manager->get_autofocus() ); + + $autofocus = array( 'section' => 'colors' ); + $this->manager->set_autofocus( $autofocus ); + $this->assertEquals( $autofocus, $this->manager->get_autofocus() ); + + $autofocus = array( 'panel' => 'widgets' ); + $this->manager->set_autofocus( $autofocus ); + $this->assertEquals( $autofocus, $this->manager->get_autofocus() ); + + $autofocus = array( 'control' => array( 'blogname', 'blogdescription' ) ); + $this->manager->set_autofocus( $autofocus ); + $this->assertEmpty( $this->manager->get_autofocus() ); + } + + /** + * Test customize_pane_settings() method. + * + * @see WP_Customize_Manager::customize_pane_settings() + */ + function test_customize_pane_settings() { + wp_set_current_user( $this->factory->user->create( array( 'role' => 'administrator' ) ) ); + $this->manager->register_controls(); + $this->manager->prepare_controls(); + $autofocus = array( 'control' => 'blogname' ); + $this->manager->set_autofocus( $autofocus ); + + ob_start(); + $this->manager->customize_pane_settings(); + $content = ob_get_clean(); + + $this->assertContains( 'var _wpCustomizeSettings =', $content ); + $this->assertContains( '"blogname"', $content ); + $this->assertContains( '_wpCustomizeSettings.controls', $content ); + $this->assertContains( '_wpCustomizeSettings.settings', $content ); + $this->assertContains( '', $content ); + + $this->assertNotEmpty( preg_match( '#var _wpCustomizeSettings\s*=\s*({.*?});\s*\n#', $content, $matches ) ); + $json = $matches[1]; + $data = json_decode( $json, true ); + $this->assertNotEmpty( $data ); + + $this->assertEqualSets( array( 'theme', 'url', 'browser', 'panels', 'sections', 'nonce', 'autofocus', 'documentTitleTmpl' ), array_keys( $data ) ); + $this->assertEquals( $autofocus, $data['autofocus'] ); + $this->assertArrayHasKey( 'save', $data['nonce'] ); + $this->assertArrayHasKey( 'preview', $data['nonce'] ); + } }