| [ Index ] |
PHP Cross Reference of WordPress |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * WordPress Customize Manager classes 4 * 5 * @package WordPress 6 * @subpackage Customize 7 * @since 3.4.0 8 */ 9 10 /** 11 * Customize Manager class. 12 * 13 * Bootstraps the Customize experience on the server-side. 14 * 15 * Sets up the theme-switching process if a theme other than the active one is 16 * being previewed and customized. 17 * 18 * Serves as a factory for Customize Controls and Settings, and 19 * instantiates default Customize Controls and Settings. 20 * 21 * @since 3.4.0 22 */ 23 final class WP_Customize_Manager { 24 /** 25 * An instance of the theme being previewed. 26 * 27 * @since 3.4.0 28 * @var WP_Theme 29 */ 30 protected $theme; 31 32 /** 33 * The directory name of the previously active theme (within the theme_root). 34 * 35 * @since 3.4.0 36 * @var string 37 */ 38 protected $original_stylesheet; 39 40 /** 41 * Whether this is a Customizer pageload. 42 * 43 * @since 3.4.0 44 * @var bool 45 */ 46 protected $previewing = false; 47 48 /** 49 * Methods and properties dealing with managing widgets in the Customizer. 50 * 51 * @since 3.9.0 52 * @var WP_Customize_Widgets 53 */ 54 public $widgets; 55 56 /** 57 * Methods and properties dealing with managing nav menus in the Customizer. 58 * 59 * @since 4.3.0 60 * @var WP_Customize_Nav_Menus 61 */ 62 public $nav_menus; 63 64 /** 65 * Methods and properties dealing with selective refresh in the Customizer preview. 66 * 67 * @since 4.5.0 68 * @var WP_Customize_Selective_Refresh 69 */ 70 public $selective_refresh; 71 72 /** 73 * Registered instances of WP_Customize_Setting. 74 * 75 * @since 3.4.0 76 * @var array 77 */ 78 protected $settings = array(); 79 80 /** 81 * Sorted top-level instances of WP_Customize_Panel and WP_Customize_Section. 82 * 83 * @since 4.0.0 84 * @var array 85 */ 86 protected $containers = array(); 87 88 /** 89 * Registered instances of WP_Customize_Panel. 90 * 91 * @since 4.0.0 92 * @var array 93 */ 94 protected $panels = array(); 95 96 /** 97 * List of core components. 98 * 99 * @since 4.5.0 100 * @var array 101 */ 102 protected $components = array( 'widgets', 'nav_menus' ); 103 104 /** 105 * Registered instances of WP_Customize_Section. 106 * 107 * @since 3.4.0 108 * @var array 109 */ 110 protected $sections = array(); 111 112 /** 113 * Registered instances of WP_Customize_Control. 114 * 115 * @since 3.4.0 116 * @var array 117 */ 118 protected $controls = array(); 119 120 /** 121 * Panel types that may be rendered from JS templates. 122 * 123 * @since 4.3.0 124 * @var array 125 */ 126 protected $registered_panel_types = array(); 127 128 /** 129 * Section types that may be rendered from JS templates. 130 * 131 * @since 4.3.0 132 * @var array 133 */ 134 protected $registered_section_types = array(); 135 136 /** 137 * Control types that may be rendered from JS templates. 138 * 139 * @since 4.1.0 140 * @var array 141 */ 142 protected $registered_control_types = array(); 143 144 /** 145 * Initial URL being previewed. 146 * 147 * @since 4.4.0 148 * @var string 149 */ 150 protected $preview_url; 151 152 /** 153 * URL to link the user to when closing the Customizer. 154 * 155 * @since 4.4.0 156 * @var string 157 */ 158 protected $return_url; 159 160 /** 161 * Mapping of 'panel', 'section', 'control' to the ID which should be autofocused. 162 * 163 * @since 4.4.0 164 * @var array 165 */ 166 protected $autofocus = array(); 167 168 /** 169 * Messenger channel. 170 * 171 * @since 4.7.0 172 * @var string 173 */ 174 protected $messenger_channel; 175 176 /** 177 * Whether the autosave revision of the changeset should be loaded. 178 * 179 * @since 4.9.0 180 * @var bool 181 */ 182 protected $autosaved = false; 183 184 /** 185 * Whether the changeset branching is allowed. 186 * 187 * @since 4.9.0 188 * @var bool 189 */ 190 protected $branching = true; 191 192 /** 193 * Whether settings should be previewed. 194 * 195 * @since 4.9.0 196 * @var bool 197 */ 198 protected $settings_previewed = true; 199 200 /** 201 * Whether a starter content changeset was saved. 202 * 203 * @since 4.9.0 204 * @var bool 205 */ 206 protected $saved_starter_content_changeset = false; 207 208 /** 209 * Unsanitized values for Customize Settings parsed from $_POST['customized']. 210 * 211 * @var array 212 */ 213 private $_post_values; 214 215 /** 216 * Changeset UUID. 217 * 218 * @since 4.7.0 219 * @var string 220 */ 221 private $_changeset_uuid; 222 223 /** 224 * Changeset post ID. 225 * 226 * @since 4.7.0 227 * @var int|false 228 */ 229 private $_changeset_post_id; 230 231 /** 232 * Changeset data loaded from a customize_changeset post. 233 * 234 * @since 4.7.0 235 * @var array|null 236 */ 237 private $_changeset_data; 238 239 /** 240 * Constructor. 241 * 242 * @since 3.4.0 243 * @since 4.7.0 Added `$args` parameter. 244 * 245 * @param array $args { 246 * Args. 247 * 248 * @type null|string|false $changeset_uuid Changeset UUID, the `post_name` for the customize_changeset post containing the customized state. 249 * Defaults to `null` resulting in a UUID to be immediately generated. If `false` is provided, then 250 * then the changeset UUID will be determined during `after_setup_theme`: when the 251 * `customize_changeset_branching` filter returns false, then the default UUID will be that 252 * of the most recent `customize_changeset` post that has a status other than 'auto-draft', 253 * 'publish', or 'trash'. Otherwise, if changeset branching is enabled, then a random UUID will be used. 254 * @type string $theme Theme to be previewed (for theme switch). Defaults to customize_theme or theme query params. 255 * @type string $messenger_channel Messenger channel. Defaults to customize_messenger_channel query param. 256 * @type bool $settings_previewed If settings should be previewed. Defaults to true. 257 * @type bool $branching If changeset branching is allowed; otherwise, changesets are linear. Defaults to true. 258 * @type bool $autosaved If data from a changeset's autosaved revision should be loaded if it exists. Defaults to false. 259 * } 260 */ 261 public function __construct( $args = array() ) { 262 263 $args = array_merge( 264 array_fill_keys( array( 'changeset_uuid', 'theme', 'messenger_channel', 'settings_previewed', 'autosaved', 'branching' ), null ), 265 $args 266 ); 267 268 // Note that the UUID format will be validated in the setup_theme() method. 269 if ( ! isset( $args['changeset_uuid'] ) ) { 270 $args['changeset_uuid'] = wp_generate_uuid4(); 271 } 272 273 // The theme and messenger_channel should be supplied via $args, but they are also looked at in the $_REQUEST global here for back-compat. 274 if ( ! isset( $args['theme'] ) ) { 275 if ( isset( $_REQUEST['customize_theme'] ) ) { 276 $args['theme'] = wp_unslash( $_REQUEST['customize_theme'] ); 277 } elseif ( isset( $_REQUEST['theme'] ) ) { // Deprecated. 278 $args['theme'] = wp_unslash( $_REQUEST['theme'] ); 279 } 280 } 281 if ( ! isset( $args['messenger_channel'] ) && isset( $_REQUEST['customize_messenger_channel'] ) ) { 282 $args['messenger_channel'] = sanitize_key( wp_unslash( $_REQUEST['customize_messenger_channel'] ) ); 283 } 284 285 $this->original_stylesheet = get_stylesheet(); 286 $this->theme = wp_get_theme( 0 === validate_file( $args['theme'] ) ? $args['theme'] : null ); 287 $this->messenger_channel = $args['messenger_channel']; 288 $this->_changeset_uuid = $args['changeset_uuid']; 289 290 foreach ( array( 'settings_previewed', 'autosaved', 'branching' ) as $key ) { 291 if ( isset( $args[ $key ] ) ) { 292 $this->$key = (bool) $args[ $key ]; 293 } 294 } 295 296 require_once ( ABSPATH . WPINC . '/class-wp-customize-setting.php' ); 297 require_once ( ABSPATH . WPINC . '/class-wp-customize-panel.php' ); 298 require_once ( ABSPATH . WPINC . '/class-wp-customize-section.php' ); 299 require_once ( ABSPATH . WPINC . '/class-wp-customize-control.php' ); 300 301 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-color-control.php' ); 302 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-media-control.php' ); 303 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-upload-control.php' ); 304 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-image-control.php' ); 305 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-background-image-control.php' ); 306 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-background-position-control.php' ); 307 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-cropped-image-control.php' ); 308 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-site-icon-control.php' ); 309 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-header-image-control.php' ); 310 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-theme-control.php' ); 311 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-code-editor-control.php' ); 312 require_once ( ABSPATH . WPINC . '/customize/class-wp-widget-area-customize-control.php' ); 313 require_once ( ABSPATH . WPINC . '/customize/class-wp-widget-form-customize-control.php' ); 314 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-control.php' ); 315 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-control.php' ); 316 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-location-control.php' ); 317 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-name-control.php' ); 318 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-locations-control.php' ); 319 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-auto-add-control.php' ); 320 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-new-menu-control.php' ); // @todo Remove in a future release. See #42364. 321 322 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menus-panel.php' ); 323 324 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-themes-panel.php' ); 325 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-themes-section.php' ); 326 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-sidebar-section.php' ); 327 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-section.php' ); 328 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-new-menu-section.php' ); // @todo Remove in a future release. See #42364. 329 330 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-custom-css-setting.php' ); 331 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-filter-setting.php' ); 332 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-header-image-setting.php' ); 333 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-background-image-setting.php' ); 334 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-setting.php' ); 335 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-setting.php' ); 336 337 /** 338 * Filters the core Customizer components to load. 339 * 340 * This allows Core components to be excluded from being instantiated by 341 * filtering them out of the array. Note that this filter generally runs 342 * during the {@see 'plugins_loaded'} action, so it cannot be added 343 * in a theme. 344 * 345 * @since 4.4.0 346 * 347 * @see WP_Customize_Manager::__construct() 348 * 349 * @param string[] $components Array of core components to load. 350 * @param WP_Customize_Manager $this WP_Customize_Manager instance. 351 */ 352 $components = apply_filters( 'customize_loaded_components', $this->components, $this ); 353 354 require_once ( ABSPATH . WPINC . '/customize/class-wp-customize-selective-refresh.php' ); 355 $this->selective_refresh = new WP_Customize_Selective_Refresh( $this ); 356 357 if ( in_array( 'widgets', $components, true ) ) { 358 require_once ( ABSPATH . WPINC . '/class-wp-customize-widgets.php' ); 359 $this->widgets = new WP_Customize_Widgets( $this ); 360 } 361 362 if ( in_array( 'nav_menus', $components, true ) ) { 363 require_once ( ABSPATH . WPINC . '/class-wp-customize-nav-menus.php' ); 364 $this->nav_menus = new WP_Customize_Nav_Menus( $this ); 365 } 366 367 add_action( 'setup_theme', array( $this, 'setup_theme' ) ); 368 add_action( 'wp_loaded', array( $this, 'wp_loaded' ) ); 369 370 // Do not spawn cron (especially the alternate cron) while running the Customizer. 371 remove_action( 'init', 'wp_cron' ); 372 373 // Do not run update checks when rendering the controls. 374 remove_action( 'admin_init', '_maybe_update_core' ); 375 remove_action( 'admin_init', '_maybe_update_plugins' ); 376 remove_action( 'admin_init', '_maybe_update_themes' ); 377 378 add_action( 'wp_ajax_customize_save', array( $this, 'save' ) ); 379 add_action( 'wp_ajax_customize_trash', array( $this, 'handle_changeset_trash_request' ) ); 380 add_action( 'wp_ajax_customize_refresh_nonces', array( $this, 'refresh_nonces' ) ); 381 add_action( 'wp_ajax_customize_load_themes', array( $this, 'handle_load_themes_request' ) ); 382 add_filter( 'heartbeat_settings', array( $this, 'add_customize_screen_to_heartbeat_settings' ) ); 383 add_filter( 'heartbeat_received', array( $this, 'check_changeset_lock_with_heartbeat' ), 10, 3 ); 384 add_action( 'wp_ajax_customize_override_changeset_lock', array( $this, 'handle_override_changeset_lock_request' ) ); 385 add_action( 'wp_ajax_customize_dismiss_autosave_or_lock', array( $this, 'handle_dismiss_autosave_or_lock_request' ) ); 386 387 add_action( 'customize_register', array( $this, 'register_controls' ) ); 388 add_action( 'customize_register', array( $this, 'register_dynamic_settings' ), 11 ); // allow code to create settings first 389 add_action( 'customize_controls_init', array( $this, 'prepare_controls' ) ); 390 add_action( 'customize_controls_enqueue_scripts', array( $this, 'enqueue_control_scripts' ) ); 391 392 // Render Common, Panel, Section, and Control templates. 393 add_action( 'customize_controls_print_footer_scripts', array( $this, 'render_panel_templates' ), 1 ); 394 add_action( 'customize_controls_print_footer_scripts', array( $this, 'render_section_templates' ), 1 ); 395 add_action( 'customize_controls_print_footer_scripts', array( $this, 'render_control_templates' ), 1 ); 396 397 // Export header video settings with the partial response. 398 add_filter( 'customize_render_partials_response', array( $this, 'export_header_video_settings' ), 10, 3 ); 399 400 // Export the settings to JS via the _wpCustomizeSettings variable. 401 add_action( 'customize_controls_print_footer_scripts', array( $this, 'customize_pane_settings' ), 1000 ); 402 403 // Add theme update notices. 404 if ( current_user_can( 'install_themes' ) || current_user_can( 'update_themes' ) ) { 405 require_once ABSPATH . 'wp-admin/includes/update.php'; 406 add_action( 'customize_controls_print_footer_scripts', 'wp_print_admin_notice_templates' ); 407 } 408 } 409 410 /** 411 * Return true if it's an Ajax request. 412 * 413 * @since 3.4.0 414 * @since 4.2.0 Added `$action` param. 415 * 416 * @param string|null $action Whether the supplied Ajax action is being run. 417 * @return bool True if it's an Ajax request, false otherwise. 418 */ 419 public function doing_ajax( $action = null ) { 420 if ( ! wp_doing_ajax() ) { 421 return false; 422 } 423 424 if ( ! $action ) { 425 return true; 426 } else { 427 /* 428 * Note: we can't just use doing_action( "wp_ajax_{$action}" ) because we need 429 * to check before admin-ajax.php gets to that point. 430 */ 431 return isset( $_REQUEST['action'] ) && wp_unslash( $_REQUEST['action'] ) === $action; 432 } 433 } 434 435 /** 436 * Custom wp_die wrapper. Returns either the standard message for UI 437 * or the Ajax message. 438 * 439 * @since 3.4.0 440 * 441 * @param mixed $ajax_message Ajax return 442 * @param mixed $message UI message 443 */ 444 protected function wp_die( $ajax_message, $message = null ) { 445 if ( $this->doing_ajax() ) { 446 wp_die( $ajax_message ); 447 } 448 449 if ( ! $message ) { 450 $message = __( 'Something went wrong.' ); 451 } 452 453 if ( $this->messenger_channel ) { 454 ob_start(); 455 wp_enqueue_scripts(); 456 wp_print_scripts( array( 'customize-base' ) ); 457 458 $settings = array( 459 'messengerArgs' => array( 460 'channel' => $this->messenger_channel, 461 'url' => wp_customize_url(), 462 ), 463 'error' => $ajax_message, 464 ); 465 ?> 466 <script> 467 ( function( api, settings ) { 468 var preview = new api.Messenger( settings.messengerArgs ); 469 preview.send( 'iframe-loading-error', settings.error ); 470 } )( wp.customize, <?php echo wp_json_encode( $settings ); ?> ); 471 </script> 472 <?php 473 $message .= ob_get_clean(); 474 } 475 476 wp_die( $message ); 477 } 478 479 /** 480 * Return the Ajax wp_die() handler if it's a customized request. 481 * 482 * @since 3.4.0 483 * @deprecated 4.7.0 484 * 485 * @return callable Die handler. 486 */ 487 public function wp_die_handler() { 488 _deprecated_function( __METHOD__, '4.7.0' ); 489 490 if ( $this->doing_ajax() || isset( $_POST['customized'] ) ) { 491 return '_ajax_wp_die_handler'; 492 } 493 494 return '_default_wp_die_handler'; 495 } 496 497 /** 498 * Start preview and customize theme. 499 * 500 * Check if customize query variable exist. Init filters to filter the current theme. 501 * 502 * @since 3.4.0 503 * 504 * @global string $pagenow 505 */ 506 public function setup_theme() { 507 global $pagenow; 508 509 // Check permissions for customize.php access since this method is called before customize.php can run any code, 510 if ( 'customize.php' === $pagenow && ! current_user_can( 'customize' ) ) { 511 if ( ! is_user_logged_in() ) { 512 auth_redirect(); 513 } else { 514 wp_die( 515 '<h1>' . __( 'You need a higher level of permission.' ) . '</h1>' . 516 '<p>' . __( 'Sorry, you are not allowed to customize this site.' ) . '</p>', 517 403 518 ); 519 } 520 return; 521 } 522 523 // If a changeset was provided is invalid. 524 if ( isset( $this->_changeset_uuid ) && false !== $this->_changeset_uuid && ! wp_is_uuid( $this->_changeset_uuid ) ) { 525 $this->wp_die( -1, __( 'Invalid changeset UUID' ) ); 526 } 527 528 /* 529 * Clear incoming post data if the user lacks a CSRF token (nonce). Note that the customizer 530 * application will inject the customize_preview_nonce query parameter into all Ajax requests. 531 * For similar behavior elsewhere in WordPress, see rest_cookie_check_errors() which logs out 532 * a user when a valid nonce isn't present. 533 */ 534 $has_post_data_nonce = ( 535 check_ajax_referer( 'preview-customize_' . $this->get_stylesheet(), 'nonce', false ) 536 || 537 check_ajax_referer( 'save-customize_' . $this->get_stylesheet(), 'nonce', false ) 538 || 539 check_ajax_referer( 'preview-customize_' . $this->get_stylesheet(), 'customize_preview_nonce', false ) 540 ); 541 if ( ! current_user_can( 'customize' ) || ! $has_post_data_nonce ) { 542 unset( $_POST['customized'] ); 543 unset( $_REQUEST['customized'] ); 544 } 545 546 /* 547 * If unauthenticated then require a valid changeset UUID to load the preview. 548 * In this way, the UUID serves as a secret key. If the messenger channel is present, 549 * then send unauthenticated code to prompt re-auth. 550 */ 551 if ( ! current_user_can( 'customize' ) && ! $this->changeset_post_id() ) { 552 $this->wp_die( $this->messenger_channel ? 0 : -1, __( 'Non-existent changeset UUID.' ) ); 553 } 554 555 if ( ! headers_sent() ) { 556 send_origin_headers(); 557 } 558 559 // Hide the admin bar if we're embedded in the customizer iframe. 560 if ( $this->messenger_channel ) { 561 show_admin_bar( false ); 562 } 563 564 if ( $this->is_theme_active() ) { 565 // Once the theme is loaded, we'll validate it. 566 add_action( 'after_setup_theme', array( $this, 'after_setup_theme' ) ); 567 } else { 568 // If the requested theme is not the active theme and the user doesn't have the 569 // switch_themes cap, bail. 570 if ( ! current_user_can( 'switch_themes' ) ) { 571 $this->wp_die( -1, __( 'Sorry, you are not allowed to edit theme options on this site.' ) ); 572 } 573 574 // If the theme has errors while loading, bail. 575 if ( $this->theme()->errors() ) { 576 $this->wp_die( -1, $this->theme()->errors()->get_error_message() ); 577 } 578 579 // If the theme isn't allowed per multisite settings, bail. 580 if ( ! $this->theme()->is_allowed() ) { 581 $this->wp_die( -1, __( 'The requested theme does not exist.' ) ); 582 } 583 } 584 585 // Make sure changeset UUID is established immediately after the theme is loaded. 586 add_action( 'after_setup_theme', array( $this, 'establish_loaded_changeset' ), 5 ); 587 588 /* 589 * Import theme starter content for fresh installations when landing in the customizer. 590 * Import starter content at after_setup_theme:100 so that any 591 * add_theme_support( 'starter-content' ) calls will have been made. 592 */ 593 if ( get_option( 'fresh_site' ) && 'customize.php' === $pagenow ) { 594 add_action( 'after_setup_theme', array( $this, 'import_theme_starter_content' ), 100 ); 595 } 596 597 $this->start_previewing_theme(); 598 } 599 600 /** 601 * Establish the loaded changeset. 602 * 603 * This method runs right at after_setup_theme and applies the 'customize_changeset_branching' filter to determine 604 * whether concurrent changesets are allowed. Then if the Customizer is not initialized with a `changeset_uuid` param, 605 * this method will determine which UUID should be used. If changeset branching is disabled, then the most saved 606 * changeset will be loaded by default. Otherwise, if there are no existing saved changesets or if changeset branching is 607 * enabled, then a new UUID will be generated. 608 * 609 * @since 4.9.0 610 * @global string $pagenow 611 */ 612 public function establish_loaded_changeset() { 613 global $pagenow; 614 615 if ( empty( $this->_changeset_uuid ) ) { 616 $changeset_uuid = null; 617 618 if ( ! $this->branching() && $this->is_theme_active() ) { 619 $unpublished_changeset_posts = $this->get_changeset_posts( 620 array( 621 'post_status' => array_diff( get_post_stati(), array( 'auto-draft', 'publish', 'trash', 'inherit', 'private' ) ), 622 'exclude_restore_dismissed' => false, 623 'author' => 'any', 624 'posts_per_page' => 1, 625 'order' => 'DESC', 626 'orderby' => 'date', 627 ) 628 ); 629 $unpublished_changeset_post = array_shift( $unpublished_changeset_posts ); 630 if ( ! empty( $unpublished_changeset_post ) && wp_is_uuid( $unpublished_changeset_post->post_name ) ) { 631 $changeset_uuid = $unpublished_changeset_post->post_name; 632 } 633 } 634 635 // If no changeset UUID has been set yet, then generate a new one. 636 if ( empty( $changeset_uuid ) ) { 637 $changeset_uuid = wp_generate_uuid4(); 638 } 639 640 $this->_changeset_uuid = $changeset_uuid; 641 } 642 643 if ( is_admin() && 'customize.php' === $pagenow ) { 644 $this->set_changeset_lock( $this->changeset_post_id() ); 645 } 646 } 647 648 /** 649 * Callback to validate a theme once it is loaded 650 * 651 * @since 3.4.0 652 */ 653 public function after_setup_theme() { 654 $doing_ajax_or_is_customized = ( $this->doing_ajax() || isset( $_POST['customized'] ) ); 655 if ( ! $doing_ajax_or_is_customized && ! validate_current_theme() ) { 656 wp_redirect( 'themes.php?broken=true' ); 657 exit; 658 } 659 } 660 661 /** 662 * If the theme to be previewed isn't the active theme, add filter callbacks 663 * to swap it out at runtime. 664 * 665 * @since 3.4.0 666 */ 667 public function start_previewing_theme() { 668 // Bail if we're already previewing. 669 if ( $this->is_preview() ) { 670 return; 671 } 672 673 $this->previewing = true; 674 675 if ( ! $this->is_theme_active() ) { 676 add_filter( 'template', array( $this, 'get_template' ) ); 677 add_filter( 'stylesheet', array( $this, 'get_stylesheet' ) ); 678 add_filter( 'pre_option_current_theme', array( $this, 'current_theme' ) ); 679 680 // @link: https://core.trac.wordpress.org/ticket/20027 681 add_filter( 'pre_option_stylesheet', array( $this, 'get_stylesheet' ) ); 682 add_filter( 'pre_option_template', array( $this, 'get_template' ) ); 683 684 // Handle custom theme roots. 685 add_filter( 'pre_option_stylesheet_root', array( $this, 'get_stylesheet_root' ) ); 686 add_filter( 'pre_option_template_root', array( $this, 'get_template_root' ) ); 687 } 688 689 /** 690 * Fires once the Customizer theme preview has started. 691 * 692 * @since 3.4.0 693 * 694 * @param WP_Customize_Manager $this WP_Customize_Manager instance. 695 */ 696 do_action( 'start_previewing_theme', $this ); 697 } 698 699 /** 700 * Stop previewing the selected theme. 701 * 702 * Removes filters to change the current theme. 703 * 704 * @since 3.4.0 705 */ 706 public function stop_previewing_theme() { 707 if ( ! $this->is_preview() ) { 708 return; 709 } 710 711 $this->previewing = false; 712 713 if ( ! $this->is_theme_active() ) { 714 remove_filter( 'template', array( $this, 'get_template' ) ); 715 remove_filter( 'stylesheet', array( $this, 'get_stylesheet' ) ); 716 remove_filter( 'pre_option_current_theme', array( $this, 'current_theme' ) ); 717 718 // @link: https://core.trac.wordpress.org/ticket/20027 719 remove_filter( 'pre_option_stylesheet', array( $this, 'get_stylesheet' ) ); 720 remove_filter( 'pre_option_template', array( $this, 'get_template' ) ); 721 722 // Handle custom theme roots. 723 remove_filter( 'pre_option_stylesheet_root', array( $this, 'get_stylesheet_root' ) ); 724 remove_filter( 'pre_option_template_root', array( $this, 'get_template_root' ) ); 725 } 726 727 /** 728 * Fires once the Customizer theme preview has stopped. 729 * 730 * @since 3.4.0 731 * 732 * @param WP_Customize_Manager $this WP_Customize_Manager instance. 733 */ 734 do_action( 'stop_previewing_theme', $this ); 735 } 736 737 /** 738 * Gets whether settings are or will be previewed. 739 * 740 * @since 4.9.0 741 * @see WP_Customize_Setting::preview() 742 * 743 * @return bool 744 */ 745 public function settings_previewed() { 746 return $this->settings_previewed; 747 } 748 749 /** 750 * Gets whether data from a changeset's autosaved revision should be loaded if it exists. 751 * 752 * @since 4.9.0 753 * @see WP_Customize_Manager::changeset_data() 754 * 755 * @return bool Is using autosaved changeset revision. 756 */ 757 public function autosaved() { 758 return $this->autosaved; 759 } 760 761 /** 762 * Whether the changeset branching is allowed. 763 * 764 * @since 4.9.0 765 * @see WP_Customize_Manager::establish_loaded_changeset() 766 * 767 * @return bool Is changeset branching. 768 */ 769 public function branching() { 770 771 /** 772 * Filters whether or not changeset branching is allowed. 773 * 774 * By default in core, when changeset branching is not allowed, changesets will operate 775 * linearly in that only one saved changeset will exist at a time (with a 'draft' or 776 * 'future' status). This makes the Customizer operate in a way that is similar to going to 777 * "edit" to one existing post: all users will be making changes to the same post, and autosave 778 * revisions will be made for that post. 779 * 780 * By contrast, when changeset branching is allowed, then the model is like users going 781 * to "add new" for a page and each user makes changes independently of each other since 782 * they are all operating on their own separate pages, each getting their own separate 783 * initial auto-drafts and then once initially saved, autosave revisions on top of that 784 * user's specific post. 785 * 786 * Since linear changesets are deemed to be more suitable for the majority of WordPress users, 787 * they are the default. For WordPress sites that have heavy site management in the Customizer 788 * by multiple users then branching changesets should be enabled by means of this filter. 789 * 790 * @since 4.9.0 791 * 792 * @param bool $allow_branching Whether branching is allowed. If `false`, the default, 793 * then only one saved changeset exists at a time. 794 * @param WP_Customize_Manager $wp_customize Manager instance. 795 */ 796 $this->branching = apply_filters( 'customize_changeset_branching', $this->branching, $this ); 797 798 return $this->branching; 799 } 800 801 /** 802 * Get the changeset UUID. 803 * 804 * @since 4.7.0 805 * @see WP_Customize_Manager::establish_loaded_changeset() 806 * 807 * @return string UUID. 808 */ 809 public function changeset_uuid() { 810 if ( empty( $this->_changeset_uuid ) ) { 811 $this->establish_loaded_changeset(); 812 } 813 return $this->_changeset_uuid; 814 } 815 816 /** 817 * Get the theme being customized. 818 * 819 * @since 3.4.0 820 * 821 * @return WP_Theme 822 */ 823 public function theme() { 824 if ( ! $this->theme ) { 825 $this->theme = wp_get_theme(); 826 } 827 return $this->theme; 828 } 829 830 /** 831 * Get the registered settings. 832 * 833 * @since 3.4.0 834 * 835 * @return array 836 */ 837 public function settings() { 838 return $this->settings; 839 } 840 841 /** 842 * Get the registered controls. 843 * 844 * @since 3.4.0 845 * 846 * @return array 847 */ 848 public function controls() { 849 return $this->controls; 850 } 851 852 /** 853 * Get the registered containers. 854 * 855 * @since 4.0.0 856 * 857 * @return array 858 */ 859 public function containers() { 860 return $this->containers; 861 } 862 863 /** 864 * Get the registered sections. 865 * 866 * @since 3.4.0 867 * 868 * @return array 869 */ 870 public function sections() { 871 return $this->sections; 872 } 873 874 /** 875 * Get the registered panels. 876 * 877 * @since 4.0.0 878 * 879 * @return array Panels. 880 */ 881 public function panels() { 882 return $this->panels; 883 } 884 885 /** 886 * Checks if the current theme is active. 887 * 888 * @since 3.4.0 889 * 890 * @return bool 891 */ 892 public function is_theme_active() { 893 return $this->get_stylesheet() == $this->original_stylesheet; 894 } 895 896 /** 897 * Register styles/scripts and initialize the preview of each setting 898 * 899 * @since 3.4.0 900 */ 901 public function wp_loaded() { 902 903 // Unconditionally register core types for panels, sections, and controls in case plugin unhooks all customize_register actions. 904 $this->register_panel_type( 'WP_Customize_Panel' ); 905 $this->register_panel_type( 'WP_Customize_Themes_Panel' ); 906 $this->register_section_type( 'WP_Customize_Section' ); 907 $this->register_section_type( 'WP_Customize_Sidebar_Section' ); 908 $this->register_section_type( 'WP_Customize_Themes_Section' ); 909 $this->register_control_type( 'WP_Customize_Color_Control' ); 910 $this->register_control_type( 'WP_Customize_Media_Control' ); 911 $this->register_control_type( 'WP_Customize_Upload_Control' ); 912 $this->register_control_type( 'WP_Customize_Image_Control' ); 913 $this->register_control_type( 'WP_Customize_Background_Image_Control' ); 914 $this->register_control_type( 'WP_Customize_Background_Position_Control' ); 915 $this->register_control_type( 'WP_Customize_Cropped_Image_Control' ); 916 $this->register_control_type( 'WP_Customize_Site_Icon_Control' ); 917 $this->register_control_type( 'WP_Customize_Theme_Control' ); 918 $this->register_control_type( 'WP_Customize_Code_Editor_Control' ); 919 $this->register_control_type( 'WP_Customize_Date_Time_Control' ); 920 921 /** 922 * Fires once WordPress has loaded, allowing scripts and styles to be initialized. 923 * 924 * @since 3.4.0 925 * 926 * @param WP_Customize_Manager $this WP_Customize_Manager instance. 927 */ 928 do_action( 'customize_register', $this ); 929 930 if ( $this->settings_previewed() ) { 931 foreach ( $this->settings as $setting ) { 932 $setting->preview(); 933 } 934 } 935 936 if ( $this->is_preview() && ! is_admin() ) { 937 $this->customize_preview_init(); 938 } 939 } 940 941 /** 942 * Prevents Ajax requests from following redirects when previewing a theme 943 * by issuing a 200 response instead of a 30x. 944 * 945 * Instead, the JS will sniff out the location header. 946 * 947 * @since 3.4.0 948 * @deprecated 4.7.0 949 * 950 * @param int $status Status. 951 * @return int 952 */ 953 public function wp_redirect_status( $status ) { 954 _deprecated_function( __FUNCTION__, '4.7.0' ); 955 956 if ( $this->is_preview() && ! is_admin() ) { 957 return 200; 958 } 959 960 return $status; 961 } 962 963 /** 964 * Find the changeset post ID for a given changeset UUID. 965 * 966 * @since 4.7.0 967 * 968 * @param string $uuid Changeset UUID. 969 * @return int|null Returns post ID on success and null on failure. 970 */ 971 public function find_changeset_post_id( $uuid ) { 972 $cache_group = 'customize_changeset_post'; 973 $changeset_post_id = wp_cache_get( $uuid, $cache_group ); 974 if ( $changeset_post_id && 'customize_changeset' === get_post_type( $changeset_post_id ) ) { 975 return $changeset_post_id; 976 } 977 978 $changeset_post_query = new WP_Query( 979 array( 980 'post_type' => 'customize_changeset', 981 'post_status' => get_post_stati(), 982 'name' => $uuid, 983 'posts_per_page' => 1, 984 'no_found_rows' => true, 985 'cache_results' => true, 986 'update_post_meta_cache' => false, 987 'update_post_term_cache' => false, 988 'lazy_load_term_meta' => false, 989 ) 990 ); 991 if ( ! empty( $changeset_post_query->posts ) ) { 992 // Note: 'fields'=>'ids' is not being used in order to cache the post object as it will be needed. 993 $changeset_post_id = $changeset_post_query->posts[0]->ID; 994 wp_cache_set( $uuid, $changeset_post_id, $cache_group ); 995 return $changeset_post_id; 996 } 997 998 return null; 999 } 1000 1001 /** 1002 * Get changeset posts. 1003 * 1004 * @since 4.9.0 1005 * 1006 * @param array $args { 1007 * Args to pass into `get_posts()` to query changesets. 1008 * 1009 * @type int $posts_per_page Number of posts to return. Defaults to -1 (all posts). 1010 * @type int $author Post author. Defaults to current user. 1011 * @type string $post_status Status of changeset. Defaults to 'auto-draft'. 1012 * @type bool $exclude_restore_dismissed Whether to exclude changeset auto-drafts that have been dismissed. Defaults to true. 1013 * } 1014 * @return WP_Post[] Auto-draft changesets. 1015 */ 1016 protected function get_changeset_posts( $args = array() ) { 1017 $default_args = array( 1018 'exclude_restore_dismissed' => true, 1019 'posts_per_page' => -1, 1020 'post_type' => 'customize_changeset', 1021 'post_status' => 'auto-draft', 1022 'order' => 'DESC', 1023 'orderby' => 'date', 1024 'no_found_rows' => true, 1025 'cache_results' => true, 1026 'update_post_meta_cache' => false, 1027 'update_post_term_cache' => false, 1028 'lazy_load_term_meta' => false, 1029 ); 1030 if ( get_current_user_id() ) { 1031 $default_args['author'] = get_current_user_id(); 1032 } 1033 $args = array_merge( $default_args, $args ); 1034 1035 if ( ! empty( $args['exclude_restore_dismissed'] ) ) { 1036 unset( $args['exclude_restore_dismissed'] ); 1037 $args['meta_query'] = array( 1038 array( 1039 'key' => '_customize_restore_dismissed', 1040 'compare' => 'NOT EXISTS', 1041 ), 1042 ); 1043 } 1044 1045 return get_posts( $args ); 1046 } 1047 1048 /** 1049 * Dismiss all of the current user's auto-drafts (other than the present one). 1050 * 1051 * @since 4.9.0 1052 * @return int The number of auto-drafts that were dismissed. 1053 */ 1054 protected function dismiss_user_auto_draft_changesets() { 1055 $changeset_autodraft_posts = $this->get_changeset_posts( 1056 array( 1057 'post_status' => 'auto-draft', 1058 'exclude_restore_dismissed' => true, 1059 'posts_per_page' => -1, 1060 ) 1061 ); 1062 $dismissed = 0; 1063 foreach ( $changeset_autodraft_posts as $autosave_autodraft_post ) { 1064 if ( $autosave_autodraft_post->ID === $this->changeset_post_id() ) { 1065 continue; 1066 } 1067 if ( update_post_meta( $autosave_autodraft_post->ID, '_customize_restore_dismissed', true ) ) { 1068 $dismissed++; 1069 } 1070 } 1071 return $dismissed; 1072 } 1073 1074 /** 1075 * Get the changeset post id for the loaded changeset. 1076 * 1077 * @since 4.7.0 1078 * 1079 * @return int|null Post ID on success or null if there is no post yet saved. 1080 */ 1081 public function changeset_post_id() { 1082 if ( ! isset( $this->_changeset_post_id ) ) { 1083 $post_id = $this->find_changeset_post_id( $this->changeset_uuid() ); 1084 if ( ! $post_id ) { 1085 $post_id = false; 1086 } 1087 $this->_changeset_post_id = $post_id; 1088 } 1089 if ( false === $this->_changeset_post_id ) { 1090 return null; 1091 } 1092 return $this->_changeset_post_id; 1093 } 1094 1095 /** 1096 * Get the data stored in a changeset post. 1097 * 1098 * @since 4.7.0 1099 * 1100 * @param int $post_id Changeset post ID. 1101 * @return array|WP_Error Changeset data or WP_Error on error. 1102 */ 1103 protected function get_changeset_post_data( $post_id ) { 1104 if ( ! $post_id ) { 1105 return new WP_Error( 'empty_post_id' ); 1106 } 1107 $changeset_post = get_post( $post_id ); 1108 if ( ! $changeset_post ) { 1109 return new WP_Error( 'missing_post' ); 1110 } 1111 if ( 'revision' === $changeset_post->post_type ) { 1112 if ( 'customize_changeset' !== get_post_type( $changeset_post->post_parent ) ) { 1113 return new WP_Error( 'wrong_post_type' ); 1114 } 1115 } elseif ( 'customize_changeset' !== $changeset_post->post_type ) { 1116 return new WP_Error( 'wrong_post_type' ); 1117 } 1118 $changeset_data = json_decode( $changeset_post->post_content, true ); 1119 $last_error = json_last_error(); 1120 if ( $last_error ) { 1121 return new WP_Error( 'json_parse_error', '', $last_error ); 1122 } 1123 if ( ! is_array( $changeset_data ) ) { 1124 return new WP_Error( 'expected_array' ); 1125 } 1126 return $changeset_data; 1127 } 1128 1129 /** 1130 * Get changeset data. 1131 * 1132 * @since 4.7.0 1133 * @since 4.9.0 This will return the changeset's data with a user's autosave revision merged on top, if one exists and $autosaved is true. 1134 * 1135 * @return array Changeset data. 1136 */ 1137 public function changeset_data() { 1138 if ( isset( $this->_changeset_data ) ) { 1139 return $this->_changeset_data; 1140 } 1141 $changeset_post_id = $this->changeset_post_id(); 1142 if ( ! $changeset_post_id ) { 1143 $this->_changeset_data = array(); 1144 } else { 1145 if ( $this->autosaved() && is_user_logged_in() ) { 1146 $autosave_post = wp_get_post_autosave( $changeset_post_id, get_current_user_id() ); 1147 if ( $autosave_post ) { 1148 $data = $this->get_changeset_post_data( $autosave_post->ID ); 1149 if ( ! is_wp_error( $data ) ) { 1150 $this->_changeset_data = $data; 1151 } 1152 } 1153 } 1154 1155 // Load data from the changeset if it was not loaded from an autosave. 1156 if ( ! isset( $this->_changeset_data ) ) { 1157 $data = $this->get_changeset_post_data( $changeset_post_id ); 1158 if ( ! is_wp_error( $data ) ) { 1159 $this->_changeset_data = $data; 1160 } else { 1161 $this->_changeset_data = array(); 1162 } 1163 } 1164 } 1165 return $this->_changeset_data; 1166 } 1167 1168 /** 1169 * Starter content setting IDs. 1170 * 1171 * @since 4.7.0 1172 * @var array 1173 */ 1174 protected $pending_starter_content_settings_ids = array(); 1175 1176 /** 1177 * Import theme starter content into the customized state. 1178 * 1179 * @since 4.7.0 1180 * 1181 * @param array $starter_content Starter content. Defaults to `get_theme_starter_content()`. 1182 */ 1183 function import_theme_starter_content( $starter_content = array() ) { 1184 if ( empty( $starter_content ) ) { 1185 $starter_content = get_theme_starter_content(); 1186 } 1187 1188 $changeset_data = array(); 1189 if ( $this->changeset_post_id() ) { 1190 /* 1191 * Don't re-import starter content into a changeset saved persistently. 1192 * This will need to be revisited in the future once theme switching 1193 * is allowed with drafted/scheduled changesets, since switching to 1194 * another theme could result in more starter content being applied. 1195 * However, when doing an explicit save it is currently possible for 1196 * nav menus and nav menu items specifically to lose their starter_content 1197 * flags, thus resulting in duplicates being created since they fail 1198 * to get re-used. See #40146. 1199 */ 1200 if ( 'auto-draft' !== get_post_status( $this->changeset_post_id() ) ) { 1201 return; 1202 } 1203 1204 $changeset_data = $this->get_changeset_post_data( $this->changeset_post_id() ); 1205 } 1206 1207 $sidebars_widgets = isset( $starter_content['widgets'] ) && ! empty( $this->widgets ) ? $starter_content['widgets'] : array(); 1208 $attachments = isset( $starter_content['attachments'] ) && ! empty( $this->nav_menus ) ? $starter_content['attachments'] : array(); 1209 $posts = isset( $starter_content['posts'] ) && ! empty( $this->nav_menus ) ? $starter_content['posts'] : array(); 1210 $options = isset( $starter_content['options'] ) ? $starter_content['options'] : array(); 1211 $nav_menus = isset( $starter_content['nav_menus'] ) && ! empty( $this->nav_menus ) ? $starter_content['nav_menus'] : array(); 1212 $theme_mods = isset( $starter_content['theme_mods'] ) ? $starter_content['theme_mods'] : array(); 1213 1214 // Widgets. 1215 $max_widget_numbers = array(); 1216 foreach ( $sidebars_widgets as $sidebar_id => $widgets ) { 1217 $sidebar_widget_ids = array(); 1218 foreach ( $widgets as $widget ) { 1219 list( $id_base, $instance ) = $widget; 1220 1221 if ( ! isset( $max_widget_numbers[ $id_base ] ) ) { 1222 1223 // When $settings is an array-like object, get an intrinsic array for use with array_keys(). 1224 $settings = get_option( "widget_{$id_base}", array() ); 1225 if ( $settings instanceof ArrayObject || $settings instanceof ArrayIterator ) { 1226 $settings = $settings->getArrayCopy(); 1227 } 1228 1229 // Find the max widget number for this type. 1230 $widget_numbers = array_keys( $settings ); 1231 if ( count( $widget_numbers ) > 0 ) { 1232 $widget_numbers[] = 1; 1233 $max_widget_numbers[ $id_base ] = max( ...$widget_numbers ); 1234 } else { 1235 $max_widget_numbers[ $id_base ] = 1; 1236 } 1237 } 1238 $max_widget_numbers[ $id_base ] += 1; 1239 1240 $widget_id = sprintf( '%s-%d', $id_base, $max_widget_numbers[ $id_base ] ); 1241 $setting_id = sprintf( 'widget_%s[%d]', $id_base, $max_widget_numbers[ $id_base ] ); 1242 1243 $setting_value = $this->widgets->sanitize_widget_js_instance( $instance ); 1244 if ( empty( $changeset_data[ $setting_id ] ) || ! empty( $changeset_data[ $setting_id ]['starter_content'] ) ) { 1245 $this->set_post_value( $setting_id, $setting_value ); 1246 $this->pending_starter_content_settings_ids[] = $setting_id; 1247 } 1248 $sidebar_widget_ids[] = $widget_id; 1249 } 1250 1251 $setting_id = sprintf( 'sidebars_widgets[%s]', $sidebar_id ); 1252 if ( empty( $changeset_data[ $setting_id ] ) || ! empty( $changeset_data[ $setting_id ]['starter_content'] ) ) { 1253 $this->set_post_value( $setting_id, $sidebar_widget_ids ); 1254 $this->pending_starter_content_settings_ids[] = $setting_id; 1255 } 1256 } 1257 1258 $starter_content_auto_draft_post_ids = array(); 1259 if ( ! empty( $changeset_data['nav_menus_created_posts']['value'] ) ) { 1260 $starter_content_auto_draft_post_ids = array_merge( $starter_content_auto_draft_post_ids, $changeset_data['nav_menus_created_posts']['value'] ); 1261 } 1262 1263 // Make an index of all the posts needed and what their slugs are. 1264 $needed_posts = array(); 1265 $attachments = $this->prepare_starter_content_attachments( $attachments ); 1266 foreach ( $attachments as $attachment ) { 1267 $key = 'attachment:' . $attachment['post_name']; 1268 $needed_posts[ $key ] = true; 1269 } 1270 foreach ( array_keys( $posts ) as $post_symbol ) { 1271 if ( empty( $posts[ $post_symbol ]['post_name'] ) && empty( $posts[ $post_symbol ]['post_title'] ) ) { 1272 unset( $posts[ $post_symbol ] ); 1273 continue; 1274 } 1275 if ( empty( $posts[ $post_symbol ]['post_name'] ) ) { 1276 $posts[ $post_symbol ]['post_name'] = sanitize_title( $posts[ $post_symbol ]['post_title'] ); 1277 } 1278 if ( empty( $posts[ $post_symbol ]['post_type'] ) ) { 1279 $posts[ $post_symbol ]['post_type'] = 'post'; 1280 } 1281 $needed_posts[ $posts[ $post_symbol ]['post_type'] . ':' . $posts[ $post_symbol ]['post_name'] ] = true; 1282 } 1283 $all_post_slugs = array_merge( 1284 wp_list_pluck( $attachments, 'post_name' ), 1285 wp_list_pluck( $posts, 'post_name' ) 1286 ); 1287 1288 /* 1289 * Obtain all post types referenced in starter content to use in query. 1290 * This is needed because 'any' will not account for post types not yet registered. 1291 */ 1292 $post_types = array_filter( array_merge( array( 'attachment' ), wp_list_pluck( $posts, 'post_type' ) ) ); 1293 1294 // Re-use auto-draft starter content posts referenced in the current customized state. 1295 $existing_starter_content_posts = array(); 1296 if ( ! empty( $starter_content_auto_draft_post_ids ) ) { 1297 $existing_posts_query = new WP_Query( 1298 array( 1299 'post__in' => $starter_content_auto_draft_post_ids, 1300 'post_status' => 'auto-draft', 1301 'post_type' => $post_types, 1302 'posts_per_page' => -1, 1303 ) 1304 ); 1305 foreach ( $existing_posts_query->posts as $existing_post ) { 1306 $post_name = $existing_post->post_name; 1307 if ( empty( $post_name ) ) { 1308 $post_name = get_post_meta( $existing_post->ID, '_customize_draft_post_name', true ); 1309 } 1310 $existing_starter_content_posts[ $existing_post->post_type . ':' . $post_name ] = $existing_post; 1311 } 1312 } 1313 1314 // Re-use non-auto-draft posts. 1315 if ( ! empty( $all_post_slugs ) ) { 1316 $existing_posts_query = new WP_Query( 1317 array( 1318 'post_name__in' => $all_post_slugs, 1319 'post_status' => array_diff( get_post_stati(), array( 'auto-draft' ) ), 1320 'post_type' => 'any', 1321 'posts_per_page' => -1, 1322 ) 1323 ); 1324 foreach ( $existing_posts_query->posts as $existing_post ) { 1325 $key = $existing_post->post_type . ':' . $existing_post->post_name; 1326 if ( isset( $needed_posts[ $key ] ) && ! isset( $existing_starter_content_posts[ $key ] ) ) { 1327 $existing_starter_content_posts[ $key ] = $existing_post; 1328 } 1329 } 1330 } 1331 1332 // Attachments are technically posts but handled differently. 1333 if ( ! empty( $attachments ) ) { 1334 1335 $attachment_ids = array(); 1336 1337 foreach ( $attachments as $symbol => $attachment ) { 1338 $file_array = array( 1339 'name' => $attachment['file_name'], 1340 ); 1341 $file_path = $attachment['file_path']; 1342 $attachment_id = null; 1343 $attached_file = null; 1344 if ( isset( $existing_starter_content_posts[ 'attachment:' . $attachment['post_name'] ] ) ) { 1345 $attachment_post = $existing_starter_content_posts[ 'attachment:' . $attachment['post_name'] ]; 1346 $attachment_id = $attachment_post->ID; 1347 $attached_file = get_attached_file( $attachment_id ); 1348 if ( empty( $attached_file ) || ! file_exists( $attached_file ) ) { 1349 $attachment_id = null; 1350 $attached_file = null; 1351 } elseif ( $this->get_stylesheet() !== get_post_meta( $attachment_post->ID, '_starter_content_theme', true ) ) { 1352 1353 // Re-generate attachment metadata since it was previously generated for a different theme. 1354 $metadata = wp_generate_attachment_metadata( $attachment_post->ID, $attached_file ); 1355 wp_update_attachment_metadata( $attachment_id, $metadata ); 1356 update_post_meta( $attachment_id, '_starter_content_theme', $this->get_stylesheet() ); 1357 } 1358 } 1359 1360 // Insert the attachment auto-draft because it doesn't yet exist or the attached file is gone. 1361 if ( ! $attachment_id ) { 1362 1363 // Copy file to temp location so that original file won't get deleted from theme after sideloading. 1364 $temp_file_name = wp_tempnam( wp_basename( $file_path ) ); 1365 if ( $temp_file_name && copy( $file_path, $temp_file_name ) ) { 1366 $file_array['tmp_name'] = $temp_file_name; 1367 } 1368 if ( empty( $file_array['tmp_name'] ) ) { 1369 continue; 1370 } 1371 1372 $attachment_post_data = array_merge( 1373 wp_array_slice_assoc( $attachment, array( 'post_title', 'post_content', 'post_excerpt' ) ), 1374 array( 1375 'post_status' => 'auto-draft', // So attachment will be garbage collected in a week if changeset is never published. 1376 ) 1377 ); 1378 1379 $attachment_id = media_handle_sideload( $file_array, 0, null, $attachment_post_data ); 1380 if ( is_wp_error( $attachment_id ) ) { 1381 continue; 1382 } 1383 update_post_meta( $attachment_id, '_starter_content_theme', $this->get_stylesheet() ); 1384 update_post_meta( $attachment_id, '_customize_draft_post_name', $attachment['post_name'] ); 1385 } 1386 1387 $attachment_ids[ $symbol ] = $attachment_id; 1388 } 1389 $starter_content_auto_draft_post_ids = array_merge( $starter_content_auto_draft_post_ids, array_values( $attachment_ids ) ); 1390 } 1391 1392 // Posts & pages. 1393 if ( ! empty( $posts ) ) { 1394 foreach ( array_keys( $posts ) as $post_symbol ) { 1395 if ( empty( $posts[ $post_symbol ]['post_type'] ) || empty( $posts[ $post_symbol ]['post_name'] ) ) { 1396 continue; 1397 } 1398 $post_type = $posts[ $post_symbol ]['post_type']; 1399 if ( ! empty( $posts[ $post_symbol ]['post_name'] ) ) { 1400 $post_name = $posts[ $post_symbol ]['post_name']; 1401 } elseif ( ! empty( $posts[ $post_symbol ]['post_title'] ) ) { 1402 $post_name = sanitize_title( $posts[ $post_symbol ]['post_title'] ); 1403 } else { 1404 continue; 1405 } 1406 1407 // Use existing auto-draft post if one already exists with the same type and name. 1408 if ( isset( $existing_starter_content_posts[ $post_type . ':' . $post_name ] ) ) { 1409 $posts[ $post_symbol ]['ID'] = $existing_starter_content_posts[ $post_type . ':' . $post_name ]->ID; 1410 continue; 1411 } 1412 1413 // Translate the featured image symbol. 1414 if ( ! empty( $posts[ $post_symbol ]['thumbnail'] ) 1415 && preg_match( '/^{{(?P<symbol>.+)}}$/', $posts[ $post_symbol ]['thumbnail'], $matches ) 1416 && isset( $attachment_ids[ $matches['symbol'] ] ) ) { 1417 $posts[ $post_symbol ]['meta_input']['_thumbnail_id'] = $attachment_ids[ $matches['symbol'] ]; 1418 } 1419 1420 if ( ! empty( $posts[ $post_symbol ]['template'] ) ) { 1421 $posts[ $post_symbol ]['meta_input']['_wp_page_template'] = $posts[ $post_symbol ]['template']; 1422 } 1423 1424 $r = $this->nav_menus->insert_auto_draft_post( $posts[ $post_symbol ] ); 1425 if ( $r instanceof WP_Post ) { 1426 $posts[ $post_symbol ]['ID'] = $r->ID; 1427 } 1428 } 1429 1430 $starter_content_auto_draft_post_ids = array_merge( $starter_content_auto_draft_post_ids, wp_list_pluck( $posts, 'ID' ) ); 1431 } 1432 1433 // The nav_menus_created_posts setting is why nav_menus component is dependency for adding posts. 1434 if ( ! empty( $this->nav_menus ) && ! empty( $starter_content_auto_draft_post_ids ) ) { 1435 $setting_id = 'nav_menus_created_posts'; 1436 $this->set_post_value( $setting_id, array_unique( array_values( $starter_content_auto_draft_post_ids ) ) ); 1437 $this->pending_starter_content_settings_ids[] = $setting_id; 1438 } 1439 1440 // Nav menus. 1441 $placeholder_id = -1; 1442 $reused_nav_menu_setting_ids = array(); 1443 foreach ( $nav_menus as $nav_menu_location => $nav_menu ) { 1444 1445 $nav_menu_term_id = null; 1446 $nav_menu_setting_id = null; 1447 $matches = array(); 1448 1449 // Look for an existing placeholder menu with starter content to re-use. 1450 foreach ( $changeset_data as $setting_id => $setting_params ) { 1451 $can_reuse = ( 1452 ! empty( $setting_params['starter_content'] ) 1453 && 1454 ! in_array( $setting_id, $reused_nav_menu_setting_ids, true ) 1455 && 1456 preg_match( '#^nav_menu\[(?P<nav_menu_id>-?\d+)\]$#', $setting_id, $matches ) 1457 ); 1458 if ( $can_reuse ) { 1459 $nav_menu_term_id = intval( $matches['nav_menu_id'] ); 1460 $nav_menu_setting_id = $setting_id; 1461 $reused_nav_menu_setting_ids[] = $setting_id; 1462 break; 1463 } 1464 } 1465 1466 if ( ! $nav_menu_term_id ) { 1467 while ( isset( $changeset_data[ sprintf( 'nav_menu[%d]', $placeholder_id ) ] ) ) { 1468 $placeholder_id--; 1469 } 1470 $nav_menu_term_id = $placeholder_id; 1471 $nav_menu_setting_id = sprintf( 'nav_menu[%d]', $placeholder_id ); 1472 } 1473 1474 $this->set_post_value( 1475 $nav_menu_setting_id, 1476 array( 1477 'name' => isset( $nav_menu['name'] ) ? $nav_menu['name'] : $nav_menu_location, 1478 ) 1479 ); 1480 $this->pending_starter_content_settings_ids[] = $nav_menu_setting_id; 1481 1482 // @todo Add support for menu_item_parent. 1483 $position = 0; 1484 foreach ( $nav_menu['items'] as $nav_menu_item ) { 1485 $nav_menu_item_setting_id = sprintf( 'nav_menu_item[%d]', $placeholder_id-- ); 1486 if ( ! isset( $nav_menu_item['position'] ) ) { 1487 $nav_menu_item['position'] = $position++; 1488 } 1489 $nav_menu_item['nav_menu_term_id'] = $nav_menu_term_id; 1490 1491 if ( isset( $nav_menu_item['object_id'] ) ) { 1492 if ( 'post_type' === $nav_menu_item['type'] && preg_match( '/^{{(?P<symbol>.+)}}$/', $nav_menu_item['object_id'], $matches ) && isset( $posts[ $matches['symbol'] ] ) ) { 1493 $nav_menu_item['object_id'] = $posts[ $matches['symbol'] ]['ID']; 1494 if ( empty( $nav_menu_item['title'] ) ) { 1495 $original_object = get_post( $nav_menu_item['object_id'] ); 1496 $nav_menu_item['title'] = $original_object->post_title; 1497 } 1498 } else { 1499 continue; 1500 } 1501 } else { 1502 $nav_menu_item['object_id'] = 0; 1503 } 1504 1505 if ( empty( $changeset_data[ $nav_menu_item_setting_id ] ) || ! empty( $changeset_data[ $nav_menu_item_setting_id ]['starter_content'] ) ) { 1506 $this->set_post_value( $nav_menu_item_setting_id, $nav_menu_item ); 1507 $this->pending_starter_content_settings_ids[] = $nav_menu_item_setting_id; 1508 } 1509 } 1510 1511 $setting_id = sprintf( 'nav_menu_locations[%s]', $nav_menu_location ); 1512 if ( empty( $changeset_data[ $setting_id ] ) || ! empty( $changeset_data[ $setting_id ]['starter_content'] ) ) { 1513 $this->set_post_value( $setting_id, $nav_menu_term_id ); 1514 $this->pending_starter_content_settings_ids[] = $setting_id; 1515 } 1516 } 1517 1518 // Options. 1519 foreach ( $options as $name => $value ) { 1520 if ( preg_match( '/^{{(?P<symbol>.+)}}$/', $value, $matches ) ) { 1521 if ( isset( $posts[ $matches['symbol'] ] ) ) { 1522 $value = $posts[ $matches['symbol'] ]['ID']; 1523 } elseif ( isset( $attachment_ids[ $matches['symbol'] ] ) ) { 1524 $value = $attachment_ids[ $matches['symbol'] ]; 1525 } else { 1526 continue; 1527 } 1528 } 1529 1530 if ( empty( $changeset_data[ $name ] ) || ! empty( $changeset_data[ $name ]['starter_content'] ) ) { 1531 $this->set_post_value( $name, $value ); 1532 $this->pending_starter_content_settings_ids[] = $name; 1533 } 1534 } 1535 1536 // Theme mods. 1537 foreach ( $theme_mods as $name => $value ) { 1538 if ( preg_match( '/^{{(?P<symbol>.+)}}$/', $value, $matches ) ) { 1539 if ( isset( $posts[ $matches['symbol'] ] ) ) { 1540 $value = $posts[ $matches['symbol'] ]['ID']; 1541 } elseif ( isset( $attachment_ids[ $matches['symbol'] ] ) ) { 1542 $value = $attachment_ids[ $matches['symbol'] ]; 1543 } else { 1544 continue; 1545 } 1546 } 1547 1548 // Handle header image as special case since setting has a legacy format. 1549 if ( 'header_image' === $name ) { 1550 $name = 'header_image_data'; 1551 $metadata = wp_get_attachment_metadata( $value ); 1552 if ( empty( $metadata ) ) { 1553 continue; 1554 } 1555 $value = array( 1556 'attachment_id' => $value, 1557 'url' => wp_get_attachment_url( $value ), 1558 'height' => $metadata['height'], 1559 'width' => $metadata['width'], 1560 ); 1561 } elseif ( 'background_image' === $name ) { 1562 $value = wp_get_attachment_url( $value ); 1563 } 1564 1565 if ( empty( $changeset_data[ $name ] ) || ! empty( $changeset_data[ $name ]['starter_content'] ) ) { 1566 $this->set_post_value( $name, $value ); 1567 $this->pending_starter_content_settings_ids[] = $name; 1568 } 1569 } 1570 1571 if ( ! empty( $this->pending_starter_content_settings_ids ) ) { 1572 if ( did_action( 'customize_register' ) ) { 1573 $this->_save_starter_content_changeset(); 1574 } else { 1575 add_action( 'customize_register', array( $this, '_save_starter_content_changeset' ), 1000 ); 1576 } 1577 } 1578 } 1579 1580 /** 1581 * Prepare starter content attachments. 1582 * 1583 * Ensure that the attachments are valid and that they have slugs and file name/path. 1584 * 1585 * @since 4.7.0 1586 * 1587 * @param array $attachments Attachments. 1588 * @return array Prepared attachments. 1589 */ 1590 protected function prepare_starter_content_attachments( $attachments ) { 1591 $prepared_attachments = array(); 1592 if ( empty( $attachments ) ) { 1593 return $prepared_attachments; 1594 } 1595 1596 // Such is The WordPress Way. 1597 require_once( ABSPATH . 'wp-admin/includes/file.php' ); 1598 require_once( ABSPATH . 'wp-admin/includes/media.php' ); 1599 require_once( ABSPATH . 'wp-admin/includes/image.php' ); 1600 1601 foreach ( $attachments as $symbol => $attachment ) { 1602 1603 // A file is required and URLs to files are not currently allowed. 1604 if ( empty( $attachment['file'] ) || preg_match( '#^https?://$#', $attachment['file'] ) ) { 1605 continue; 1606 } 1607 1608 $file_path = null; 1609 if ( file_exists( $attachment['file'] ) ) { 1610 $file_path = $attachment['file']; // Could be absolute path to file in plugin. 1611 } elseif ( is_child_theme() && file_exists( get_stylesheet_directory() . '/' . $attachment['file'] ) ) { 1612 $file_path = get_stylesheet_directory() . '/' . $attachment['file']; 1613 } elseif ( file_exists( get_template_directory() . '/' . $attachment['file'] ) ) { 1614 $file_path = get_template_directory() . '/' . $attachment['file']; 1615 } else { 1616 continue; 1617 } 1618 $file_name = wp_basename( $attachment['file'] ); 1619 1620 // Skip file types that are not recognized. 1621 $checked_filetype = wp_check_filetype( $file_name ); 1622 if ( empty( $checked_filetype['type'] ) ) { 1623 continue; 1624 } 1625 1626 // Ensure post_name is set since not automatically derived from post_title for new auto-draft posts. 1627 if ( empty( $attachment['post_name'] ) ) { 1628 if ( ! empty( $attachment['post_title'] ) ) { 1629 $attachment['post_name'] = sanitize_title( $attachment['post_title'] ); 1630 } else { 1631 $attachment['post_name'] = sanitize_title( preg_replace( '/\.\w+$/', '', $file_name ) ); 1632 } 1633 } 1634 1635 $attachment['file_name'] = $file_name; 1636 $attachment['file_path'] = $file_path; 1637 $prepared_attachments[ $symbol ] = $attachment; 1638 } 1639 return $prepared_attachments; 1640 } 1641 1642 /** 1643 * Save starter content changeset. 1644 * 1645 * @since 4.7.0 1646 */ 1647 public function _save_starter_content_changeset() { 1648 1649 if ( empty( $this->pending_starter_content_settings_ids ) ) { 1650 return; 1651 } 1652 1653 $this->save_changeset_post( 1654 array( 1655 'data' => array_fill_keys( $this->pending_starter_content_settings_ids, array( 'starter_content' => true ) ), 1656 'starter_content' => true, 1657 ) 1658 ); 1659 $this->saved_starter_content_changeset = true; 1660 1661 $this->pending_starter_content_settings_ids = array(); 1662 } 1663 1664 /** 1665 * Get dirty pre-sanitized setting values in the current customized state. 1666 * 1667 * The returned array consists of a merge of three sources: 1668 * 1. If the theme is not currently active, then the base array is any stashed 1669 * theme mods that were modified previously but never published. 1670 * 2. The values from the current changeset, if it exists. 1671 * 3. If the user can customize, the values parsed from the incoming 1672 * `$_POST['customized']` JSON data. 1673 * 4. Any programmatically-set post values via `WP_Customize_Manager::set_post_value()`. 1674 * 1675 * The name "unsanitized_post_values" is a carry-over from when the customized 1676 * state was exclusively sourced from `$_POST['customized']`. Nevertheless, 1677 * the value returned will come from the current changeset post and from the 1678 * incoming post data. 1679 * 1680 * @since 4.1.1 1681 * @since 4.7.0 Added `$args` parameter and merging with changeset values and stashed theme mods. 1682 * 1683 * @param array $args { 1684 * Args. 1685 * 1686 * @type bool $exclude_changeset Whether the changeset values should also be excluded. Defaults to false. 1687 * @type bool $exclude_post_data Whether the post input values should also be excluded. Defaults to false when lacking the customize capability. 1688 * } 1689 * @return array 1690 */ 1691 public function unsanitized_post_values( $args = array() ) { 1692 $args = array_merge( 1693 array( 1694 'exclude_changeset' => false, 1695 'exclude_post_data' => ! current_user_can( 'customize' ), 1696 ), 1697 $args 1698 ); 1699 1700 $values = array(); 1701 1702 // Let default values be from the stashed theme mods if doing a theme switch and if no changeset is present. 1703 if ( ! $this->is_theme_active() ) { 1704 $stashed_theme_mods = get_option( 'customize_stashed_theme_mods' ); 1705 $stylesheet = $this->get_stylesheet(); 1706 if ( isset( $stashed_theme_mods[ $stylesheet ] ) ) { 1707 $values = array_merge( $values, wp_list_pluck( $stashed_theme_mods[ $stylesheet ], 'value' ) ); 1708 } 1709 } 1710 1711 if ( ! $args['exclude_changeset'] ) { 1712 foreach ( $this->changeset_data() as $setting_id => $setting_params ) { 1713 if ( ! array_key_exists( 'value', $setting_params ) ) { 1714 continue; 1715 } 1716 if ( isset( $setting_params['type'] ) && 'theme_mod' === $setting_params['type'] ) { 1717 1718 // Ensure that theme mods values are only used if they were saved under the current theme. 1719 $namespace_pattern = '/^(?P<stylesheet>.+?)::(?P<setting_id>.+)$/'; 1720 if ( preg_match( $namespace_pattern, $setting_id, $matches ) && $this->get_stylesheet() === $matches['stylesheet'] ) { 1721 $values[ $matches['setting_id'] ] = $setting_params['value']; 1722 } 1723 } else { 1724 $values[ $setting_id ] = $setting_params['value']; 1725 } 1726 } 1727 } 1728 1729 if ( ! $args['exclude_post_data'] ) { 1730 if ( ! isset( $this->_post_values ) ) { 1731 if ( isset( $_POST['customized'] ) ) { 1732 $post_values = json_decode( wp_unslash( $_POST['customized'] ), true ); 1733 } else { 1734 $post_values = array(); 1735 } 1736 if ( is_array( $post_values ) ) { 1737 $this->_post_values = $post_values; 1738 } else { 1739 $this->_post_values = array(); 1740 } 1741 } 1742 $values = array_merge( $values, $this->_post_values ); 1743 } 1744 return $values; 1745 } 1746 1747 /** 1748 * Returns the sanitized value for a given setting from the current customized state. 1749 * 1750 * The name "post_value" is a carry-over from when the customized state was exclusively 1751 * sourced from `$_POST['customized']`. Nevertheless, the value returned will come 1752 * from the current changeset post and from the incoming post data. 1753 * 1754 * @since 3.4.0 1755 * @since 4.1.1 Introduced the `$default` parameter. 1756 * @since 4.6.0 `$default` is now returned early when the setting post value is invalid. 1757 * 1758 * @see WP_REST_Server::dispatch() 1759 * @see WP_REST_Request::sanitize_params() 1760 * @see WP_REST_Request::has_valid_params() 1761 * 1762 * @param WP_Customize_Setting $setting A WP_Customize_Setting derived object. 1763 * @param mixed $default Value returned $setting has no post value (added in 4.2.0) 1764 * or the post value is invalid (added in 4.6.0). 1765 * @return string|mixed $post_value Sanitized value or the $default provided. 1766 */ 1767 public function post_value( $setting, $default = null ) { 1768 $post_values = $this->unsanitized_post_values(); 1769 if ( ! array_key_exists( $setting->id, $post_values ) ) { 1770 return $default; 1771 } 1772 $value = $post_values[ $setting->id ]; 1773 $valid = $setting->validate( $value ); 1774 if ( is_wp_error( $valid ) ) { 1775 return $default; 1776 } 1777 $value = $setting->sanitize( $value ); 1778 if ( is_null( $value ) || is_wp_error( $value ) ) { 1779 return $default; 1780 } 1781 return $value; 1782 } 1783 1784 /** 1785 * Override a setting's value in the current customized state. 1786 * 1787 * The name "post_value" is a carry-over from when the customized state was 1788 * exclusively sourced from `$_POST['customized']`. 1789 * 1790 * @since 4.2.0 1791 * 1792 * @param string $setting_id ID for the WP_Customize_Setting instance. 1793 * @param mixed $value Post value. 1794 */ 1795 public function set_post_value( $setting_id, $value ) { 1796 $this->unsanitized_post_values(); // Populate _post_values from $_POST['customized']. 1797 $this->_post_values[ $setting_id ] = $value; 1798 1799 /** 1800 * Announce when a specific setting's unsanitized post value has been set. 1801 * 1802 * Fires when the WP_Customize_Manager::set_post_value() method is called. 1803 * 1804 * The dynamic portion of the hook name, `$setting_id`, refers to the setting ID. 1805 * 1806 * @since 4.4.0 1807 * 1808 * @param mixed $value Unsanitized setting post value. 1809 * @param WP_Customize_Manager $this WP_Customize_Manager instance. 1810 */ 1811 do_action( "customize_post_value_set_{$setting_id}", $value, $this ); 1812 1813 /** 1814 * Announce when any setting's unsanitized post value has been set. 1815 * 1816 * Fires when the WP_Customize_Manager::set_post_value() method is called. 1817 * 1818 * This is useful for `WP_Customize_Setting` instances to watch 1819 * in order to update a cached previewed value. 1820 * 1821 * @since 4.4.0 1822 * 1823 * @param string $setting_id Setting ID. 1824 * @param mixed $value Unsanitized setting post value. 1825 * @param WP_Customize_Manager $this WP_Customize_Manager instance. 1826 */ 1827 do_action( 'customize_post_value_set', $setting_id, $value, $this ); 1828 } 1829 1830 /** 1831 * Print JavaScript settings. 1832 * 1833 * @since 3.4.0 1834 */ 1835 public function customize_preview_init() { 1836 1837 /* 1838 * Now that Customizer previews are loaded into iframes via GET requests 1839 * and natural URLs with transaction UUIDs added, we need to ensure that 1840 * the responses are never cached by proxies. In practice, this will not 1841 * be needed if the user is logged-in anyway. But if anonymous access is 1842 * allowed then the auth cookies would not be sent and WordPress would 1843 * not send no-cache headers by default. 1844 */ 1845 if ( ! headers_sent() ) { 1846 nocache_headers(); 1847 header( 'X-Robots: noindex, nofollow, noarchive' ); 1848 } 1849 add_action( 'wp_head', 'wp_no_robots' ); 1850 add_filter( 'wp_headers', array( $this, 'filter_iframe_security_headers' ) ); 1851 1852 /* 1853 * If preview is being served inside the customizer preview iframe, and 1854 * if the user doesn't have customize capability, then it is assumed 1855 * that the user's session has expired and they need to re-authenticate. 1856 */ 1857 if ( $this->messenger_channel && ! current_user_can( 'customize' ) ) { 1858 $this->wp_die( -1, __( 'Unauthorized. You may remove the customize_messenger_channel param to preview as frontend.' ) ); 1859 return; 1860 } 1861 1862 $this->prepare_controls(); 1863 1864 add_filter( 'wp_redirect', array( $this, 'add_state_query_params' ) ); 1865 1866 wp_enqueue_script( 'customize-preview' ); 1867 wp_enqueue_style( 'customize-preview' ); 1868 add_action( 'wp_head', array( $this, 'customize_preview_loading_style' ) ); 1869 add_action( 'wp_head', array( $this, 'remove_frameless_preview_messenger_channel' ) ); 1870 add_action( 'wp_footer', array( $this, 'customize_preview_settings' ), 20 ); 1871 add_filter( 'get_edit_post_link', '__return_empty_string' ); 1872 1873 /** 1874 * Fires once the Customizer preview has initialized and JavaScript 1875 * settings have been printed. 1876 * 1877 * @since 3.4.0 1878 * 1879 * @param WP_Customize_Manager $this WP_Customize_Manager instance. 1880 */ 1881 do_action( 'customize_preview_init', $this ); 1882 } 1883 1884 /** 1885 * Filter the X-Frame-Options and Content-Security-Policy headers to ensure frontend can load in customizer. 1886 * 1887 * @since 4.7.0 1888 * 1889 * @param array $headers Headers. 1890 * @return array Headers. 1891 */ 1892 public function filter_iframe_security_headers( $headers ) { 1893 $headers['X-Frame-Options'] = 'SAMEORIGIN'; 1894 $headers['Content-Security-Policy'] = "frame-ancestors 'self'"; 1895 return $headers; 1896 } 1897 1898 /** 1899 * Add customize state query params to a given URL if preview is allowed. 1900 * 1901 * @since 4.7.0 1902 * @see wp_redirect() 1903 * @see WP_Customize_Manager::get_allowed_url() 1904 * 1905 * @param string $url URL. 1906 * @return string URL. 1907 */ 1908 public function add_state_query_params( $url ) { 1909 $parsed_original_url = wp_parse_url( $url ); 1910 $is_allowed = false; 1911 foreach ( $this->get_allowed_urls() as $allowed_url ) { 1912 $parsed_allowed_url = wp_parse_url( $allowed_url ); 1913 $is_allowed = ( 1914 $parsed_allowed_url['scheme'] === $parsed_original_url['scheme'] 1915 && 1916 $parsed_allowed_url['host'] === $parsed_original_url['host'] 1917 && 1918 0 === strpos( $parsed_original_url['path'], $parsed_allowed_url['path'] ) 1919 ); 1920 if ( $is_allowed ) { 1921 break; 1922 } 1923 } 1924 1925 if ( $is_allowed ) { 1926 $query_params = array( 1927 'customize_changeset_uuid' => $this->changeset_uuid(), 1928 ); 1929 if ( ! $this->is_theme_active() ) { 1930 $query_params['customize_theme'] = $this->get_stylesheet(); 1931 } 1932 if ( $this->messenger_channel ) { 1933 $query_params['customize_messenger_channel'] = $this->messenger_channel; 1934 } 1935 $url = add_query_arg( $query_params, $url ); 1936 } 1937 1938 return $url; 1939 } 1940 1941 /** 1942 * Prevent sending a 404 status when returning the response for the customize 1943 * preview, since it causes the jQuery Ajax to fail. Send 200 instead. 1944 * 1945 * @since 4.0.0 1946 * @deprecated 4.7.0 1947 */ 1948 public function customize_preview_override_404_status() { 1949 _deprecated_function( __METHOD__, '4.7.0' ); 1950 } 1951 1952 /** 1953 * Print base element for preview frame. 1954 * 1955 * @since 3.4.0 1956 * @deprecated 4.7.0 1957 */ 1958 public function customize_preview_base() { 1959 _deprecated_function( __METHOD__, '4.7.0' ); 1960 } 1961 1962 /** 1963 * Print a workaround to handle HTML5 tags in IE < 9. 1964 * 1965 * @since 3.4.0 1966 * @deprecated 4.7.0 Customizer no longer supports IE8, so all supported browsers recognize HTML5. 1967 */ 1968 public function customize_preview_html5() { 1969 _deprecated_function( __FUNCTION__, '4.7.0' ); 1970 } 1971 1972 /** 1973 * Print CSS for loading indicators for the Customizer preview. 1974 * 1975 * @since 4.2.0 1976 */ 1977 public function customize_preview_loading_style() { 1978 ?> 1979 <style> 1980 body.wp-customizer-unloading { 1981 opacity: 0.25; 1982 cursor: progress !important; 1983 -webkit-transition: opacity 0.5s; 1984 transition: opacity 0.5s; 1985 } 1986 body.wp-customizer-unloading * { 1987 pointer-events: none !important; 1988 } 1989 form.customize-unpreviewable, 1990 form.customize-unpreviewable input, 1991 form.customize-unpreviewable select, 1992 form.customize-unpreviewable button, 1993 a.customize-unpreviewable, 1994 area.customize-unpreviewable { 1995 cursor: not-allowed !important; 1996 } 1997 </style> 1998 <?php 1999 } 2000 2001 /** 2002 * Remove customize_messenger_channel query parameter from the preview window when it is not in an iframe. 2003 * 2004 * This ensures that the admin bar will be shown. It also ensures that link navigation will 2005 * work as expected since the parent frame is not being sent the URL to navigate to. 2006 * 2007 * @since 4.7.0 2008 */ 2009 public function remove_frameless_preview_messenger_channel() { 2010 if ( ! $this->messenger_channel ) { 2011 return; 2012 } 2013 ?> 2014 <script> 2015 ( function() { 2016 var urlParser, oldQueryParams, newQueryParams, i; 2017 if ( parent !== window ) { 2018 return; 2019 } 2020 urlParser = document.createElement( 'a' ); 2021 urlParser.href = location.href; 2022 oldQueryParams = urlParser.search.substr( 1 ).split( /&/ ); 2023 newQueryParams = []; 2024 for ( i = 0; i < oldQueryParams.length; i += 1 ) { 2025 if ( ! /^customize_messenger_channel=/.test( oldQueryParams[ i ] ) ) { 2026 newQueryParams.push( oldQueryParams[ i ] ); 2027 } 2028 } 2029 urlParser.search = newQueryParams.join( '&' ); 2030 if ( urlParser.search !== location.search ) { 2031 location.replace( urlParser.href ); 2032 } 2033 } )(); 2034 </script> 2035 <?php 2036 } 2037 2038 /** 2039 * Print JavaScript settings for preview frame. 2040 * 2041 * @since 3.4.0 2042 */ 2043 public function customize_preview_settings() { 2044 $post_values = $this->unsanitized_post_values( array( 'exclude_changeset' => true ) ); 2045 $setting_validities = $this->validate_setting_values( $post_values ); 2046 $exported_setting_validities = array_map( array( $this, 'prepare_setting_validity_for_js' ), $setting_validities ); 2047 2048 // Note that the REQUEST_URI is not passed into home_url() since this breaks subdirectory installations. 2049 $self_url = empty( $_SERVER['REQUEST_URI'] ) ? home_url( '/' ) : esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ) ); 2050 $state_query_params = array( 2051 'customize_theme', 2052 'customize_changeset_uuid', 2053 'customize_messenger_channel', 2054 ); 2055 $self_url = remove_query_arg( $state_query_params, $self_url ); 2056 2057 $allowed_urls = $this->get_allowed_urls(); 2058 $allowed_hosts = array(); 2059 foreach ( $allowed_urls as $allowed_url ) { 2060 $parsed = wp_parse_url( $allowed_url ); 2061 if ( empty( $parsed['host'] ) ) { 2062 continue; 2063 } 2064 $host = $parsed['host']; 2065 if ( ! empty( $parsed['port'] ) ) { 2066 $host .= ':' . $parsed['port']; 2067 } 2068 $allowed_hosts[] = $host; 2069 } 2070 2071 $switched_locale = switch_to_locale( get_user_locale() ); 2072 $l10n = array( 2073 'shiftClickToEdit' => __( 'Shift-click to edit this element.' ), 2074 'linkUnpreviewable' => __( 'This link is not live-previewable.' ), 2075 'formUnpreviewable' => __( 'This form is not live-previewable.' ), 2076 ); 2077 if ( $switched_locale ) { 2078 restore_previous_locale(); 2079 } 2080 2081 $settings = array( 2082 'changeset' => array( 2083 'uuid' => $this->changeset_uuid(), 2084 'autosaved' => $this->autosaved(), 2085 ), 2086 'timeouts' => array( 2087 'selectiveRefresh' => 250, 2088 'keepAliveSend' => 1000, 2089 ), 2090 'theme' => array( 2091 'stylesheet' => $this->get_stylesheet(), 2092 'active' => $this->is_theme_active(), 2093 ), 2094 'url' => array( 2095 'self' => $self_url, 2096 'allowed' => array_map( 'esc_url_raw', $this->get_allowed_urls() ), 2097 'allowedHosts' => array_unique( $allowed_hosts ), 2098 'isCrossDomain' => $this->is_cross_domain(), 2099 ), 2100 'channel' => $this->messenger_channel, 2101 'activePanels' => array(), 2102 'activeSections' => array(), 2103 'activeControls' => array(), 2104 'settingValidities' => $exported_setting_validities, 2105 'nonce' => current_user_can( 'customize' ) ? $this->get_nonces() : array(), 2106 'l10n' => $l10n, 2107 '_dirty' => array_keys( $post_values ), 2108 ); 2109 2110 foreach ( $this->panels as $panel_id => $panel ) { 2111 if ( $panel->check_capabilities() ) { 2112 $settings['activePanels'][ $panel_id ] = $panel->active(); 2113 foreach ( $panel->sections as $section_id => $section ) { 2114 if ( $section->check_capabilities() ) { 2115 $settings['activeSections'][ $section_id ] = $section->active(); 2116 } 2117 } 2118 } 2119 } 2120 foreach ( $this->sections as $id => $section ) { 2121 if ( $section->check_capabilities() ) { 2122 $settings['activeSections'][ $id ] = $section->active(); 2123 } 2124 } 2125 foreach ( $this->controls as $id => $control ) { 2126 if ( $control->check_capabilities() ) { 2127 $settings['activeControls'][ $id ] = $control->active(); 2128 } 2129 } 2130 2131 ?> 2132 <script type="text/javascript"> 2133 var _wpCustomizeSettings = <?php echo wp_json_encode( $settings ); ?>; 2134 _wpCustomizeSettings.values = {}; 2135 (function( v ) { 2136 <?php 2137 /* 2138 * Serialize settings separately from the initial _wpCustomizeSettings 2139 * serialization in order to avoid a peak memory usage spike. 2140 * @todo We may not even need to export the values at all since the pane syncs them anyway. 2141 */ 2142 foreach ( $this->settings as $id => $setting ) { 2143 if ( $setting->check_capabilities() ) { 2144 printf( 2145 "v[%s] = %s;\n", 2146 wp_json_encode( $id ), 2147 wp_json_encode( $setting->js_value() ) 2148 ); 2149 } 2150 } 2151 ?> 2152 })( _wpCustomizeSettings.values ); 2153 </script> 2154 <?php 2155 } 2156 2157 /** 2158 * Prints a signature so we can ensure the Customizer was properly executed. 2159 * 2160 * @since 3.4.0 2161 * @deprecated 4.7.0 2162 */ 2163 public function customize_preview_signature() { 2164 _deprecated_function( __METHOD__, '4.7.0' ); 2165 } 2166 2167 /** 2168 * Removes the signature in case we experience a case where the Customizer was not properly executed. 2169 * 2170 * @since 3.4.0 2171 * @deprecated 4.7.0 2172 * 2173 * @param mixed $return Value passed through for {@see 'wp_die_handler'} filter. 2174 * @return mixed Value passed through for {@see 'wp_die_handler'} filter. 2175 */ 2176 public function remove_preview_signature( $return = null ) { 2177 _deprecated_function( __METHOD__, '4.7.0' ); 2178 2179 return $return; 2180 } 2181 2182 /** 2183 * Is it a theme preview? 2184 * 2185 * @since 3.4.0 2186 * 2187 * @return bool True if it's a preview, false if not. 2188 */ 2189 public function is_preview() { 2190 return (bool) $this->previewing; 2191 } 2192 2193 /** 2194 * Retrieve the template name of the previewed theme. 2195 * 2196 * @since 3.4.0 2197 * 2198 * @return string Template name. 2199 */ 2200 public function get_template() { 2201 return $this->theme()->get_template(); 2202 } 2203 2204 /** 2205 * Retrieve the stylesheet name of the previewed theme. 2206 * 2207 * @since 3.4.0 2208 * 2209 * @return string Stylesheet name. 2210 */ 2211 public function get_stylesheet() { 2212 return $this->theme()->get_stylesheet(); 2213 } 2214 2215 /** 2216 * Retrieve the template root of the previewed theme. 2217 * 2218 * @since 3.4.0 2219 * 2220 * @return string Theme root. 2221 */ 2222 public function get_template_root() { 2223 return get_raw_theme_root( $this->get_template(), true ); 2224 } 2225 2226 /** 2227 * Retrieve the stylesheet root of the previewed theme. 2228 * 2229 * @since 3.4.0 2230 * 2231 * @return string Theme root. 2232 */ 2233 public function get_stylesheet_root() { 2234 return get_raw_theme_root( $this->get_stylesheet(), true ); 2235 } 2236 2237 /** 2238 * Filters the current theme and return the name of the previewed theme. 2239 * 2240 * @since 3.4.0 2241 * 2242 * @param $current_theme {@internal Parameter is not used} 2243 * @return string Theme name. 2244 */ 2245 public function current_theme( $current_theme ) { 2246 return $this->theme()->display( 'Name' ); 2247 } 2248 2249 /** 2250 * Validates setting values. 2251 * 2252 * Validation is skipped for unregistered settings or for values that are 2253 * already null since they will be skipped anyway. Sanitization is applied 2254 * to values that pass validation, and values that become null or `WP_Error` 2255 * after sanitizing are marked invalid. 2256 * 2257 * @since 4.6.0 2258 * 2259 * @see WP_REST_Request::has_valid_params() 2260 * @see WP_Customize_Setting::validate() 2261 * 2262 * @param array $setting_values Mapping of setting IDs to values to validate and sanitize. 2263 * @param array $options { 2264 * Options. 2265 * 2266 * @type bool $validate_existence Whether a setting's existence will be checked. 2267 * @type bool $validate_capability Whether the setting capability will be checked. 2268 * } 2269 * @return array Mapping of setting IDs to return value of validate method calls, either `true` or `WP_Error`. 2270 */ 2271 public function validate_setting_values( $setting_values, $options = array() ) { 2272 $options = wp_parse_args( 2273 $options, 2274 array( 2275 'validate_capability' => false, 2276 'validate_existence' => false, 2277 ) 2278 ); 2279 2280 $validities = array(); 2281 foreach ( $setting_values as $setting_id => $unsanitized_value ) { 2282 $setting = $this->get_setting( $setting_id ); 2283 if ( ! $setting ) { 2284 if ( $options['validate_existence'] ) { 2285 $validities[ $setting_id ] = new WP_Error( 'unrecognized', __( 'Setting does not exist or is unrecognized.' ) ); 2286 } 2287 continue; 2288 } 2289 if ( $options['validate_capability'] && ! current_user_can( $setting->capability ) ) { 2290 $validity = new WP_Error( 'unauthorized', __( 'Unauthorized to modify setting due to capability.' ) ); 2291 } else { 2292 if ( is_null( $unsanitized_value ) ) { 2293 continue; 2294 } 2295 $validity = $setting->validate( $unsanitized_value ); 2296 } 2297 if ( ! is_wp_error( $validity ) ) { 2298 /** This filter is documented in wp-includes/class-wp-customize-setting.php */ 2299 $late_validity = apply_filters( "customize_validate_{$setting->id}", new WP_Error(), $unsanitized_value, $setting ); 2300 if ( is_wp_error( $late_validity ) && $late_validity->has_errors() ) { 2301 $validity = $late_validity; 2302 } 2303 } 2304 if ( ! is_wp_error( $validity ) ) { 2305 $value = $setting->sanitize( $unsanitized_value ); 2306 if ( is_null( $value ) ) { 2307 $validity = false; 2308 } elseif ( is_wp_error( $value ) ) { 2309 $validity = $value; 2310 } 2311 } 2312 if ( false === $validity ) { 2313 $validity = new WP_Error( 'invalid_value', __( 'Invalid value.' ) ); 2314 } 2315 $validities[ $setting_id ] = $validity; 2316 } 2317 return $validities; 2318 } 2319 2320 /** 2321 * Prepares setting validity for exporting to the client (JS). 2322 * 2323 * Converts `WP_Error` instance into array suitable for passing into the 2324 * `wp.customize.Notification` JS model. 2325 * 2326 * @since 4.6.0 2327 * 2328 * @param true|WP_Error $validity Setting validity. 2329 * @return true|array If `$validity` was a WP_Error, the error codes will be array-mapped 2330 * to their respective `message` and `data` to pass into the 2331 * `wp.customize.Notification` JS model. 2332 */ 2333 public function prepare_setting_validity_for_js( $validity ) { 2334 if ( is_wp_error( $validity ) ) { 2335 $notification = array(); 2336 foreach ( $validity->errors as $error_code => $error_messages ) { 2337 $notification[ $error_code ] = array( 2338 'message' => join( ' ', $error_messages ), 2339 'data' => $validity->get_error_data( $error_code ), 2340 ); 2341 } 2342 return $notification; 2343 } else { 2344 return true; 2345 } 2346 } 2347 2348 /** 2349 * Handle customize_save WP Ajax request to save/update a changeset. 2350 * 2351 * @since 3.4.0 2352 * @since 4.7.0 The semantics of this method have changed to update a changeset, optionally to also change the status and other attributes. 2353 */ 2354 public function save() { 2355 if ( ! is_user_logged_in() ) { 2356 wp_send_json_error( 'unauthenticated' ); 2357 } 2358 2359 if ( ! $this->is_preview() ) { 2360 wp_send_json_error( 'not_preview' ); 2361 } 2362 2363 $action = 'save-customize_' . $this->get_stylesheet(); 2364 if ( ! check_ajax_referer( $action, 'nonce', false ) ) { 2365 wp_send_json_error( 'invalid_nonce' ); 2366 } 2367 2368 $changeset_post_id = $this->changeset_post_id(); 2369 $is_new_changeset = empty( $changeset_post_id ); 2370 if ( $is_new_changeset ) { 2371 if ( ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->create_posts ) ) { 2372 wp_send_json_error( 'cannot_create_changeset_post' ); 2373 } 2374 } else { 2375 if ( ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->edit_post, $changeset_post_id ) ) { 2376 wp_send_json_error( 'cannot_edit_changeset_post' ); 2377 } 2378 } 2379 2380 if ( ! empty( $_POST['customize_changeset_data'] ) ) { 2381 $input_changeset_data = json_decode( wp_unslash( $_POST['customize_changeset_data'] ), true ); 2382 if ( ! is_array( $input_changeset_data ) ) { 2383 wp_send_json_error( 'invalid_customize_changeset_data' ); 2384 } 2385 } else { 2386 $input_changeset_data = array(); 2387 } 2388 2389 // Validate title. 2390 $changeset_title = null; 2391 if ( isset( $_POST['customize_changeset_title'] ) ) { 2392 $changeset_title = sanitize_text_field( wp_unslash( $_POST['customize_changeset_title'] ) ); 2393 } 2394 2395 // Validate changeset status param. 2396 $is_publish = null; 2397 $changeset_status = null; 2398 if ( isset( $_POST['customize_changeset_status'] ) ) { 2399 $changeset_status = wp_unslash( $_POST['customize_changeset_status'] ); 2400 if ( ! get_post_status_object( $changeset_status ) || ! in_array( $changeset_status, array( 'draft', 'pending', 'publish', 'future' ), true ) ) { 2401 wp_send_json_error( 'bad_customize_changeset_status', 400 ); 2402 } 2403 $is_publish = ( 'publish' === $changeset_status || 'future' === $changeset_status ); 2404 if ( $is_publish && ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->publish_posts ) ) { 2405 wp_send_json_error( 'changeset_publish_unauthorized', 403 ); 2406 } 2407 } 2408 2409 /* 2410 * Validate changeset date param. Date is assumed to be in local time for 2411 * the WP if in MySQL format (YYYY-MM-DD HH:MM:SS). Otherwise, the date 2412 * is parsed with strtotime() so that ISO date format may be supplied 2413 * or a string like "+10 minutes". 2414 */ 2415 $changeset_date_gmt = null; 2416 if ( isset( $_POST['customize_changeset_date'] ) ) { 2417 $changeset_date = wp_unslash( $_POST['customize_changeset_date'] ); 2418 if ( preg_match( '/^\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d$/', $changeset_date ) ) { 2419 $mm = substr( $changeset_date, 5, 2 ); 2420 $jj = substr( $changeset_date, 8, 2 ); 2421 $aa = substr( $changeset_date, 0, 4 ); 2422 $valid_date = wp_checkdate( $mm, $jj, $aa, $changeset_date ); 2423 if ( ! $valid_date ) { 2424 wp_send_json_error( 'bad_customize_changeset_date', 400 ); 2425 } 2426 $changeset_date_gmt = get_gmt_from_date( $changeset_date ); 2427 } else { 2428 $timestamp = strtotime( $changeset_date ); 2429 if ( ! $timestamp ) { 2430 wp_send_json_error( 'bad_customize_changeset_date', 400 ); 2431 } 2432 $changeset_date_gmt = gmdate( 'Y-m-d H:i:s', $timestamp ); 2433 } 2434 } 2435 2436 $lock_user_id = null; 2437 $autosave = ! empty( $_POST['customize_changeset_autosave'] ); 2438 if ( ! $is_new_changeset ) { 2439 $lock_user_id = wp_check_post_lock( $this->changeset_post_id() ); 2440 } 2441 2442 // Force request to autosave when changeset is locked. 2443 if ( $lock_user_id && ! $autosave ) { 2444 $autosave = true; 2445 $changeset_status = null; 2446 $changeset_date_gmt = null; 2447 } 2448 2449 if ( $autosave && ! defined( 'DOING_AUTOSAVE' ) ) { // Back-compat. 2450 define( 'DOING_AUTOSAVE', true ); 2451 } 2452 2453 $autosaved = false; 2454 $r = $this->save_changeset_post( 2455 array( 2456 'status' => $changeset_status, 2457 'title' => $changeset_title, 2458 'date_gmt' => $changeset_date_gmt, 2459 'data' => $input_changeset_data, 2460 'autosave' => $autosave, 2461 ) 2462 ); 2463 if ( $autosave && ! is_wp_error( $r ) ) { 2464 $autosaved = true; 2465 } 2466 2467 // If the changeset was locked and an autosave request wasn't itself an error, then now explicitly return with a failure. 2468 if ( $lock_user_id && ! is_wp_error( $r ) ) { 2469 $r = new WP_Error( 2470 'changeset_locked', 2471 __( 'Changeset is being edited by other user.' ), 2472 array( 2473 'lock_user' => $this->get_lock_user_data( $lock_user_id ), 2474 ) 2475 ); 2476 } 2477 2478 if ( is_wp_error( $r ) ) { 2479 $response = array( 2480 'message' => $r->get_error_message(), 2481 'code' => $r->get_error_code(), 2482 ); 2483 if ( is_array( $r->get_error_data() ) ) { 2484 $response = array_merge( $response, $r->get_error_data() ); 2485 } else { 2486 $response['data'] = $r->get_error_data(); 2487 } 2488 } else { 2489 $response = $r; 2490 $changeset_post = get_post( $this->changeset_post_id() ); 2491 2492 // Dismiss all other auto-draft changeset posts for this user (they serve like autosave revisions), as there should only be one. 2493 if ( $is_new_changeset ) { 2494 $this->dismiss_user_auto_draft_changesets(); 2495 } 2496 2497 // Note that if the changeset status was publish, then it will get set to trash if revisions are not supported. 2498 $response['changeset_status'] = $changeset_post->post_status; 2499 if ( $is_publish && 'trash' === $response['changeset_status'] ) { 2500 $response['changeset_status'] = 'publish'; 2501 } 2502 2503 if ( 'publish' !== $response['changeset_status'] ) { 2504 $this->set_changeset_lock( $changeset_post->ID ); 2505 } 2506 2507 if ( 'future' === $response['changeset_status'] ) { 2508 $response['changeset_date'] = $changeset_post->post_date; 2509 } 2510 2511 if ( 'publish' === $response['changeset_status'] || 'trash' === $response['changeset_status'] ) { 2512 $response['next_changeset_uuid'] = wp_generate_uuid4(); 2513 } 2514 } 2515 2516 if ( $autosave ) { 2517 $response['autosaved'] = $autosaved; 2518 } 2519 2520 if ( isset( $response['setting_validities'] ) ) { 2521 $response['setting_validities'] = array_map( array( $this, 'prepare_setting_validity_for_js' ), $response['setting_validities'] ); 2522 } 2523 2524 /** 2525 * Filters response data for a successful customize_save Ajax request. 2526 * 2527 * This filter does not apply if there was a nonce or authentication failure. 2528 * 2529 * @since 4.2.0 2530 * 2531 * @param array $response Additional information passed back to the 'saved' 2532 * event on `wp.customize`. 2533 * @param WP_Customize_Manager $this WP_Customize_Manager instance. 2534 */ 2535 $response = apply_filters( 'customize_save_response', $response, $this ); 2536 2537 if ( is_wp_error( $r ) ) { 2538 wp_send_json_error( $response ); 2539 } else { 2540 wp_send_json_success( $response ); 2541 } 2542 } 2543 2544 /** 2545 * Save the post for the loaded changeset. 2546 * 2547 * @since 4.7.0 2548 * 2549 * @param array $args { 2550 * Args for changeset post. 2551 * 2552 * @type array $data Optional additional changeset data. Values will be merged on top of any existing post values. 2553 * @type string $status Post status. Optional. If supplied, the save will be transactional and a post revision will be allowed. 2554 * @type string $title Post title. Optional. 2555 * @type string $date_gmt Date in GMT. Optional. 2556 * @type int $user_id ID for user who is saving the changeset. Optional, defaults to the current user ID. 2557 * @type bool $starter_content Whether the data is starter content. If false (default), then $starter_content will be cleared for any $data being saved. 2558 * @type bool $autosave Whether this is a request to create an autosave revision. 2559 * } 2560 * 2561 * @return array|WP_Error Returns array on success and WP_Error with array data on error. 2562 */ 2563 function save_changeset_post( $args = array() ) { 2564 2565 $args = array_merge( 2566 array( 2567 'status' => null, 2568 'title' => null, 2569 'data' => array(), 2570 'date_gmt' => null, 2571 'user_id' => get_current_user_id(), 2572 'starter_content' => false, 2573 'autosave' => false, 2574 ), 2575 $args 2576 ); 2577 2578 $changeset_post_id = $this->changeset_post_id(); 2579 $existing_changeset_data = array(); 2580 if ( $changeset_post_id ) { 2581 $existing_status = get_post_status( $changeset_post_id ); 2582 if ( 'publish' === $existing_status || 'trash' === $existing_status ) { 2583 return new WP_Error( 2584 'changeset_already_published', 2585 __( 'The previous set of changes has already been published. Please try saving your current set of changes again.' ), 2586 array( 2587 'next_changeset_uuid' => wp_generate_uuid4(), 2588 ) 2589 ); 2590 } 2591 2592 $existing_changeset_data = $this->get_changeset_post_data( $changeset_post_id ); 2593 if ( is_wp_error( $existing_changeset_data ) ) { 2594 return $existing_changeset_data; 2595 } 2596 } 2597 2598 // Fail if attempting to publish but publish hook is missing. 2599 if ( 'publish' === $args['status'] && false === has_action( 'transition_post_status', '_wp_customize_publish_changeset' ) ) { 2600 return new WP_Error( 'missing_publish_callback' ); 2601 } 2602 2603 // Validate date. 2604 $now = gmdate( 'Y-m-d H:i:59' ); 2605 if ( $args['date_gmt'] ) { 2606 $is_future_dated = ( mysql2date( 'U', $args['date_gmt'], false ) > mysql2date( 'U', $now, false ) ); 2607 if ( ! $is_future_dated ) { 2608 return new WP_Error( 'not_future_date', __( 'You must supply a future date to schedule.' ) ); // Only future dates are allowed. 2609 } 2610 2611 if ( ! $this->is_theme_active() && ( 'future' === $args['status'] || $is_future_dated ) ) { 2612 return new WP_Error( 'cannot_schedule_theme_switches' ); // This should be allowed in the future, when theme is a regular setting. 2613 } 2614 $will_remain_auto_draft = ( ! $args['status'] && ( ! $changeset_post_id || 'auto-draft' === get_post_status( $changeset_post_id ) ) ); 2615 if ( $will_remain_auto_draft ) { 2616 return new WP_Error( 'cannot_supply_date_for_auto_draft_changeset' ); 2617 } 2618 } elseif ( $changeset_post_id && 'future' === $args['status'] ) { 2619 2620 // Fail if the new status is future but the existing post's date is not in the future. 2621 $changeset_post = get_post( $changeset_post_id ); 2622 if ( mysql2date( 'U', $changeset_post->post_date_gmt, false ) <= mysql2date( 'U', $now, false ) ) { 2623 return new WP_Error( 'not_future_date', __( 'You must supply a future date to schedule.' ) ); 2624 } 2625 } 2626 2627 if ( ! empty( $is_future_dated ) && 'publish' === $args['status'] ) { 2628 $args['status'] = 'future'; 2629 } 2630 2631 // Validate autosave param. See _wp_post_revision_fields() for why these fields are disallowed. 2632 if ( $args['autosave'] ) { 2633 if ( $args['date_gmt'] ) { 2634 return new WP_Error( 'illegal_autosave_with_date_gmt' ); 2635 } elseif ( $args['status'] ) { 2636 return new WP_Error( 'illegal_autosave_with_status' ); 2637 } elseif ( $args['user_id'] && get_current_user_id() !== $args['user_id'] ) { 2638 return new WP_Error( 'illegal_autosave_with_non_current_user' ); 2639 } 2640 } 2641 2642 // The request was made via wp.customize.previewer.save(). 2643 $update_transactionally = (bool) $args['status']; 2644 $allow_revision = (bool) $args['status']; 2645 2646 // Amend post values with any supplied data. 2647 foreach ( $args['data'] as $setting_id => $setting_params ) { 2648 if ( is_array( $setting_params ) && array_key_exists( 'value', $setting_params ) ) { 2649 $this->set_post_value( $setting_id, $setting_params['value'] ); // Add to post values so that they can be validated and sanitized. 2650 } 2651 } 2652 2653 // Note that in addition to post data, this will include any stashed theme mods. 2654 $post_values = $this->unsanitized_post_values( 2655 array( 2656 'exclude_changeset' => true, 2657 'exclude_post_data' => false, 2658 ) 2659 ); 2660 $this->add_dynamic_settings( array_keys( $post_values ) ); // Ensure settings get created even if they lack an input value. 2661 2662 /* 2663 * Get list of IDs for settings that have values different from what is currently 2664 * saved in the changeset. By skipping any values that are already the same, the 2665 * subset of changed settings can be passed into validate_setting_values to prevent 2666 * an underprivileged modifying a single setting for which they have the capability 2667 * from being blocked from saving. This also prevents a user from touching of the 2668 * previous saved settings and overriding the associated user_id if they made no change. 2669 */ 2670 $changed_setting_ids = array(); 2671 foreach ( $post_values as $setting_id => $setting_value ) { 2672 $setting = $this->get_setting( $setting_id ); 2673 2674 if ( $setting && 'theme_mod' === $setting->type ) { 2675 $prefixed_setting_id = $this->get_stylesheet() . '::' . $setting->id; 2676 } else { 2677 $prefixed_setting_id = $setting_id; 2678 } 2679 2680 $is_value_changed = ( 2681 ! isset( $existing_changeset_data[ $prefixed_setting_id ] ) 2682 || 2683 ! array_key_exists( 'value', $existing_changeset_data[ $prefixed_setting_id ] ) 2684 || 2685 $existing_changeset_data[ $prefixed_setting_id ]['value'] !== $setting_value 2686 ); 2687 if ( $is_value_changed ) { 2688 $changed_setting_ids[] = $setting_id; 2689 } 2690 } 2691 2692 /** 2693 * Fires before save validation happens. 2694 * 2695 * Plugins can add just-in-time {@see 'customize_validate_{$this->ID}'} filters 2696 * at this point to catch any settings registered after `customize_register`. 2697 * The dynamic portion of the hook name, `$this->ID` refers to the setting ID. 2698 * 2699 * @since 4.6.0 2700 * 2701 * @param WP_Customize_Manager $this WP_Customize_Manager instance. 2702 */ 2703 do_action( 'customize_save_validation_before', $this ); 2704 2705 // Validate settings. 2706 $validated_values = array_merge( 2707 array_fill_keys( array_keys( $args['data'] ), null ), // Make sure existence/capability checks are done on value-less setting updates. 2708 $post_values 2709 ); 2710 $setting_validities = $this->validate_setting_values( 2711 $validated_values, 2712 array( 2713 'validate_capability' => true, 2714 'validate_existence' => true, 2715 ) 2716 ); 2717 $invalid_setting_count = count( array_filter( $setting_validities, 'is_wp_error' ) ); 2718 2719 /* 2720 * Short-circuit if there are invalid settings the update is transactional. 2721 * A changeset update is transactional when a status is supplied in the request. 2722 */ 2723 if ( $update_transactionally && $invalid_setting_count > 0 ) { 2724 $response = array( 2725 'setting_validities' => $setting_validities, 2726 /* translators: %s: Number of invalid settings. */ 2727 'message' => sprintf( _n( 'Unable to save due to %s invalid setting.', 'Unable to save due to %s invalid settings.', $invalid_setting_count ), number_format_i18n( $invalid_setting_count ) ), 2728 ); 2729 return new WP_Error( 'transaction_fail', '', $response ); 2730 } 2731 2732 // Obtain/merge data for changeset. 2733 $original_changeset_data = $this->get_changeset_post_data( $changeset_post_id ); 2734 $data = $original_changeset_data; 2735 if ( is_wp_error( $data ) ) { 2736 $data = array(); 2737 } 2738 2739 // Ensure that all post values are included in the changeset data. 2740 foreach ( $post_values as $setting_id => $post_value ) { 2741 if ( ! isset( $args['data'][ $setting_id ] ) ) { 2742 $args['data'][ $setting_id ] = array(); 2743 } 2744 if ( ! isset( $args['data'][ $setting_id ]['value'] ) ) { 2745 $args['data'][ $setting_id ]['value'] = $post_value; 2746 } 2747 } 2748 2749 foreach ( $args['data'] as $setting_id => $setting_params ) { 2750 $setting = $this->get_setting( $setting_id ); 2751 if ( ! $setting || ! $setting->check_capabilities() ) { 2752 continue; 2753 } 2754 2755 // Skip updating changeset for invalid setting values. 2756 if ( isset( $setting_validities[ $setting_id ] ) && is_wp_error( $setting_validities[ $setting_id ] ) ) { 2757 continue; 2758 } 2759 2760 $changeset_setting_id = $setting_id; 2761 if ( 'theme_mod' === $setting->type ) { 2762 $changeset_setting_id = sprintf( '%s::%s', $this->get_stylesheet(), $setting_id ); 2763 } 2764 2765 if ( null === $setting_params ) { 2766 // Remove setting from changeset entirely. 2767 unset( $data[ $changeset_setting_id ] ); 2768 } else { 2769 2770 if ( ! isset( $data[ $changeset_setting_id ] ) ) { 2771 $data[ $changeset_setting_id ] = array(); 2772 } 2773 2774 // Merge any additional setting params that have been supplied with the existing params. 2775 $merged_setting_params = array_merge( $data[ $changeset_setting_id ], $setting_params ); 2776 2777 // Skip updating setting params if unchanged (ensuring the user_id is not overwritten). 2778 if ( $data[ $changeset_setting_id ] === $merged_setting_params ) { 2779 continue; 2780 } 2781 2782 $data[ $changeset_setting_id ] = array_merge( 2783 $merged_setting_params, 2784 array( 2785 'type' => $setting->type, 2786 'user_id' => $args['user_id'], 2787 'date_modified_gmt' => current_time( 'mysql', true ), 2788 ) 2789 ); 2790 2791 // Clear starter_content flag in data if changeset is not explicitly being updated for starter content. 2792 if ( empty( $args['starter_content'] ) ) { 2793 unset( $data[ $changeset_setting_id ]['starter_content'] ); 2794 } 2795 } 2796 } 2797 2798 $filter_context = array( 2799 'uuid' => $this->changeset_uuid(), 2800 'title' => $args['title'], 2801 'status' => $args['status'], 2802 'date_gmt' => $args['date_gmt'], 2803 'post_id' => $changeset_post_id, 2804 'previous_data' => is_wp_error( $original_changeset_data ) ? array() : $original_changeset_data, 2805 'manager' => $this, 2806 ); 2807 2808 /** 2809 * Filters the settings' data that will be persisted into the changeset. 2810 * 2811 * Plugins may amend additional data (such as additional meta for settings) into the changeset with this filter. 2812 * 2813 * @since 4.7.0 2814 * 2815 * @param array $data Updated changeset data, mapping setting IDs to arrays containing a $value item and optionally other metadata. 2816 * @param array $context { 2817 * Filter context. 2818 * 2819 * @type string $uuid Changeset UUID. 2820 * @type string $title Requested title for the changeset post. 2821 * @type string $status Requested status for the changeset post. 2822 * @type string $date_gmt Requested date for the changeset post in MySQL format and GMT timezone. 2823 * @type int|false $post_id Post ID for the changeset, or false if it doesn't exist yet. 2824 * @type array $previous_data Previous data contained in the changeset. 2825 * @type WP_Customize_Manager $manager Manager instance. 2826 * } 2827 */ 2828 $data = apply_filters( 'customize_changeset_save_data', $data, $filter_context ); 2829 2830 // Switch theme if publishing changes now. 2831 if ( 'publish' === $args['status'] && ! $this->is_theme_active() ) { 2832 // Temporarily stop previewing the theme to allow switch_themes() to operate properly. 2833 $this->stop_previewing_theme(); 2834 switch_theme( $this->get_stylesheet() ); 2835 update_option( 'theme_switched_via_customizer', true ); 2836 $this->start_previewing_theme(); 2837 } 2838 2839 // Gather the data for wp_insert_post()/wp_update_post(). 2840 $post_array = array( 2841 // JSON_UNESCAPED_SLASHES is only to improve readability as slashes needn't be escaped in storage. 2842 'post_content' => wp_json_encode( $data, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT ), 2843 ); 2844 if ( $args['title'] ) { 2845 $post_array['post_title'] = $args['title']; 2846 } 2847 if ( $changeset_post_id ) { 2848 $post_array['ID'] = $changeset_post_id; 2849 } else { 2850 $post_array['post_type'] = 'customize_changeset'; 2851 $post_array['post_name'] = $this->changeset_uuid(); 2852 $post_array['post_status'] = 'auto-draft'; 2853 } 2854 if ( $args['status'] ) { 2855 $post_array['post_status'] = $args['status']; 2856 } 2857 2858 // Reset post date to now if we are publishing, otherwise pass post_date_gmt and translate for post_date. 2859 if ( 'publish' === $args['status'] ) { 2860 $post_array['post_date_gmt'] = '0000-00-00 00:00:00'; 2861 $post_array['post_date'] = '0000-00-00 00:00:00'; 2862 } elseif ( $args['date_gmt'] ) { 2863 $post_array['post_date_gmt'] = $args['date_gmt']; 2864 $post_array['post_date'] = get_date_from_gmt( $args['date_gmt'] ); 2865 } elseif ( $changeset_post_id && 'auto-draft' === get_post_status( $changeset_post_id ) ) { 2866 /* 2867 * Keep bumping the date for the auto-draft whenever it is modified; 2868 * this extends its life, preserving it from garbage-collection via 2869 * wp_delete_auto_drafts(). 2870 */ 2871 $post_array['post_date'] = current_time( 'mysql' ); 2872 $post_array['post_date_gmt'] = ''; 2873 } 2874 2875 $this->store_changeset_revision = $allow_revision; 2876 add_filter( 'wp_save_post_revision_post_has_changed', array( $this, '_filter_revision_post_has_changed' ), 5, 3 ); 2877 2878 /* 2879 * Update the changeset post. The publish_customize_changeset action 2880 * will cause the settings in the changeset to be saved via 2881 * WP_Customize_Setting::save(). 2882 */ 2883 2884 // Prevent content filters from corrupting JSON in post_content. 2885 $has_kses = ( false !== has_filter( 'content_save_pre', 'wp_filter_post_kses' ) ); 2886 if ( $has_kses ) { 2887 kses_remove_filters(); 2888 } 2889 $has_targeted_link_rel_filters = ( false !== has_filter( 'content_save_pre', 'wp_targeted_link_rel' ) ); 2890 if ( $has_targeted_link_rel_filters ) { 2891 wp_remove_targeted_link_rel_filters(); 2892 } 2893 2894 // Note that updating a post with publish status will trigger WP_Customize_Manager::publish_changeset_values(). 2895 if ( $changeset_post_id ) { 2896 if ( $args['autosave'] && 'auto-draft' !== get_post_status( $changeset_post_id ) ) { 2897 // See _wp_translate_postdata() for why this is required as it will use the edit_post meta capability. 2898 add_filter( 'map_meta_cap', array( $this, 'grant_edit_post_capability_for_changeset' ), 10, 4 ); 2899 $post_array['post_ID'] = $post_array['ID']; 2900 $post_array['post_type'] = 'customize_changeset'; 2901 $r = wp_create_post_autosave( wp_slash( $post_array ) ); 2902 remove_filter( 'map_meta_cap', array( $this, 'grant_edit_post_capability_for_changeset' ), 10 ); 2903 } else { 2904 $post_array['edit_date'] = true; // Prevent date clearing. 2905 $r = wp_update_post( wp_slash( $post_array ), true ); 2906 2907 // Delete autosave revision for user when the changeset is updated. 2908 if ( ! empty( $args['user_id'] ) ) { 2909 $autosave_draft = wp_get_post_autosave( $changeset_post_id, $args['user_id'] ); 2910 if ( $autosave_draft ) { 2911 wp_delete_post( $autosave_draft->ID, true ); 2912 } 2913 } 2914 } 2915 } else { 2916 $r = wp_insert_post( wp_slash( $post_array ), true ); 2917 if ( ! is_wp_error( $r ) ) { 2918 $this->_changeset_post_id = $r; // Update cached post ID for the loaded changeset. 2919 } 2920 } 2921 2922 // Restore removed content filters. 2923 if ( $has_kses ) { 2924 kses_init_filters(); 2925 } 2926 if ( $has_targeted_link_rel_filters ) { 2927 wp_init_targeted_link_rel_filters(); 2928 } 2929 2930 $this->_changeset_data = null; // Reset so WP_Customize_Manager::changeset_data() will re-populate with updated contents. 2931 2932 remove_filter( 'wp_save_post_revision_post_has_changed', array( $this, '_filter_revision_post_has_changed' ) ); 2933 2934 $response = array( 2935 'setting_validities' => $setting_validities, 2936 ); 2937 2938 if ( is_wp_error( $r ) ) { 2939 $response['changeset_post_save_failure'] = $r->get_error_code(); 2940 return new WP_Error( 'changeset_post_save_failure', '', $response ); 2941 } 2942 2943 return $response; 2944 } 2945 2946 /** 2947 * Trash or delete a changeset post. 2948 * 2949 * The following re-formulates the logic from `wp_trash_post()` as done in 2950 * `wp_publish_post()`. The reason for bypassing `wp_trash_post()` is that it 2951 * will mutate the the `post_content` and the `post_name` when they should be 2952 * untouched. 2953 * 2954 * @since 4.9.0 2955 * @global wpdb $wpdb WordPress database abstraction object. 2956 * @see wp_trash_post() 2957 * 2958 * @param int|WP_Post $post The changeset post. 2959 * @return mixed A WP_Post object for the trashed post or an empty value on failure. 2960 */ 2961 public function trash_changeset_post( $post ) { 2962 global $wpdb; 2963 2964 $post = get_post( $post ); 2965 2966 if ( ! ( $post instanceof WP_Post ) ) { 2967 return $post; 2968 } 2969 $post_id = $post->ID; 2970 2971 if ( ! EMPTY_TRASH_DAYS ) { 2972 return wp_delete_post( $post_id, true ); 2973 } 2974 2975 if ( 'trash' === get_post_status( $post ) ) { 2976 return false; 2977 } 2978 2979 /** This filter is documented in wp-includes/post.php */ 2980 $check = apply_filters( 'pre_trash_post', null, $post ); 2981 if ( null !== $check ) { 2982 return $check; 2983 } 2984 2985 /** This action is documented in wp-includes/post.php */ 2986 do_action( 'wp_trash_post', $post_id ); 2987 2988 add_post_meta( $post_id, '_wp_trash_meta_status', $post->post_status ); 2989 add_post_meta( $post_id, '_wp_trash_meta_time', time() ); 2990 2991 $old_status = $post->post_status; 2992 $new_status = 'trash'; 2993 $wpdb->update( $wpdb->posts, array( 'post_status' => $new_status ), array( 'ID' => $post->ID ) ); 2994 clean_post_cache( $post->ID ); 2995 2996 $post->post_status = $new_status; 2997 wp_transition_post_status( $new_status, $old_status, $post ); 2998 2999 /** This action is documented in wp-includes/post.php */ 3000 do_action( "edit_post_{$post->post_type}", $post->ID, $post ); 3001 3002 /** This action is documented in wp-includes/post.php */ 3003 do_action( 'edit_post', $post->ID, $post ); 3004 3005 /** This action is documented in wp-includes/post.php */ 3006 do_action( "save_post_{$post->post_type}", $post->ID, $post, true ); 3007 3008 /** This action is documented in wp-includes/post.php */ 3009 do_action( 'save_post', $post->ID, $post, true ); 3010 3011 /** This action is documented in wp-includes/post.php */ 3012 do_action( 'wp_insert_post', $post->ID, $post, true ); 3013 3014 wp_trash_post_comments( $post_id ); 3015 3016 /** This action is documented in wp-includes/post.php */ 3017 do_action( 'trashed_post', $post_id ); 3018 3019 return $post; 3020 } 3021 3022 /** 3023 * Handle request to trash a changeset. 3024 * 3025 * @since 4.9.0 3026 */ 3027 public function handle_changeset_trash_request() { 3028 if ( ! is_user_logged_in() ) { 3029 wp_send_json_error( 'unauthenticated' ); 3030 } 3031 3032 if ( ! $this->is_preview() ) { 3033 wp_send_json_error( 'not_preview' ); 3034 } 3035 3036 if ( ! check_ajax_referer( 'trash_customize_changeset', 'nonce', false ) ) { 3037 wp_send_json_error( 3038 array( 3039 'code' => 'invalid_nonce', 3040 'message' => __( 'There was an authentication problem. Please reload and try again.' ), 3041 ) 3042 ); 3043 } 3044 3045 $changeset_post_id = $this->changeset_post_id(); 3046 3047 if ( ! $changeset_post_id ) { 3048 wp_send_json_error( 3049 array( 3050 'message' => __( 'No changes saved yet, so there is nothing to trash.' ), 3051 'code' => 'non_existent_changeset', 3052 ) 3053 ); 3054 return; 3055 } 3056 3057 if ( $changeset_post_id && ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->delete_post, $changeset_post_id ) ) { 3058 wp_send_json_error( 3059 array( 3060 'code' => 'changeset_trash_unauthorized', 3061 'message' => __( 'Unable to trash changes.' ), 3062 ) 3063 ); 3064 } 3065 3066 if ( 'trash' === get_post_status( $changeset_post_id ) ) { 3067 wp_send_json_error( 3068 array( 3069 'message' => __( 'Changes have already been trashed.' ), 3070 'code' => 'changeset_already_trashed', 3071 ) 3072 ); 3073 return; 3074 } 3075 3076 $r = $this->trash_changeset_post( $changeset_post_id ); 3077 if ( ! ( $r instanceof WP_Post ) ) { 3078 wp_send_json_error( 3079 array( 3080 'code' => 'changeset_trash_failure', 3081 'message' => __( 'Unable to trash changes.' ), 3082 ) 3083 ); 3084 } 3085 3086 wp_send_json_success( 3087 array( 3088 'message' => __( 'Changes trashed successfully.' ), 3089 ) 3090 ); 3091 } 3092 3093 /** 3094 * Re-map 'edit_post' meta cap for a customize_changeset post to be the same as 'customize' maps. 3095 * 3096 * There is essentially a "meta meta" cap in play here, where 'edit_post' meta cap maps to 3097 * the 'customize' meta cap which then maps to 'edit_theme_options'. This is currently 3098 * required in core for `wp_create_post_autosave()` because it will call 3099 * `_wp_translate_postdata()` which in turn will check if a user can 'edit_post', but the 3100 * the caps for the customize_changeset post type are all mapping to the meta capability. 3101 * This should be able to be removed once #40922 is addressed in core. 3102 * 3103 * @since 4.9.0 3104 * @link https://core.trac.wordpress.org/ticket/40922 3105 * @see WP_Customize_Manager::save_changeset_post() 3106 * @see _wp_translate_postdata() 3107 * 3108 * @param string[] $caps Array of the user's capabilities. 3109 * @param string $cap Capability name. 3110 * @param int $user_id The user ID. 3111 * @param array $args Adds the context to the cap. Typically the object ID. 3112 * @return array Capabilities. 3113 */ 3114 public function grant_edit_post_capability_for_changeset( $caps, $cap, $user_id, $args ) { 3115 if ( 'edit_post' === $cap && ! empty( $args[0] ) && 'customize_changeset' === get_post_type( $args[0] ) ) { 3116 $post_type_obj = get_post_type_object( 'customize_changeset' ); 3117 $caps = map_meta_cap( $post_type_obj->cap->$cap, $user_id ); 3118 } 3119 return $caps; 3120 } 3121 3122 /** 3123 * Marks the changeset post as being currently edited by the current user. 3124 * 3125 * @since 4.9.0 3126 * 3127 * @param int $changeset_post_id Changeset post id. 3128 * @param bool $take_over Take over the changeset, default is false. 3129 */ 3130 public function set_changeset_lock( $changeset_post_id, $take_over = false ) { 3131 if ( $changeset_post_id ) { 3132 $can_override = ! (bool) get_post_meta( $changeset_post_id, '_edit_lock', true ); 3133 3134 if ( $take_over ) { 3135 $can_override = true; 3136 } 3137 3138 if ( $can_override ) { 3139 $lock = sprintf( '%s:%s', time(), get_current_user_id() ); 3140 update_post_meta( $changeset_post_id, '_edit_lock', $lock ); 3141 } else { 3142 $this->refresh_changeset_lock( $changeset_post_id ); 3143 } 3144 } 3145 } 3146 3147 /** 3148 * Refreshes changeset lock with the current time if current user edited the changeset before. 3149 * 3150 * @since 4.9.0 3151 * 3152 * @param int $changeset_post_id Changeset post id. 3153 */ 3154 public function refresh_changeset_lock( $changeset_post_id ) { 3155 if ( ! $changeset_post_id ) { 3156 return; 3157 } 3158 $lock = get_post_meta( $changeset_post_id, '_edit_lock', true ); 3159 $lock = explode( ':', $lock ); 3160 3161 if ( $lock && ! empty( $lock[1] ) ) { 3162 $user_id = intval( $lock[1] ); 3163 $current_user_id = get_current_user_id(); 3164 if ( $user_id === $current_user_id ) { 3165 $lock = sprintf( '%s:%s', time(), $user_id ); 3166 update_post_meta( $changeset_post_id, '_edit_lock', $lock ); 3167 } 3168 } 3169 } 3170 3171 /** 3172 * Filter heartbeat settings for the Customizer. 3173 * 3174 * @since 4.9.0 3175 * @param array $settings Current settings to filter. 3176 * @return array Heartbeat settings. 3177 */ 3178 public function add_customize_screen_to_heartbeat_settings( $settings ) { 3179 global $pagenow; 3180 if ( 'customize.php' === $pagenow ) { 3181 $settings['screenId'] = 'customize'; 3182 } 3183 return $settings; 3184 } 3185 3186 /** 3187 * Get lock user data. 3188 * 3189 * @since 4.9.0 3190 * 3191 * @param int $user_id User ID. 3192 * @return array|null User data formatted for client. 3193 */ 3194 protected function get_lock_user_data( $user_id ) { 3195 if ( ! $user_id ) { 3196 return null; 3197 } 3198 $lock_user = get_userdata( $user_id ); 3199 if ( ! $lock_user ) { 3200 return null; 3201 } 3202 return array( 3203 'id' => $lock_user->ID, 3204 'name' => $lock_user->display_name, 3205 'avatar' => get_avatar_url( $lock_user->ID, array( 'size' => 128 ) ), 3206 ); 3207 } 3208 3209 /** 3210 * Check locked changeset with heartbeat API. 3211 * 3212 * @since 4.9.0 3213 * 3214 * @param array $response The Heartbeat response. 3215 * @param array $data The $_POST data sent. 3216 * @param string $screen_id The screen id. 3217 * @return array The Heartbeat response. 3218 */ 3219 public function check_changeset_lock_with_heartbeat( $response, $data, $screen_id ) { 3220 if ( isset( $data['changeset_uuid'] ) ) { 3221 $changeset_post_id = $this->find_changeset_post_id( $data['changeset_uuid'] ); 3222 } else { 3223 $changeset_post_id = $this->changeset_post_id(); 3224 } 3225 3226 if ( 3227 array_key_exists( 'check_changeset_lock', $data ) 3228 && 'customize' === $screen_id 3229 && $changeset_post_id 3230 && current_user_can( get_post_type_object( 'customize_changeset' )->cap->edit_post, $changeset_post_id ) 3231 ) { 3232 $lock_user_id = wp_check_post_lock( $changeset_post_id ); 3233 3234 if ( $lock_user_id ) { 3235 $response['customize_changeset_lock_user'] = $this->get_lock_user_data( $lock_user_id ); 3236 } else { 3237 3238 // Refreshing time will ensure that the user is sitting on customizer and has not closed the customizer tab. 3239 $this->refresh_changeset_lock( $changeset_post_id ); 3240 } 3241 } 3242 3243 return $response; 3244 } 3245 3246 /** 3247 * Removes changeset lock when take over request is sent via Ajax. 3248 * 3249 * @since 4.9.0 3250 */ 3251 public function handle_override_changeset_lock_request() { 3252 if ( ! $this->is_preview() ) { 3253 wp_send_json_error( 'not_preview', 400 ); 3254 } 3255 3256 if ( ! check_ajax_referer( 'customize_override_changeset_lock', 'nonce', false ) ) { 3257 wp_send_json_error( 3258 array( 3259 'code' => 'invalid_nonce', 3260 'message' => __( 'Security check failed.' ), 3261 ) 3262 ); 3263 } 3264 3265 $changeset_post_id = $this->changeset_post_id(); 3266 3267 if ( empty( $changeset_post_id ) ) { 3268 wp_send_json_error( 3269 array( 3270 'code' => 'no_changeset_found_to_take_over', 3271 'message' => __( 'No changeset found to take over' ), 3272 ) 3273 ); 3274 } 3275 3276 if ( ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->edit_post, $changeset_post_id ) ) { 3277 wp_send_json_error( 3278 array( 3279 'code' => 'cannot_remove_changeset_lock', 3280 'message' => __( 'Sorry, you are not allowed to take over.' ), 3281 ) 3282 ); 3283 } 3284 3285 $this->set_changeset_lock( $changeset_post_id, true ); 3286 3287 wp_send_json_success( 'changeset_taken_over' ); 3288 } 3289 3290 /** 3291 * Whether a changeset revision should be made. 3292 * 3293 * @since 4.7.0 3294 * @var bool 3295 */ 3296 protected $store_changeset_revision; 3297 3298 /** 3299 * Filters whether a changeset has changed to create a new revision. 3300 * 3301 * Note that this will not be called while a changeset post remains in auto-draft status. 3302 * 3303 * @since 4.7.0 3304 * 3305 * @param bool $post_has_changed Whether the post has changed. 3306 * @param WP_Post $last_revision The last revision post object. 3307 * @param WP_Post $post The post object. 3308 * 3309 * @return bool Whether a revision should be made. 3310 */ 3311 public function _filter_revision_post_has_changed( $post_has_changed, $last_revision, $post ) { 3312 unset( $last_revision ); 3313 if ( 'customize_changeset' === $post->post_type ) { 3314 $post_has_changed = $this->store_changeset_revision; 3315 } 3316 return $post_has_changed; 3317 } 3318 3319 /** 3320 * Publish changeset values. 3321 * 3322 * This will the values contained in a changeset, even changesets that do not 3323 * correspond to current manager instance. This is called by 3324 * `_wp_customize_publish_changeset()` when a customize_changeset post is 3325 * transitioned to the `publish` status. As such, this method should not be 3326 * called directly and instead `wp_publish_post()` should be used. 3327 * 3328 * Please note that if the settings in the changeset are for a non-activated 3329 * theme, the theme must first be switched to (via `switch_theme()`) before 3330 * invoking this method. 3331 * 3332 * @since 4.7.0 3333 * @see _wp_customize_publish_changeset() 3334 * @global wpdb $wpdb WordPress database abstraction object. 3335 * 3336 * @param int $changeset_post_id ID for customize_changeset post. Defaults to the changeset for the current manager instance. 3337 * @return true|WP_Error True or error info. 3338 */ 3339 public function _publish_changeset_values( $changeset_post_id ) { 3340 global $wpdb; 3341 3342 $publishing_changeset_data = $this->get_changeset_post_data( $changeset_post_id ); 3343 if ( is_wp_error( $publishing_changeset_data ) ) { 3344 return $publishing_changeset_data; 3345 } 3346 3347 $changeset_post = get_post( $changeset_post_id ); 3348 3349 /* 3350 * Temporarily override the changeset context so that it will be read 3351 * in calls to unsanitized_post_values() and so that it will be available 3352 * on the $wp_customize object passed to hooks during the save logic. 3353 */ 3354 $previous_changeset_post_id = $this->_changeset_post_id; 3355 $this->_changeset_post_id = $changeset_post_id; 3356 $previous_changeset_uuid = $this->_changeset_uuid; 3357 $this->_changeset_uuid = $changeset_post->post_name; 3358 $previous_changeset_data = $this->_changeset_data; 3359 $this->_changeset_data = $publishing_changeset_data; 3360 3361 // Parse changeset data to identify theme mod settings and user IDs associated with settings to be saved. 3362 $setting_user_ids = array(); 3363 $theme_mod_settings = array(); 3364 $namespace_pattern = '/^(?P<stylesheet>.+?)::(?P<setting_id>.+)$/'; 3365 $matches = array(); 3366 foreach ( $this->_changeset_data as $raw_setting_id => $setting_params ) { 3367 $actual_setting_id = null; 3368 $is_theme_mod_setting = ( 3369 isset( $setting_params['value'] ) 3370 && 3371 isset( $setting_params['type'] ) 3372 && 3373 'theme_mod' === $setting_params['type'] 3374 && 3375 preg_match( $namespace_pattern, $raw_setting_id, $matches ) 3376 ); 3377 if ( $is_theme_mod_setting ) { 3378 if ( ! isset( $theme_mod_settings[ $matches['stylesheet'] ] ) ) { 3379 $theme_mod_settings[ $matches['stylesheet'] ] = array(); 3380 } 3381 $theme_mod_settings[ $matches['stylesheet'] ][ $matches['setting_id'] ] = $setting_params; 3382 3383 if ( $this->get_stylesheet() === $matches['stylesheet'] ) { 3384 $actual_setting_id = $matches['setting_id']; 3385 } 3386 } else { 3387 $actual_setting_id = $raw_setting_id; 3388 } 3389 3390 // Keep track of the user IDs for settings actually for this theme. 3391 if ( $actual_setting_id && isset( $setting_params['user_id'] ) ) { 3392 $setting_user_ids[ $actual_setting_id ] = $setting_params['user_id']; 3393 } 3394 } 3395 3396 $changeset_setting_values = $this->unsanitized_post_values( 3397 array( 3398 'exclude_post_data' => true, 3399 'exclude_changeset' => false, 3400 ) 3401 ); 3402 $changeset_setting_ids = array_keys( $changeset_setting_values ); 3403 $this->add_dynamic_settings( $changeset_setting_ids ); 3404 3405 /** 3406 * Fires once the theme has switched in the Customizer, but before settings 3407 * have been saved. 3408 * 3409 * @since 3.4.0 3410 * 3411 * @param WP_Customize_Manager $manager WP_Customize_Manager instance. 3412 */ 3413 do_action( 'customize_save', $this ); 3414 3415 /* 3416 * Ensure that all settings will allow themselves to be saved. Note that 3417 * this is safe because the setting would have checked the capability 3418 * when the setting value was written into the changeset. So this is why 3419 * an additional capability check is not required here. 3420 */ 3421 $original_setting_capabilities = array(); 3422 foreach ( $changeset_setting_ids as $setting_id ) { 3423 $setting = $this->get_setting( $setting_id ); 3424 if ( $setting && ! isset( $setting_user_ids[ $setting_id ] ) ) { 3425 $original_setting_capabilities[ $setting->id ] = $setting->capability; 3426 $setting->capability = 'exist'; 3427 } 3428 } 3429 3430 $original_user_id = get_current_user_id(); 3431 foreach ( $changeset_setting_ids as $setting_id ) { 3432 $setting = $this->get_setting( $setting_id ); 3433 if ( $setting ) { 3434 /* 3435 * Set the current user to match the user who saved the value into 3436 * the changeset so that any filters that apply during the save 3437 * process will respect the original user's capabilities. This 3438 * will ensure, for example, that KSES won't strip unsafe HTML 3439 * when a scheduled changeset publishes via WP Cron. 3440 */ 3441 if ( isset( $setting_user_ids[ $setting_id ] ) ) { 3442 wp_set_current_user( $setting_user_ids[ $setting_id ] ); 3443 } else { 3444 wp_set_current_user( $original_user_id ); 3445 } 3446 3447 $setting->save(); 3448 } 3449 } 3450 wp_set_current_user( $original_user_id ); 3451 3452 // Update the stashed theme mod settings, removing the active theme's stashed settings, if activated. 3453 if ( did_action( 'switch_theme' ) ) { 3454 $other_theme_mod_settings = $theme_mod_settings; 3455 unset( $other_theme_mod_settings[ $this->get_stylesheet() ] ); 3456 $this->update_stashed_theme_mod_settings( $other_theme_mod_settings ); 3457 } 3458 3459 /** 3460 * Fires after Customize settings have been saved. 3461 * 3462 * @since 3.6.0 3463 * 3464 * @param WP_Customize_Manager $manager WP_Customize_Manager instance. 3465 */ 3466 do_action( 'customize_save_after', $this ); 3467 3468 // Restore original capabilities. 3469 foreach ( $original_setting_capabilities as $setting_id => $capability ) { 3470 $setting = $this->get_setting( $setting_id ); 3471 if ( $setting ) { 3472 $setting->capability = $capability; 3473 } 3474 } 3475 3476 // Restore original changeset data. 3477 $this->_changeset_data = $previous_changeset_data; 3478 $this->_changeset_post_id = $previous_changeset_post_id; 3479 $this->_changeset_uuid = $previous_changeset_uuid; 3480 3481 /* 3482 * Convert all autosave revisions into their own auto-drafts so that users can be prompted to 3483 * restore them when a changeset is published, but they had been locked out from including 3484 * their changes in the changeset. 3485 */ 3486 $revisions = wp_get_post_revisions( $changeset_post_id, array( 'check_enabled' => false ) ); 3487 foreach ( $revisions as $revision ) { 3488 if ( false !== strpos( $revision->post_name, "{$changeset_post_id}-autosave" ) ) { 3489 $wpdb->update( 3490 $wpdb->posts, 3491 array( 3492 'post_status' => 'auto-draft', 3493 'post_type' => 'customize_changeset', 3494 'post_name' => wp_generate_uuid4(), 3495 'post_parent' => 0, 3496 ), 3497 array( 3498 'ID' => $revision->ID, 3499 ) 3500 ); 3501 clean_post_cache( $revision->ID ); 3502 } 3503 } 3504 3505 return true; 3506 } 3507 3508 /** 3509 * Update stashed theme mod settings. 3510 * 3511 * @since 4.7.0 3512 * 3513 * @param array $inactive_theme_mod_settings Mapping of stylesheet to arrays of theme mod settings. 3514 * @return array|false Returns array of updated stashed theme mods or false if the update failed or there were no changes. 3515 */ 3516 protected function update_stashed_theme_mod_settings( $inactive_theme_mod_settings ) { 3517 $stashed_theme_mod_settings = get_option( 'customize_stashed_theme_mods' ); 3518 if ( empty( $stashed_theme_mod_settings ) ) { 3519 $stashed_theme_mod_settings = array(); 3520 } 3521 3522 // Delete any stashed theme mods for the active theme since they would have been loaded and saved upon activation. 3523 unset( $stashed_theme_mod_settings[ $this->get_stylesheet() ] ); 3524 3525 // Merge inactive theme mods with the stashed theme mod settings. 3526 foreach ( $inactive_theme_mod_settings as $stylesheet => $theme_mod_settings ) { 3527 if ( ! isset( $stashed_theme_mod_settings[ $stylesheet ] ) ) { 3528 $stashed_theme_mod_settings[ $stylesheet ] = array(); 3529 } 3530 3531 $stashed_theme_mod_settings[ $stylesheet ] = array_merge( 3532 $stashed_theme_mod_settings[ $stylesheet ], 3533 $theme_mod_settings 3534 ); 3535 } 3536 3537 $autoload = false; 3538 $result = update_option( 'customize_stashed_theme_mods', $stashed_theme_mod_settings, $autoload ); 3539 if ( ! $result ) { 3540 return false; 3541 } 3542 return $stashed_theme_mod_settings; 3543 } 3544 3545 /** 3546 * Refresh nonces for the current preview. 3547 * 3548 * @since 4.2.0 3549 */ 3550 public function refresh_nonces() { 3551 if ( ! $this->is_preview() ) { 3552 wp_send_json_error( 'not_preview' ); 3553 } 3554 3555 wp_send_json_success( $this->get_nonces() ); 3556 } 3557 3558 /** 3559 * Delete a given auto-draft changeset or the autosave revision for a given changeset or delete changeset lock. 3560 * 3561 * @since 4.9.0 3562 */ 3563 public function handle_dismiss_autosave_or_lock_request() { 3564 // Calls to dismiss_user_auto_draft_changesets() and wp_get_post_autosave() require non-zero get_current_user_id(). 3565 if ( ! is_user_logged_in() ) { 3566 wp_send_json_error( 'unauthenticated', 401 ); 3567 } 3568 3569 if ( ! $this->is_preview() ) { 3570 wp_send_json_error( 'not_preview', 400 ); 3571 } 3572 3573 if ( ! check_ajax_referer( 'customize_dismiss_autosave_or_lock', 'nonce', false ) ) { 3574 wp_send_json_error( 'invalid_nonce', 403 ); 3575 } 3576 3577 $changeset_post_id = $this->changeset_post_id(); 3578 $dismiss_lock = ! empty( $_POST['dismiss_lock'] ); 3579 $dismiss_autosave = ! empty( $_POST['dismiss_autosave'] ); 3580 3581 if ( $dismiss_lock ) { 3582 if ( empty( $changeset_post_id ) && ! $dismiss_autosave ) { 3583 wp_send_json_error( 'no_changeset_to_dismiss_lock', 404 ); 3584 } 3585 if ( ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->edit_post, $changeset_post_id ) && ! $dismiss_autosave ) { 3586 wp_send_json_error( 'cannot_remove_changeset_lock', 403 ); 3587 } 3588 3589 delete_post_meta( $changeset_post_id, '_edit_lock' ); 3590 3591 if ( ! $dismiss_autosave ) { 3592 wp_send_json_success( 'changeset_lock_dismissed' ); 3593 } 3594 } 3595 3596 if ( $dismiss_autosave ) { 3597 if ( empty( $changeset_post_id ) || 'auto-draft' === get_post_status( $changeset_post_id ) ) { 3598 $dismissed = $this->dismiss_user_auto_draft_changesets(); 3599 if ( $dismissed > 0 ) { 3600 wp_send_json_success( 'auto_draft_dismissed' ); 3601 } else { 3602 wp_send_json_error( 'no_auto_draft_to_delete', 404 ); 3603 } 3604 } else { 3605 $revision = wp_get_post_autosave( $changeset_post_id, get_current_user_id() ); 3606 3607 if ( $revision ) { 3608 if ( ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->delete_post, $changeset_post_id ) ) { 3609 wp_send_json_error( 'cannot_delete_autosave_revision', 403 ); 3610 } 3611 3612 if ( ! wp_delete_post( $revision->ID, true ) ) { 3613 wp_send_json_error( 'autosave_revision_deletion_failure', 500 ); 3614 } else { 3615 wp_send_json_success( 'autosave_revision_deleted' ); 3616 } 3617 } else { 3618 wp_send_json_error( 'no_autosave_revision_to_delete', 404 ); 3619 } 3620 } 3621 } 3622 3623 wp_send_json_error( 'unknown_error', 500 ); 3624 } 3625 3626 /** 3627 * Add a customize setting. 3628 * 3629 * @since 3.4.0 3630 * @since 4.5.0 Return added WP_Customize_Setting instance. 3631 * 3632 * @param WP_Customize_Setting|string $id Customize Setting object, or ID. 3633 * @param array $args { 3634 * Optional. Array of properties for the new WP_Customize_Setting. Default empty array. 3635 * 3636 * @type string $type Type of the setting. Default 'theme_mod'. 3637 * @type string $capability Capability required for the setting. Default 'edit_theme_options' 3638 * @type string|array $theme_supports Theme features required to support the panel. Default is none. 3639 * @type string $default Default value for the setting. Default is empty string. 3640 * @type string $transport Options for rendering the live preview of changes in Customizer. 3641 * Using 'refresh' makes the change visible by reloading the whole preview. 3642 * Using 'postMessage' allows a custom JavaScript to handle live changes. 3643 * @link https://developer.wordpress.org/themes/customize-api 3644 * Default is 'refresh' 3645 * @type callable $validate_callback Server-side validation callback for the setting's value. 3646 * @type callable $sanitize_callback Callback to filter a Customize setting value in un-slashed form. 3647 * @type callable $sanitize_js_callback Callback to convert a Customize PHP setting value to a value that is 3648 * JSON serializable. 3649 * @type bool $dirty Whether or not the setting is initially dirty when created. 3650 * } 3651 * @return WP_Customize_Setting The instance of the setting that was added. 3652 */ 3653 public function add_setting( $id, $args = array() ) { 3654 if ( $id instanceof WP_Customize_Setting ) { 3655 $setting = $id; 3656 } else { 3657 $class = 'WP_Customize_Setting'; 3658 3659 /** This filter is documented in wp-includes/class-wp-customize-manager.php */ 3660 $args = apply_filters( 'customize_dynamic_setting_args', $args, $id ); 3661 3662 /** This filter is documented in wp-includes/class-wp-customize-manager.php */ 3663 $class = apply_filters( 'customize_dynamic_setting_class', $class, $id, $args ); 3664 3665 $setting = new $class( $this, $id, $args ); 3666 } 3667 3668 $this->settings[ $setting->id ] = $setting; 3669 return $setting; 3670 } 3671 3672 /** 3673 * Register any dynamically-created settings, such as those from $_POST['customized'] 3674 * that have no corresponding setting created. 3675 * 3676 * This is a mechanism to "wake up" settings that have been dynamically created 3677 * on the front end and have been sent to WordPress in `$_POST['customized']`. When WP 3678 * loads, the dynamically-created settings then will get created and previewed 3679 * even though they are not directly created statically with code. 3680 * 3681 * @since 4.2.0 3682 * 3683 * @param array $setting_ids The setting IDs to add. 3684 * @return array The WP_Customize_Setting objects added. 3685 */ 3686 public function add_dynamic_settings( $setting_ids ) { 3687 $new_settings = array(); 3688 foreach ( $setting_ids as $setting_id ) { 3689 // Skip settings already created 3690 if ( $this->get_setting( $setting_id ) ) { 3691 continue; 3692 } 3693 3694 $setting_args = false; 3695 $setting_class = 'WP_Customize_Setting'; 3696 3697 /** 3698 * Filters a dynamic setting's constructor args. 3699 * 3700 * For a dynamic setting to be registered, this filter must be employed 3701 * to override the default false value with an array of args to pass to 3702 * the WP_Customize_Setting constructor. 3703 * 3704 * @since 4.2.0 3705 * 3706 * @param false|array $setting_args The arguments to the WP_Customize_Setting constructor. 3707 * @param string $setting_id ID for dynamic setting, usually coming from `$_POST['customized']`. 3708 */ 3709 $setting_args = apply_filters( 'customize_dynamic_setting_args', $setting_args, $setting_id ); 3710 if ( false === $setting_args ) { 3711 continue; 3712 } 3713 3714 /** 3715 * Allow non-statically created settings to be constructed with custom WP_Customize_Setting subclass. 3716 * 3717 * @since 4.2.0 3718 * 3719 * @param string $setting_class WP_Customize_Setting or a subclass. 3720 * @param string $setting_id ID for dynamic setting, usually coming from `$_POST['customized']`. 3721 * @param array $setting_args WP_Customize_Setting or a subclass. 3722 */ 3723 $setting_class = apply_filters( 'customize_dynamic_setting_class', $setting_class, $setting_id, $setting_args ); 3724 3725 $setting = new $setting_class( $this, $setting_id, $setting_args ); 3726 3727 $this->add_setting( $setting ); 3728 $new_settings[] = $setting; 3729 } 3730 return $new_settings; 3731 } 3732 3733 /** 3734 * Retrieve a customize setting. 3735 * 3736 * @since 3.4.0 3737 * 3738 * @param string $id Customize Setting ID. 3739 * @return WP_Customize_Setting|void The setting, if set. 3740 */ 3741 public function get_setting( $id ) { 3742 if ( isset( $this->settings[ $id ] ) ) { 3743 return $this->settings[ $id ]; 3744 } 3745 } 3746 3747 /** 3748 * Remove a customize setting. 3749 * 3750 * @since 3.4.0 3751 * 3752 * @param string $id Customize Setting ID. 3753 */ 3754 public function remove_setting( $id ) { 3755 unset( $this->settings[ $id ] ); 3756 } 3757 3758 /** 3759 * Add a customize panel. 3760 * 3761 * @since 4.0.0 3762 * @since 4.5.0 Return added WP_Customize_Panel instance. 3763 * 3764 * @param WP_Customize_Panel|string $id Customize Panel object, or Panel ID. 3765 * @param array $args { 3766 * Optional. Array of properties for the new Panel object. Default empty array. 3767 * @type int $priority Priority of the panel, defining the display order of panels and sections. 3768 * Default 160. 3769 * @type string $capability Capability required for the panel. Default `edit_theme_options` 3770 * @type string|array $theme_supports Theme features required to support the panel. 3771 * @type string $title Title of the panel to show in UI. 3772 * @type string $description Description to show in the UI. 3773 * @type string $type Type of the panel. 3774 * @type callable $active_callback Active callback. 3775 * } 3776 * @return WP_Customize_Panel The instance of the panel that was added. 3777 */ 3778 public function add_panel( $id, $args = array() ) { 3779 if ( $id instanceof WP_Customize_Panel ) { 3780 $panel = $id; 3781 } else { 3782 $panel = new WP_Customize_Panel( $this, $id, $args ); 3783 } 3784 3785 $this->panels[ $panel->id ] = $panel; 3786 return $panel; 3787 } 3788 3789 /** 3790 * Retrieve a customize panel. 3791 * 3792 * @since 4.0.0 3793 * 3794 * @param string $id Panel ID to get. 3795 * @return WP_Customize_Panel|void Requested panel instance, if set. 3796 */ 3797 public function get_panel( $id ) { 3798 if ( isset( $this->panels[ $id ] ) ) { 3799 return $this->panels[ $id ]; 3800 } 3801 } 3802 3803 /** 3804 * Remove a customize panel. 3805 * 3806 * @since 4.0.0 3807 * 3808 * @param string $id Panel ID to remove. 3809 */ 3810 public function remove_panel( $id ) { 3811 // Removing core components this way is _doing_it_wrong(). 3812 if ( in_array( $id, $this->components, true ) ) { 3813 $message = sprintf( 3814 /* translators: 1: Panel ID, 2: Link to 'customize_loaded_components' filter reference. */ 3815 __( 'Removing %1$s manually will cause PHP warnings. Use the %2$s filter instead.' ), 3816 $id, 3817 '<a href="' . esc_url( 'https://developer.wordpress.org/reference/hooks/customize_loaded_components/' ) . '"><code>customize_loaded_components</code></a>' 3818 ); 3819 3820 _doing_it_wrong( __METHOD__, $message, '4.5.0' ); 3821 } 3822 unset( $this->panels[ $id ] ); 3823 } 3824 3825 /** 3826 * Register a customize panel type. 3827 * 3828 * Registered types are eligible to be rendered via JS and created dynamically. 3829 * 3830 * @since 4.3.0 3831 * 3832 * @see WP_Customize_Panel 3833 * 3834 * @param string $panel Name of a custom panel which is a subclass of WP_Customize_Panel. 3835 */ 3836 public function register_panel_type( $panel ) { 3837 $this->registered_panel_types[] = $panel; 3838 } 3839 3840 /** 3841 * Render JS templates for all registered panel types. 3842 * 3843 * @since 4.3.0 3844 */ 3845 public function render_panel_templates() { 3846 foreach ( $this->registered_panel_types as $panel_type ) { 3847 $panel = new $panel_type( $this, 'temp', array() ); 3848 $panel->print_template(); 3849 } 3850 } 3851 3852 /** 3853 * Add a customize section. 3854 * 3855 * @since 3.4.0 3856 * @since 4.5.0 Return added WP_Customize_Section instance. 3857 * 3858 * @param WP_Customize_Section|string $id Customize Section object, or Section ID. 3859 * @param array $args { 3860 * Optional. Array of properties for the new Section object. Default empty array. 3861 * @type int $priority Priority of the section, defining the display order of panels and sections. 3862 * Default 160. 3863 * @type string $panel The panel this section belongs to (if any). Default empty. 3864 * @type string $capability Capability required for the section. Default 'edit_theme_options' 3865 * @type string|array $theme_supports Theme features required to support the section. 3866 * @type string $title Title of the section to show in UI. 3867 * @type string $description Description to show in the UI. 3868 * @type string $type Type of the section. 3869 * @type callable $active_callback Active callback. 3870 * @type bool $description_hidden Hide the description behind a help icon, instead of inline above the first control. Default false. 3871 * } 3872 * @return WP_Customize_Section The instance of the section that was added. 3873 */ 3874 public function add_section( $id, $args = array() ) { 3875 if ( $id instanceof WP_Customize_Section ) { 3876 $section = $id; 3877 } else { 3878 $section = new WP_Customize_Section( $this, $id, $args ); 3879 } 3880 3881 $this->sections[ $section->id ] = $section; 3882 return $section; 3883 } 3884 3885 /** 3886 * Retrieve a customize section. 3887 * 3888 * @since 3.4.0 3889 * 3890 * @param string $id Section ID. 3891 * @return WP_Customize_Section|void The section, if set. 3892 */ 3893 public function get_section( $id ) { 3894 if ( isset( $this->sections[ $id ] ) ) { 3895 return $this->sections[ $id ]; 3896 } 3897 } 3898 3899 /** 3900 * Remove a customize section. 3901 * 3902 * @since 3.4.0 3903 * 3904 * @param string $id Section ID. 3905 */ 3906 public function remove_section( $id ) { 3907 unset( $this->sections[ $id ] ); 3908 } 3909 3910 /** 3911 * Register a customize section type. 3912 * 3913 * Registered types are eligible to be rendered via JS and created dynamically. 3914 * 3915 * @since 4.3.0 3916 * 3917 * @see WP_Customize_Section 3918 * 3919 * @param string $section Name of a custom section which is a subclass of WP_Customize_Section. 3920 */ 3921 public function register_section_type( $section ) { 3922 $this->registered_section_types[] = $section; 3923 } 3924 3925 /** 3926 * Render JS templates for all registered section types. 3927 * 3928 * @since 4.3.0 3929 */ 3930 public function render_section_templates() { 3931 foreach ( $this->registered_section_types as $section_type ) { 3932 $section = new $section_type( $this, 'temp', array() ); 3933 $section->print_template(); 3934 } 3935 } 3936 3937 /** 3938 * Add a customize control. 3939 * 3940 * @since 3.4.0 3941 * @since 4.5.0 Return added WP_Customize_Control instance. 3942 * 3943 * @param WP_Customize_Control|string $id Customize Control object, or ID. 3944 * @param array $args { 3945 * Optional. Array of properties for the new Control object. Default empty array. 3946 * 3947 * @type array $settings All settings tied to the control. If undefined, defaults to `$setting`. 3948 * IDs in the array correspond to the ID of a registered `WP_Customize_Setting`. 3949 * @type string $setting The primary setting for the control (if there is one). Default is 'default'. 3950 * @type string $capability Capability required to use this control. Normally derived from `$settings`. 3951 * @type int $priority Order priority to load the control. Default 10. 3952 * @type string $section The section this control belongs to. Default empty. 3953 * @type string $label Label for the control. Default empty. 3954 * @type string $description Description for the control. Default empty. 3955 * @type array $choices List of choices for 'radio' or 'select' type controls, where values 3956 * are the keys, and labels are the values. Default empty array. 3957 * @type array $input_attrs List of custom input attributes for control output, where attribute 3958 * names are the keys and values are the values. Default empty array. 3959 * @type bool $allow_addition Show UI for adding new content, currently only used for the 3960 * dropdown-pages control. Default false. 3961 * @type string $type The type of the control. Default 'text'. 3962 * @type callback $active_callback Active callback. 3963 * } 3964 * @return WP_Customize_Control The instance of the control that was added. 3965 */ 3966 public function add_control( $id, $args = array() ) { 3967 if ( $id instanceof WP_Customize_Control ) { 3968 $control = $id; 3969 } else { 3970 $control = new WP_Customize_Control( $this, $id, $args ); 3971 } 3972 3973 $this->controls[ $control->id ] = $control; 3974 return $control; 3975 } 3976 3977 /** 3978 * Retrieve a customize control. 3979 * 3980 * @since 3.4.0 3981 * 3982 * @param string $id ID of the control. 3983 * @return WP_Customize_Control|void The control object, if set. 3984 */ 3985 public function get_control( $id ) { 3986 if ( isset( $this->controls[ $id ] ) ) { 3987 return $this->controls[ $id ]; 3988 } 3989 } 3990 3991 /** 3992 * Remove a customize control. 3993 * 3994 * @since 3.4.0 3995 * 3996 * @param string $id ID of the control. 3997 */ 3998 public function remove_control( $id ) { 3999 unset( $this->controls[ $id ] ); 4000 } 4001 4002 /** 4003 * Register a customize control type. 4004 * 4005 * Registered types are eligible to be rendered via JS and created dynamically. 4006 * 4007 * @since 4.1.0 4008 * 4009 * @param string $control Name of a custom control which is a subclass of 4010 * WP_Customize_Control. 4011 */ 4012 public function register_control_type( $control ) { 4013 $this->registered_control_types[] = $control; 4014 } 4015 4016 /** 4017 * Render JS templates for all registered control types. 4018 * 4019 * @since 4.1.0 4020 */ 4021 public function render_control_templates() { 4022 if ( $this->branching() ) { 4023 $l10n = array( 4024 /* translators: %s: User who is customizing the changeset in customizer. */ 4025 'locked' => __( '%s is already customizing this changeset. Please wait until they are done to try customizing. Your latest changes have been autosaved.' ), 4026 /* translators: %s: User who is customizing the changeset in customizer. */ 4027 'locked_allow_override' => __( '%s is already customizing this changeset. Do you want to take over?' ), 4028 ); 4029 } else { 4030 $l10n = array( 4031 /* translators: %s: User who is customizing the changeset in customizer. */ 4032 'locked' => __( '%s is already customizing this site. Please wait until they are done to try customizing. Your latest changes have been autosaved.' ), 4033 /* translators: %s: User who is customizing the changeset in customizer. */ 4034 'locked_allow_override' => __( '%s is already customizing this site. Do you want to take over?' ), 4035 ); 4036 } 4037 4038 foreach ( $this->registered_control_types as $control_type ) { 4039 $control = new $control_type( 4040 $this, 4041 'temp', 4042 array( 4043 'settings' => array(), 4044 ) 4045 ); 4046 $control->print_template(); 4047 } 4048 ?> 4049 4050 <script type="text/html" id="tmpl-customize-control-default-content"> 4051 <# 4052 var inputId = _.uniqueId( 'customize-control-default-input-' ); 4053 var descriptionId = _.uniqueId( 'customize-control-default-description-' ); 4054 var describedByAttr = data.description ? ' aria-describedby="' + descriptionId + '" ' : ''; 4055 #> 4056 <# switch ( data.type ) { 4057 case 'checkbox': #> 4058 <span class="customize-inside-control-row"> 4059 <input 4060 id="{{ inputId }}" 4061 {{{ describedByAttr }}} 4062 type="checkbox" 4063 value="{{ data.value }}" 4064 data-customize-setting-key-link="default" 4065 > 4066 <label for="{{ inputId }}"> 4067 {{ data.label }} 4068 </label> 4069 <# if ( data.description ) { #> 4070 <span id="{{ descriptionId }}" class="description customize-control-description">{{{ data.description }}}</span> 4071 <# } #> 4072 </span> 4073 <# 4074 break; 4075 case 'radio': 4076 if ( ! data.choices ) { 4077 return; 4078 } 4079 #> 4080 <# if ( data.label ) { #> 4081 <label for="{{ inputId }}" class="customize-control-title"> 4082 {{ data.label }} 4083 </label> 4084 <# } #> 4085 <# if ( data.description ) { #> 4086 <span id="{{ descriptionId }}" class="description customize-control-description">{{{ data.description }}}</span> 4087 <# } #> 4088 <# _.each( data.choices, function( val, key ) { #> 4089 <span class="customize-inside-control-row"> 4090 <# 4091 var value, text; 4092 if ( _.isObject( val ) ) { 4093 value = val.value; 4094 text = val.text; 4095 } else { 4096 value = key; 4097 text = val; 4098 } 4099 #> 4100 <input 4101 id="{{ inputId + '-' + value }}" 4102 type="radio" 4103 value="{{ value }}" 4104 name="{{ inputId }}" 4105 data-customize-setting-key-link="default" 4106 {{{ describedByAttr }}} 4107 > 4108 <label for="{{ inputId + '-' + value }}">{{ text }}</label> 4109 </span> 4110 <# } ); #> 4111 <# 4112 break; 4113 default: 4114 #> 4115 <# if ( data.label ) { #> 4116 <label for="{{ inputId }}" class="customize-control-title"> 4117 {{ data.label }} 4118 </label> 4119 <# } #> 4120 <# if ( data.description ) { #> 4121 <span id="{{ descriptionId }}" class="description customize-control-description">{{{ data.description }}}</span> 4122 <# } #> 4123 4124 <# 4125 var inputAttrs = { 4126 id: inputId, 4127 'data-customize-setting-key-link': 'default' 4128 }; 4129 if ( 'textarea' === data.type ) { 4130 inputAttrs.rows = '5'; 4131 } else if ( 'button' === data.type ) { 4132 inputAttrs['class'] = 'button button-secondary'; 4133 inputAttrs.type = 'button'; 4134 } else { 4135 inputAttrs.type = data.type; 4136 } 4137 if ( data.description ) { 4138 inputAttrs['aria-describedby'] = descriptionId; 4139 } 4140 _.extend( inputAttrs, data.input_attrs ); 4141 #> 4142 4143 <# if ( 'button' === data.type ) { #> 4144 <button 4145 <# _.each( _.extend( inputAttrs ), function( value, key ) { #> 4146 {{{ key }}}="{{ value }}" 4147 <# } ); #> 4148 >{{ inputAttrs.value }}</button> 4149 <# } else if ( 'textarea' === data.type ) { #> 4150 <textarea 4151 <# _.each( _.extend( inputAttrs ), function( value, key ) { #> 4152 {{{ key }}}="{{ value }}" 4153 <# }); #> 4154 >{{ inputAttrs.value }}</textarea> 4155 <# } else if ( 'select' === data.type ) { #> 4156 <# delete inputAttrs.type; #> 4157 <select 4158 <# _.each( _.extend( inputAttrs ), function( value, key ) { #> 4159 {{{ key }}}="{{ value }}" 4160 <# }); #> 4161 > 4162 <# _.each( data.choices, function( val, key ) { #> 4163 <# 4164 var value, text; 4165 if ( _.isObject( val ) ) { 4166 value = val.value; 4167 text = val.text; 4168 } else { 4169 value = key; 4170 text = val; 4171 } 4172 #> 4173 <option value="{{ value }}">{{ text }}</option> 4174 <# } ); #> 4175 </select> 4176 <# } else { #> 4177 <input 4178 <# _.each( _.extend( inputAttrs ), function( value, key ) { #> 4179 {{{ key }}}="{{ value }}" 4180 <# }); #> 4181 > 4182 <# } #> 4183 <# } #> 4184 </script> 4185 4186 <script type="text/html" id="tmpl-customize-notification"> 4187 <li class="notice notice-{{ data.type || 'info' }} {{ data.alt ? 'notice-alt' : '' }} {{ data.dismissible ? 'is-dismissible' : '' }} {{ data.containerClasses || '' }}" data-code="{{ data.code }}" data-type="{{ data.type }}"> 4188 <div class="notification-message">{{{ data.message || data.code }}}</div> 4189 <# if ( data.dismissible ) { #> 4190 <button type="button" class="notice-dismiss"><span class="screen-reader-text"><?php _e( 'Dismiss' ); ?></span></button> 4191 <# } #> 4192 </li> 4193 </script> 4194 4195 <script type="text/html" id="tmpl-customize-changeset-locked-notification"> 4196 <li class="notice notice-{{ data.type || 'info' }} {{ data.containerClasses || '' }}" data-code="{{ data.code }}" data-type="{{ data.type }}"> 4197 <div class="notification-message customize-changeset-locked-message"> 4198 <img class="customize-changeset-locked-avatar" src="{{ data.lockUser.avatar }}" alt="{{ data.lockUser.name }}"> 4199 <p class="currently-editing"> 4200 <# if ( data.message ) { #> 4201 {{{ data.message }}} 4202 <# } else if ( data.allowOverride ) { #> 4203 <?php 4204 echo esc_html( sprintf( $l10n['locked_allow_override'], '{{ data.lockUser.name }}' ) ); 4205 ?> 4206 <# } else { #> 4207 <?php 4208 echo esc_html( sprintf( $l10n['locked'], '{{ data.lockUser.name }}' ) ); 4209 ?> 4210 <# } #> 4211 </p> 4212 <p class="notice notice-error notice-alt" hidden></p> 4213 <p class="action-buttons"> 4214 <# if ( data.returnUrl !== data.previewUrl ) { #> 4215 <a class="button customize-notice-go-back-button" href="{{ data.returnUrl }}"><?php _e( 'Go back' ); ?></a> 4216 <# } #> 4217 <a class="button customize-notice-preview-button" href="{{ data.frontendPreviewUrl }}"><?php _e( 'Preview' ); ?></a> 4218 <# if ( data.allowOverride ) { #> 4219 <button class="button button-primary wp-tab-last customize-notice-take-over-button"><?php _e( 'Take over' ); ?></button> 4220 <# } #> 4221 </p> 4222 </div> 4223 </li> 4224 </script> 4225 4226 <script type="text/html" id="tmpl-customize-code-editor-lint-error-notification"> 4227 <li class="notice notice-{{ data.type || 'info' }} {{ data.alt ? 'notice-alt' : '' }} {{ data.dismissible ? 'is-dismissible' : '' }} {{ data.containerClasses || '' }}" data-code="{{ data.code }}" data-type="{{ data.type }}"> 4228 <div class="notification-message">{{{ data.message || data.code }}}</div> 4229 4230 <p> 4231 <# var elementId = 'el-' + String( Math.random() ); #> 4232 <input id="{{ elementId }}" type="checkbox"> 4233 <label for="{{ elementId }}"><?php _e( 'Update anyway, even though it might break your site?' ); ?></label> 4234 </p> 4235 </li> 4236 </script> 4237 4238 <?php 4239 /* The following template is obsolete in core but retained for plugins. */ 4240 ?> 4241 <script type="text/html" id="tmpl-customize-control-notifications"> 4242 <ul> 4243 <# _.each( data.notifications, function( notification ) { #> 4244 <li class="notice notice-{{ notification.type || 'info' }} {{ data.altNotice ? 'notice-alt' : '' }}" data-code="{{ notification.code }}" data-type="{{ notification.type }}">{{{ notification.message || notification.code }}}</li> 4245 <# } ); #> 4246 </ul> 4247 </script> 4248 4249 <script type="text/html" id="tmpl-customize-preview-link-control" > 4250 <# var elementPrefix = _.uniqueId( 'el' ) + '-' #> 4251 <p class="customize-control-title"> 4252 <?php esc_html_e( 'Share Preview Link' ); ?> 4253 </p> 4254 <p class="description customize-control-description"><?php esc_html_e( 'See how changes would look live on your website, and share the preview with people who can\'t access the Customizer.' ); ?></p> 4255 <div class="customize-control-notifications-container"></div> 4256 <div class="preview-link-wrapper"> 4257 <label for="{{ elementPrefix }}customize-preview-link-input" class="screen-reader-text"><?php esc_html_e( 'Preview Link' ); ?></label> 4258 <a href="" target=""> 4259 <span class="preview-control-element" data-component="url"></span> 4260 <span class="screen-reader-text"><?php _e( '(opens in a new tab)' ); ?></span> 4261 </a> 4262 <input id="{{ elementPrefix }}customize-preview-link-input" readonly tabindex="-1" class="preview-control-element" data-component="input"> 4263 <button class="customize-copy-preview-link preview-control-element button button-secondary" data-component="button" data-copy-text="<?php esc_attr_e( 'Copy' ); ?>" data-copied-text="<?php esc_attr_e( 'Copied' ); ?>" ><?php esc_html_e( 'Copy' ); ?></button> 4264 </div> 4265 </script> 4266 <script type="text/html" id="tmpl-customize-selected-changeset-status-control"> 4267 <# var inputId = _.uniqueId( 'customize-selected-changeset-status-control-input-' ); #> 4268 <# var descriptionId = _.uniqueId( 'customize-selected-changeset-status-control-description-' ); #> 4269 <# if ( data.label ) { #> 4270 <label for="{{ inputId }}" class="customize-control-title">{{ data.label }}</label> 4271 <# } #> 4272 <# if ( data.description ) { #> 4273 <span id="{{ descriptionId }}" class="description customize-control-description">{{{ data.description }}}</span> 4274 <# } #> 4275 <# _.each( data.choices, function( choice ) { #> 4276 <# var choiceId = inputId + '-' + choice.status; #> 4277 <span class="customize-inside-control-row"> 4278 <input id="{{ choiceId }}" type="radio" value="{{ choice.status }}" name="{{ inputId }}" data-customize-setting-key-link="default"> 4279 <label for="{{ choiceId }}">{{ choice.label }}</label> 4280 </span> 4281 <# } ); #> 4282 </script> 4283 <?php 4284 } 4285 4286 /** 4287 * Helper function to compare two objects by priority, ensuring sort stability via instance_number. 4288 * 4289 * @since 3.4.0 4290 * @deprecated 4.7.0 Use wp_list_sort() 4291 * 4292 * @param WP_Customize_Panel|WP_Customize_Section|WP_Customize_Control $a Object A. 4293 * @param WP_Customize_Panel|WP_Customize_Section|WP_Customize_Control $b Object B. 4294 * @return int 4295 */ 4296 protected function _cmp_priority( $a, $b ) { 4297 _deprecated_function( __METHOD__, '4.7.0', 'wp_list_sort' ); 4298 4299 if ( $a->priority === $b->priority ) { 4300 return $a->instance_number - $b->instance_number; 4301 } else { 4302 return $a->priority - $b->priority; 4303 } 4304 } 4305 4306 /** 4307 * Prepare panels, sections, and controls. 4308 * 4309 * For each, check if required related components exist, 4310 * whether the user has the necessary capabilities, 4311 * and sort by priority. 4312 * 4313 * @since 3.4.0 4314 */ 4315 public function prepare_controls() { 4316 4317 $controls = array(); 4318 $this->controls = wp_list_sort( 4319 $this->controls, 4320 array( 4321 'priority' => 'ASC', 4322 'instance_number' => 'ASC', 4323 ), 4324 'ASC', 4325 true 4326 ); 4327 4328 foreach ( $this->controls as $id => $control ) { 4329 if ( ! isset( $this->sections[ $control->section ] ) || ! $control->check_capabilities() ) { 4330 continue; 4331 } 4332 4333 $this->sections[ $control->section ]->controls[] = $control; 4334 $controls[ $id ] = $control; 4335 } 4336 $this->controls = $controls; 4337 4338 // Prepare sections. 4339 $this->sections = wp_list_sort( 4340 $this->sections, 4341 array( 4342 'priority' => 'ASC', 4343 'instance_number' => 'ASC', 4344 ), 4345 'ASC', 4346 true 4347 ); 4348 $sections = array(); 4349 4350 foreach ( $this->sections as $section ) { 4351 if ( ! $section->check_capabilities() ) { 4352 continue; 4353 } 4354 4355 $section->controls = wp_list_sort( 4356 $section->controls, 4357 array( 4358 'priority' => 'ASC', 4359 'instance_number' => 'ASC', 4360 ) 4361 ); 4362 4363 if ( ! $section->panel ) { 4364 // Top-level section. 4365 $sections[ $section->id ] = $section; 4366 } else { 4367 // This section belongs to a panel. 4368 if ( isset( $this->panels [ $section->panel ] ) ) { 4369 $this->panels[ $section->panel ]->sections[ $section->id ] = $section; 4370 } 4371 } 4372 } 4373 $this->sections = $sections; 4374 4375 // Prepare panels. 4376 $this->panels = wp_list_sort( 4377 $this->panels, 4378 array( 4379 'priority' => 'ASC', 4380 'instance_number' => 'ASC', 4381 ), 4382 'ASC', 4383 true 4384 ); 4385 $panels = array(); 4386 4387 foreach ( $this->panels as $panel ) { 4388 if ( ! $panel->check_capabilities() ) { 4389 continue; 4390 } 4391 4392 $panel->sections = wp_list_sort( 4393 $panel->sections, 4394 array( 4395 'priority' => 'ASC', 4396 'instance_number' => 'ASC', 4397 ), 4398 'ASC', 4399 true 4400 ); 4401 $panels[ $panel->id ] = $panel; 4402 } 4403 $this->panels = $panels; 4404 4405 // Sort panels and top-level sections together. 4406 $this->containers = array_merge( $this->panels, $this->sections ); 4407 $this->containers = wp_list_sort( 4408 $this->containers, 4409 array( 4410 'priority' => 'ASC', 4411 'instance_number' => 'ASC', 4412 ), 4413 'ASC', 4414 true 4415 ); 4416 } 4417 4418 /** 4419 * Enqueue scripts for customize controls. 4420 * 4421 * @since 3.4.0 4422 */ 4423 public function enqueue_control_scripts() { 4424 foreach ( $this->controls as $control ) { 4425 $control->enqueue(); 4426 } 4427 4428 if ( ! is_multisite() && ( current_user_can( 'install_themes' ) || current_user_can( 'update_themes' ) || current_user_can( 'delete_themes' ) ) ) { 4429 wp_enqueue_script( 'updates' ); 4430 wp_localize_script( 4431 'updates', 4432 '_wpUpdatesItemCounts', 4433 array( 4434 'totals' => wp_get_update_data(), 4435 ) 4436 ); 4437 } 4438 } 4439 4440 /** 4441 * Determine whether the user agent is iOS. 4442 * 4443 * @since 4.4.0 4444 * 4445 * @return bool Whether the user agent is iOS. 4446 */ 4447 public function is_ios() { 4448 return wp_is_mobile() && preg_match( '/iPad|iPod|iPhone/', $_SERVER['HTTP_USER_AGENT'] ); 4449 } 4450 4451 /** 4452 * Get the template string for the Customizer pane document title. 4453 * 4454 * @since 4.4.0 4455 * 4456 * @return string The template string for the document title. 4457 */ 4458 public function get_document_title_template() { 4459 if ( $this->is_theme_active() ) { 4460 /* translators: %s: Document title from the preview. */ 4461 $document_title_tmpl = __( 'Customize: %s' ); 4462 } else { 4463 /* translators: %s: Document title from the preview. */ 4464 $document_title_tmpl = __( 'Live Preview: %s' ); 4465 } 4466 $document_title_tmpl = html_entity_decode( $document_title_tmpl, ENT_QUOTES, 'UTF-8' ); // Because exported to JS and assigned to document.title. 4467 return $document_title_tmpl; 4468 } 4469 4470 /** 4471 * Set the initial URL to be previewed. 4472 * 4473 * URL is validated. 4474 * 4475 * @since 4.4.0 4476 * 4477 * @param string $preview_url URL to be previewed. 4478 */ 4479 public function set_preview_url( $preview_url ) { 4480 $preview_url = esc_url_raw( $preview_url ); 4481 $this->preview_url = wp_validate_redirect( $preview_url, home_url( '/' ) ); 4482 } 4483 4484 /** 4485 * Get the initial URL to be previewed. 4486 * 4487 * @since 4.4.0 4488 * 4489 * @return string URL being previewed. 4490 */ 4491 public function get_preview_url() { 4492 if ( empty( $this->preview_url ) ) { 4493 $preview_url = home_url( '/' ); 4494 } else { 4495 $preview_url = $this->preview_url; 4496 } 4497 return $preview_url; 4498 } 4499 4500 /** 4501 * Determines whether the admin and the frontend are on different domains. 4502 * 4503 * @since 4.7.0 4504 * 4505 * @return bool Whether cross-domain. 4506 */ 4507 public function is_cross_domain() { 4508 $admin_origin = wp_parse_url( admin_url() ); 4509 $home_origin = wp_parse_url( home_url() ); 4510 $cross_domain = ( strtolower( $admin_origin['host'] ) !== strtolower( $home_origin['host'] ) ); 4511 return $cross_domain; 4512 } 4513 4514 /** 4515 * Get URLs allowed to be previewed. 4516 * 4517 * If the front end and the admin are served from the same domain, load the 4518 * preview over ssl if the Customizer is being loaded over ssl. This avoids 4519 * insecure content warnings. This is not attempted if the admin and front end 4520 * are on different domains to avoid the case where the front end doesn't have 4521 * ssl certs. Domain mapping plugins can allow other urls in these conditions 4522 * using the customize_allowed_urls filter. 4523 * 4524 * @since 4.7.0 4525 * 4526 * @returns array Allowed URLs. 4527 */ 4528 public function get_allowed_urls() { 4529 $allowed_urls = array( home_url( '/' ) ); 4530 4531 if ( is_ssl() && ! $this->is_cross_domain() ) { 4532 $allowed_urls[] = home_url( '/', 'https' ); 4533 } 4534 4535 /** 4536 * Filters the list of URLs allowed to be clicked and followed in the Customizer preview. 4537 * 4538 * @since 3.4.0 4539 * 4540 * @param string[] $allowed_urls An array of allowed URLs. 4541 */ 4542 $allowed_urls = array_unique( apply_filters( 'customize_allowed_urls', $allowed_urls ) ); 4543 4544 return $allowed_urls; 4545 } 4546 4547 /** 4548 * Get messenger channel. 4549 * 4550 * @since 4.7.0 4551 * 4552 * @return string Messenger channel. 4553 */ 4554 public function get_messenger_channel() { 4555 return $this->messenger_channel; 4556 } 4557 4558 /** 4559 * Set URL to link the user to when closing the Customizer. 4560 * 4561 * URL is validated. 4562 * 4563 * @since 4.4.0 4564 * 4565 * @param string $return_url URL for return link. 4566 */ 4567 public function set_return_url( $return_url ) { 4568 $return_url = esc_url_raw( $return_url ); 4569 $return_url = remove_query_arg( wp_removable_query_args(), $return_url ); 4570 $return_url = wp_validate_redirect( $return_url ); 4571 $this->return_url = $return_url; 4572 } 4573 4574 /** 4575 * Get URL to link the user to when closing the Customizer. 4576 * 4577 * @since 4.4.0 4578 * 4579 * @return string URL for link to close Customizer. 4580 */ 4581 public function get_return_url() { 4582 $referer = wp_get_referer(); 4583 $excluded_referer_basenames = array( 'customize.php', 'wp-login.php' ); 4584 4585 if ( $this->return_url ) { 4586 $return_url = $this->return_url; 4587 } elseif ( $referer && ! in_array( wp_basename( parse_url( $referer, PHP_URL_PATH ) ), $excluded_referer_basenames, true ) ) { 4588 $return_url = $referer; 4589 } elseif ( $this->preview_url ) { 4590 $return_url = $this->preview_url; 4591 } else { 4592 $return_url = home_url( '/' ); 4593 } 4594 return $return_url; 4595 } 4596 4597 /** 4598 * Set the autofocused constructs. 4599 * 4600 * @since 4.4.0 4601 * 4602 * @param array $autofocus { 4603 * Mapping of 'panel', 'section', 'control' to the ID which should be autofocused. 4604 * 4605 * @type string [$control] ID for control to be autofocused. 4606 * @type string [$section] ID for section to be autofocused. 4607 * @type string [$panel] ID for panel to be autofocused. 4608 * } 4609 */ 4610 public function set_autofocus( $autofocus ) { 4611 $this->autofocus = array_filter( wp_array_slice_assoc( $autofocus, array( 'panel', 'section', 'control' ) ), 'is_string' ); 4612 } 4613 4614 /** 4615 * Get the autofocused constructs. 4616 * 4617 * @since 4.4.0 4618 * 4619 * @return array { 4620 * Mapping of 'panel', 'section', 'control' to the ID which should be autofocused. 4621 * 4622 * @type string [$control] ID for control to be autofocused. 4623 * @type string [$section] ID for section to be autofocused. 4624 * @type string [$panel] ID for panel to be autofocused. 4625 * } 4626 */ 4627 public function get_autofocus() { 4628 return $this->autofocus; 4629 } 4630 4631 /** 4632 * Get nonces for the Customizer. 4633 * 4634 * @since 4.5.0 4635 * 4636 * @return array Nonces. 4637 */ 4638 public function get_nonces() { 4639 $nonces = array( 4640 'save' => wp_create_nonce( 'save-customize_' . $this->get_stylesheet() ), 4641 'preview' => wp_create_nonce( 'preview-customize_' . $this->get_stylesheet() ), 4642 'switch_themes' => wp_create_nonce( 'switch_themes' ), 4643 'dismiss_autosave_or_lock' => wp_create_nonce( 'customize_dismiss_autosave_or_lock' ), 4644 'override_lock' => wp_create_nonce( 'customize_override_changeset_lock' ), 4645 'trash' => wp_create_nonce( 'trash_customize_changeset' ), 4646 ); 4647 4648 /** 4649 * Filters nonces for Customizer. 4650 * 4651 * @since 4.2.0 4652 * 4653 * @param string[] $nonces Array of refreshed nonces for save and 4654 * preview actions. 4655 * @param WP_Customize_Manager $this WP_Customize_Manager instance. 4656 */ 4657 $nonces = apply_filters( 'customize_refresh_nonces', $nonces, $this ); 4658 4659 return $nonces; 4660 } 4661 4662 /** 4663 * Print JavaScript settings for parent window. 4664 * 4665 * @since 4.4.0 4666 */ 4667 public function customize_pane_settings() { 4668 4669 $login_url = add_query_arg( 4670 array( 4671 'interim-login' => 1, 4672 'customize-login' => 1, 4673 ), 4674 wp_login_url() 4675 ); 4676 4677 // Ensure dirty flags are set for modified settings. 4678 foreach ( array_keys( $this->unsanitized_post_values() ) as $setting_id ) { 4679 $setting = $this->get_setting( $setting_id ); 4680 if ( $setting ) { 4681 $setting->dirty = true; 4682 } 4683 } 4684 4685 $autosave_revision_post = null; 4686 $autosave_autodraft_post = null; 4687 $changeset_post_id = $this->changeset_post_id(); 4688 if ( ! $this->saved_starter_content_changeset && ! $this->autosaved() ) { 4689 if ( $changeset_post_id ) { 4690 if ( is_user_logged_in() ) { 4691 $autosave_revision_post = wp_get_post_autosave( $changeset_post_id, get_current_user_id() ); 4692 } 4693 } else { 4694 $autosave_autodraft_posts = $this->get_changeset_posts( 4695 array( 4696 'posts_per_page' => 1, 4697 'post_status' => 'auto-draft', 4698 'exclude_restore_dismissed' => true, 4699 ) 4700 ); 4701 if ( ! empty( $autosave_autodraft_posts ) ) { 4702 $autosave_autodraft_post = array_shift( $autosave_autodraft_posts ); 4703 } 4704 } 4705