X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/dc1231b7312fbdca99e9e887cc2bb35a28f85cdc..refs/tags/wordpress-4.4:/wp-includes/class-wp-customize-manager.php?ds=sidebyside diff --git a/wp-includes/class-wp-customize-manager.php b/wp-includes/class-wp-customize-manager.php index 9cac3385..9f15d31f 100644 --- a/wp-includes/class-wp-customize-manager.php +++ b/wp-includes/class-wp-customize-manager.php @@ -24,6 +24,8 @@ final class WP_Customize_Manager { /** * An instance of the theme being previewed. * + * @since 3.4.0 + * @access protected * @var WP_Theme */ protected $theme; @@ -31,6 +33,8 @@ final class WP_Customize_Manager { /** * The directory name of the previously active theme (within the theme_root). * + * @since 3.4.0 + * @access protected * @var string */ protected $original_stylesheet; @@ -38,33 +42,83 @@ final class WP_Customize_Manager { /** * Whether this is a Customizer pageload. * + * @since 3.4.0 + * @access protected * @var bool */ protected $previewing = false; /** - * Methods and properties deailing with managing widgets in the Customizer. + * Methods and properties dealing with managing widgets in the Customizer. * + * @since 3.9.0 + * @access public * @var WP_Customize_Widgets */ public $widgets; /** - * Methods and properties deailing with managing nav menus in the Customizer. + * Methods and properties dealing with managing nav menus in the Customizer. * + * @since 4.3.0 + * @access public * @var WP_Customize_Nav_Menus */ public $nav_menus; - protected $settings = array(); + /** + * Registered instances of WP_Customize_Setting. + * + * @since 3.4.0 + * @access protected + * @var array + */ + protected $settings = array(); + + /** + * Sorted top-level instances of WP_Customize_Panel and WP_Customize_Section. + * + * @since 4.0.0 + * @access protected + * @var array + */ protected $containers = array(); - protected $panels = array(); - protected $sections = array(); - protected $controls = array(); - protected $nonce_tick; + /** + * Registered instances of WP_Customize_Panel. + * + * @since 4.0.0 + * @access protected + * @var array + */ + protected $panels = array(); - protected $customized; + /** + * Registered instances of WP_Customize_Section. + * + * @since 3.4.0 + * @access protected + * @var array + */ + protected $sections = array(); + + /** + * Registered instances of WP_Customize_Control. + * + * @since 3.4.0 + * @access protected + * @var array + */ + protected $controls = array(); + + /** + * Return value of check_ajax_referer() in customize_preview_init() method. + * + * @since 3.5.0 + * @access protected + * @var false|int + */ + protected $nonce_tick; /** * Panel types that may be rendered from JS templates. @@ -93,6 +147,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']. * @@ -110,11 +191,63 @@ final class WP_Customize_Manager { require_once( ABSPATH . WPINC . '/class-wp-customize-panel.php' ); require_once( ABSPATH . WPINC . '/class-wp-customize-section.php' ); require_once( ABSPATH . WPINC . '/class-wp-customize-control.php' ); - require_once( ABSPATH . WPINC . '/class-wp-customize-widgets.php' ); - require_once( ABSPATH . WPINC . '/class-wp-customize-nav-menus.php' ); - $this->widgets = new WP_Customize_Widgets( $this ); - $this->nav_menus = new WP_Customize_Nav_Menus( $this ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-color-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-media-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-upload-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-image-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-image-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-cropped-image-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-site-icon-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-header-image-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-theme-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-widget-area-customize-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-widget-form-customize-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-location-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-name-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-auto-add-control.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-new-menu-control.php' ); + + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menus-panel.php' ); + + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-themes-section.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-sidebar-section.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-section.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-new-menu-section.php' ); + + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-filter-setting.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-header-image-setting.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-image-setting.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-setting.php' ); + require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-setting.php' ); + + /** + * Filter the core Customizer components to load. + * + * This allows Core components to be excluded from being instantiated by + * filtering them out of the array. Note that this filter generally runs + * during the plugins_loaded action, so it cannot be added + * in a theme. + * + * @since 4.4.0 + * + * @see WP_Customize_Manager::__construct() + * + * @param array $components List of core components to load. + * @param WP_Customize_Manager $this WP_Customize_Manager instance. + */ + $components = apply_filters( 'customize_loaded_components', array( 'widgets', 'nav_menus' ), $this ); + + if ( in_array( 'widgets', $components ) ) { + require_once( ABSPATH . WPINC . '/class-wp-customize-widgets.php' ); + $this->widgets = new WP_Customize_Widgets( $this ); + } + if ( in_array( 'nav_menus', $components ) ) { + require_once( ABSPATH . WPINC . '/class-wp-customize-nav-menus.php' ); + $this->nav_menus = new WP_Customize_Nav_Menus( $this ); + } add_filter( 'wp_die_handler', array( $this, 'wp_die_handler' ) ); @@ -139,6 +272,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 ); } /** @@ -218,13 +359,13 @@ final class WP_Customize_Manager { if ( is_admin() && ! $doing_ajax_or_is_customized ) { auth_redirect(); } elseif ( $doing_ajax_or_is_customized && ! is_user_logged_in() ) { - $this->wp_die( 0 ); + $this->wp_die( 0, __( 'You must be logged in to complete this action.' ) ); } show_admin_bar( false ); if ( ! current_user_can( 'customize' ) ) { - $this->wp_die( -1 ); + $this->wp_die( -1, __( 'You are not allowed to customize the appearance of this site.' ) ); } $this->original_stylesheet = get_stylesheet(); @@ -238,17 +379,17 @@ final class WP_Customize_Manager { // If the requested theme is not the active theme and the user doesn't have the // switch_themes cap, bail. if ( ! current_user_can( 'switch_themes' ) ) { - $this->wp_die( -1 ); + $this->wp_die( -1, __( 'You are not allowed to edit theme options on this site.' ) ); } // If the theme has errors while loading, bail. if ( $this->theme()->errors() ) { - $this->wp_die( -1 ); + $this->wp_die( -1, $this->theme()->errors()->get_error_message() ); } // If the theme isn't allowed per multisite settings, bail. if ( ! $this->theme()->is_allowed() ) { - $this->wp_die( -1 ); + $this->wp_die( -1, __( 'The requested theme does not exist.' ) ); } } @@ -518,6 +659,36 @@ final class WP_Customize_Manager { public function set_post_value( $setting_id, $value ) { $this->unsanitized_post_values(); $this->_post_values[ $setting_id ] = $value; + + /** + * Announce when a specific setting's unsanitized post value has been set. + * + * Fires when the {@see WP_Customize_Manager::set_post_value()} method is called. + * + * The dynamic portion of the hook name, `$setting_id`, refers to the setting ID. + * + * @since 4.4.0 + * + * @param mixed $value Unsanitized setting post value. + * @param WP_Customize_Manager $this WP_Customize_Manager instance. + */ + do_action( "customize_post_value_set_{$setting_id}", $value, $this ); + + /** + * Announce when any setting's unsanitized post value has been set. + * + * Fires when the {@see WP_Customize_Manager::set_post_value()} method is called. + * + * This is useful for WP_Customize_Setting instances to watch + * in order to update a cached previewed value. + * + * @since 4.4.0 + * + * @param string $setting_id Setting ID. + * @param mixed $value Unsanitized setting post value. + * @param WP_Customize_Manager $this WP_Customize_Manager instance. + */ + do_action( 'customize_post_value_set', $setting_id, $value, $this ); } /** @@ -621,14 +792,10 @@ 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(), 'activeControls' => array(), - 'l10n' => array( - 'loading' => __( 'Loading ...' ), - ), ); if ( 2 == $this->nonce_tick ) { @@ -638,11 +805,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 +829,25 @@ final class WP_Customize_Manager { ?> priority === $b->priority ) { - return $a->instance_number - $a->instance_number; + return $a->instance_number - $b->instance_number; } else { return $a->priority - $b->priority; } @@ -1264,6 +1446,285 @@ final class WP_Customize_Manager { } } + /** + * Determine whether the user agent is iOS. + * + * @since 4.4.0 + * @access public + * + * @return bool Whether the user agent is iOS. + */ + public function is_ios() { + return wp_is_mobile() && preg_match( '/iPad|iPod|iPhone/', $_SERVER['HTTP_USER_AGENT'] ); + } + + /** + * Get the template string for the Customizer pane document title. + * + * @since 4.4.0 + * @access public + * + * @return string The template string for the document title. + */ + public function get_document_title_template() { + if ( $this->is_theme_active() ) { + /* translators: %s: document title from the preview */ + $document_title_tmpl = __( 'Customize: %s' ); + } else { + /* translators: %s: document title from the preview */ + $document_title_tmpl = __( 'Live Preview: %s' ); + } + $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 URL being previewed. + */ + 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 URL for link to close Customizer. + */ + public function get_return_url() { + $referer = wp_get_referer(); + if ( $this->return_url ) { + $return_url = $this->return_url; + } else if ( $referer && 'customize.php' !== basename( parse_url( $referer, PHP_URL_PATH ) ) ) { + $return_url = $referer; + } else if ( $this->preview_url ) { + $return_url = $this->preview_url; + } else { + $return_url = home_url( '/' ); + } + return $return_url; + } + + /** + * Set the autofocused constructs. + * + * @since 4.4.0 + * @access public + * + * @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.4.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; + } + } + + ?> + +