[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> class-wp-customize-manager.php (source)

   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 string[]
 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,
 274          // but they are also looked at in the $_REQUEST global here for back-compat.
 275          if ( ! isset( $args['theme'] ) ) {
 276              if ( isset( $_REQUEST['customize_theme'] ) ) {
 277                  $args['theme'] = wp_unslash( $_REQUEST['customize_theme'] );
 278              } elseif ( isset( $_REQUEST['theme'] ) ) { // Deprecated.
 279                  $args['theme'] = wp_unslash( $_REQUEST['theme'] );
 280              }
 281          }
 282          if ( ! isset( $args['messenger_channel'] ) && isset( $_REQUEST['customize_messenger_channel'] ) ) {
 283              $args['messenger_channel'] = sanitize_key( wp_unslash( $_REQUEST['customize_messenger_channel'] ) );
 284          }
 285  
 286          $this->original_stylesheet = get_stylesheet();
 287          $this->theme               = wp_get_theme( 0 === validate_file( $args['theme'] ) ? $args['theme'] : null );
 288          $this->messenger_channel   = $args['messenger_channel'];
 289          $this->_changeset_uuid     = $args['changeset_uuid'];
 290  
 291          foreach ( array( 'settings_previewed', 'autosaved', 'branching' ) as $key ) {
 292              if ( isset( $args[ $key ] ) ) {
 293                  $this->$key = (bool) $args[ $key ];
 294              }
 295          }
 296  
 297          require_once  ABSPATH . WPINC . '/class-wp-customize-setting.php';
 298          require_once  ABSPATH . WPINC . '/class-wp-customize-panel.php';
 299          require_once  ABSPATH . WPINC . '/class-wp-customize-section.php';
 300          require_once  ABSPATH . WPINC . '/class-wp-customize-control.php';
 301  
 302          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-color-control.php';
 303          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-media-control.php';
 304          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-upload-control.php';
 305          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-image-control.php';
 306          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-background-image-control.php';
 307          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-background-position-control.php';
 308          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-cropped-image-control.php';
 309          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-site-icon-control.php';
 310          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-header-image-control.php';
 311          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-theme-control.php';
 312          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-code-editor-control.php';
 313          require_once  ABSPATH . WPINC . '/customize/class-wp-widget-area-customize-control.php';
 314          require_once  ABSPATH . WPINC . '/customize/class-wp-widget-form-customize-control.php';
 315          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-control.php';
 316          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-control.php';
 317          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-location-control.php';
 318          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-name-control.php';
 319          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-locations-control.php';
 320          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-auto-add-control.php';
 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  
 329          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-custom-css-setting.php';
 330          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-filter-setting.php';
 331          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-header-image-setting.php';
 332          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-background-image-setting.php';
 333          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-setting.php';
 334          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-setting.php';
 335  
 336          /**
 337           * Filters the core Customizer components to load.
 338           *
 339           * This allows Core components to be excluded from being instantiated by
 340           * filtering them out of the array. Note that this filter generally runs
 341           * during the {@see 'plugins_loaded'} action, so it cannot be added
 342           * in a theme.
 343           *
 344           * @since 4.4.0
 345           *
 346           * @see WP_Customize_Manager::__construct()
 347           *
 348           * @param string[]             $components Array of core components to load.
 349           * @param WP_Customize_Manager $manager    WP_Customize_Manager instance.
 350           */
 351          $components = apply_filters( 'customize_loaded_components', $this->components, $this );
 352  
 353          require_once  ABSPATH . WPINC . '/customize/class-wp-customize-selective-refresh.php';
 354          $this->selective_refresh = new WP_Customize_Selective_Refresh( $this );
 355  
 356          if ( in_array( 'widgets', $components, true ) ) {
 357              require_once  ABSPATH . WPINC . '/class-wp-customize-widgets.php';
 358              $this->widgets = new WP_Customize_Widgets( $this );
 359          }
 360  
 361          if ( in_array( 'nav_menus', $components, true ) ) {
 362              require_once  ABSPATH . WPINC . '/class-wp-customize-nav-menus.php';
 363              $this->nav_menus = new WP_Customize_Nav_Menus( $this );
 364          }
 365  
 366          add_action( 'setup_theme', array( $this, 'setup_theme' ) );
 367          add_action( 'wp_loaded', array( $this, 'wp_loaded' ) );
 368  
 369          // Do not spawn cron (especially the alternate cron) while running the Customizer.
 370          remove_action( 'init', 'wp_cron' );
 371  
 372          // Do not run update checks when rendering the controls.
 373          remove_action( 'admin_init', '_maybe_update_core' );
 374          remove_action( 'admin_init', '_maybe_update_plugins' );
 375          remove_action( 'admin_init', '_maybe_update_themes' );
 376  
 377          add_action( 'wp_ajax_customize_save', array( $this, 'save' ) );
 378          add_action( 'wp_ajax_customize_trash', array( $this, 'handle_changeset_trash_request' ) );
 379          add_action( 'wp_ajax_customize_refresh_nonces', array( $this, 'refresh_nonces' ) );
 380          add_action( 'wp_ajax_customize_load_themes', array( $this, 'handle_load_themes_request' ) );
 381          add_filter( 'heartbeat_settings', array( $this, 'add_customize_screen_to_heartbeat_settings' ) );
 382          add_filter( 'heartbeat_received', array( $this, 'check_changeset_lock_with_heartbeat' ), 10, 3 );
 383          add_action( 'wp_ajax_customize_override_changeset_lock', array( $this, 'handle_override_changeset_lock_request' ) );
 384          add_action( 'wp_ajax_customize_dismiss_autosave_or_lock', array( $this, 'handle_dismiss_autosave_or_lock_request' ) );
 385  
 386          add_action( 'customize_register', array( $this, 'register_controls' ) );
 387          add_action( 'customize_register', array( $this, 'register_dynamic_settings' ), 11 ); // Allow code to create settings first.
 388          add_action( 'customize_controls_init', array( $this, 'prepare_controls' ) );
 389          add_action( 'customize_controls_enqueue_scripts', array( $this, 'enqueue_control_scripts' ) );
 390  
 391          // Render Common, Panel, Section, and Control templates.
 392          add_action( 'customize_controls_print_footer_scripts', array( $this, 'render_panel_templates' ), 1 );
 393          add_action( 'customize_controls_print_footer_scripts', array( $this, 'render_section_templates' ), 1 );
 394          add_action( 'customize_controls_print_footer_scripts', array( $this, 'render_control_templates' ), 1 );
 395  
 396          // Export header video settings with the partial response.
 397          add_filter( 'customize_render_partials_response', array( $this, 'export_header_video_settings' ), 10, 3 );
 398  
 399          // Export the settings to JS via the _wpCustomizeSettings variable.
 400          add_action( 'customize_controls_print_footer_scripts', array( $this, 'customize_pane_settings' ), 1000 );
 401  
 402          // Add theme update notices.
 403          if ( current_user_can( 'install_themes' ) || current_user_can( 'update_themes' ) ) {
 404              require_once ABSPATH . 'wp-admin/includes/update.php';
 405              add_action( 'customize_controls_print_footer_scripts', 'wp_print_admin_notice_templates' );
 406          }
 407      }
 408  
 409      /**
 410       * Returns true if it's an Ajax request.
 411       *
 412       * @since 3.4.0
 413       * @since 4.2.0 Added `$action` param.
 414       *
 415       * @param string|null $action Whether the supplied Ajax action is being run.
 416       * @return bool True if it's an Ajax request, false otherwise.
 417       */
 418  	public function doing_ajax( $action = null ) {
 419          if ( ! wp_doing_ajax() ) {
 420              return false;
 421          }
 422  
 423          if ( ! $action ) {
 424              return true;
 425          } else {
 426              /*
 427               * Note: we can't just use doing_action( "wp_ajax_{$action}" ) because we need
 428               * to check before admin-ajax.php gets to that point.
 429               */
 430              return isset( $_REQUEST['action'] ) && wp_unslash( $_REQUEST['action'] ) === $action;
 431          }
 432      }
 433  
 434      /**
 435       * Custom wp_die wrapper. Returns either the standard message for UI
 436       * or the Ajax message.
 437       *
 438       * @since 3.4.0
 439       *
 440       * @param string|WP_Error $ajax_message Ajax return.
 441       * @param string          $message      Optional. UI message.
 442       */
 443  	protected function wp_die( $ajax_message, $message = null ) {
 444          if ( $this->doing_ajax() ) {
 445              wp_die( $ajax_message );
 446          }
 447  
 448          if ( ! $message ) {
 449              $message = __( 'Something went wrong.' );
 450          }
 451  
 452          if ( $this->messenger_channel ) {
 453              ob_start();
 454              wp_enqueue_scripts();
 455              wp_print_scripts( array( 'customize-base' ) );
 456  
 457              $settings = array(
 458                  'messengerArgs' => array(
 459                      'channel' => $this->messenger_channel,
 460                      'url'     => wp_customize_url(),
 461                  ),
 462                  'error'         => $ajax_message,
 463              );
 464              ?>
 465              <script>
 466              ( function( api, settings ) {
 467                  var preview = new api.Messenger( settings.messengerArgs );
 468                  preview.send( 'iframe-loading-error', settings.error );
 469              } )( wp.customize, <?php echo wp_json_encode( $settings ); ?> );
 470              </script>
 471              <?php
 472              $message .= ob_get_clean();
 473          }
 474  
 475          wp_die( $message );
 476      }
 477  
 478      /**
 479       * Returns the Ajax wp_die() handler if it's a customized request.
 480       *
 481       * @since 3.4.0
 482       * @deprecated 4.7.0
 483       *
 484       * @return callable Die handler.
 485       */
 486  	public function wp_die_handler() {
 487          _deprecated_function( __METHOD__, '4.7.0' );
 488  
 489          if ( $this->doing_ajax() || isset( $_POST['customized'] ) ) {
 490              return '_ajax_wp_die_handler';
 491          }
 492  
 493          return '_default_wp_die_handler';
 494      }
 495  
 496      /**
 497       * Starts preview and customize theme.
 498       *
 499       * Check if customize query variable exist. Init filters to filter the active theme.
 500       *
 501       * @since 3.4.0
 502       *
 503       * @global string $pagenow The filename of the current screen.
 504       */
 505  	public function setup_theme() {
 506          global $pagenow;
 507  
 508          // Check permissions for customize.php access since this method is called before customize.php can run any code.
 509          if ( 'customize.php' === $pagenow && ! current_user_can( 'customize' ) ) {
 510              if ( ! is_user_logged_in() ) {
 511                  auth_redirect();
 512              } else {
 513                  wp_die(
 514                      '<h1>' . __( 'You need a higher level of permission.' ) . '</h1>' .
 515                      '<p>' . __( 'Sorry, you are not allowed to customize this site.' ) . '</p>',
 516                      403
 517                  );
 518              }
 519              return;
 520          }
 521  
 522          // If a changeset was provided is invalid.
 523          if ( isset( $this->_changeset_uuid ) && false !== $this->_changeset_uuid && ! wp_is_uuid( $this->_changeset_uuid ) ) {
 524              $this->wp_die( -1, __( 'Invalid changeset UUID' ) );
 525          }
 526  
 527          /*
 528           * Clear incoming post data if the user lacks a CSRF token (nonce). Note that the customizer
 529           * application will inject the customize_preview_nonce query parameter into all Ajax requests.
 530           * For similar behavior elsewhere in WordPress, see rest_cookie_check_errors() which logs out
 531           * a user when a valid nonce isn't present.
 532           */
 533          $has_post_data_nonce = (
 534              check_ajax_referer( 'preview-customize_' . $this->get_stylesheet(), 'nonce', false )
 535              ||
 536              check_ajax_referer( 'save-customize_' . $this->get_stylesheet(), 'nonce', false )
 537              ||
 538              check_ajax_referer( 'preview-customize_' . $this->get_stylesheet(), 'customize_preview_nonce', false )
 539          );
 540          if ( ! current_user_can( 'customize' ) || ! $has_post_data_nonce ) {
 541              unset( $_POST['customized'] );
 542              unset( $_REQUEST['customized'] );
 543          }
 544  
 545          /*
 546           * If unauthenticated then require a valid changeset UUID to load the preview.
 547           * In this way, the UUID serves as a secret key. If the messenger channel is present,
 548           * then send unauthenticated code to prompt re-auth.
 549           */
 550          if ( ! current_user_can( 'customize' ) && ! $this->changeset_post_id() ) {
 551              $this->wp_die( $this->messenger_channel ? 0 : -1, __( 'Non-existent changeset UUID.' ) );
 552          }
 553  
 554          if ( ! headers_sent() ) {
 555              send_origin_headers();
 556          }
 557  
 558          // Hide the admin bar if we're embedded in the customizer iframe.
 559          if ( $this->messenger_channel ) {
 560              show_admin_bar( false );
 561          }
 562  
 563          if ( $this->is_theme_active() ) {
 564              // Once the theme is loaded, we'll validate it.
 565              add_action( 'after_setup_theme', array( $this, 'after_setup_theme' ) );
 566          } else {
 567              // If the requested theme is not the active theme and the user doesn't have
 568              // the switch_themes cap, bail.
 569              if ( ! current_user_can( 'switch_themes' ) ) {
 570                  $this->wp_die( -1, __( 'Sorry, you are not allowed to edit theme options on this site.' ) );
 571              }
 572  
 573              // If the theme has errors while loading, bail.
 574              if ( $this->theme()->errors() ) {
 575                  $this->wp_die( -1, $this->theme()->errors()->get_error_message() );
 576              }
 577  
 578              // If the theme isn't allowed per multisite settings, bail.
 579              if ( ! $this->theme()->is_allowed() ) {
 580                  $this->wp_die( -1, __( 'The requested theme does not exist.' ) );
 581              }
 582          }
 583  
 584          // Make sure changeset UUID is established immediately after the theme is loaded.
 585          add_action( 'after_setup_theme', array( $this, 'establish_loaded_changeset' ), 5 );
 586  
 587          /*
 588           * Import theme starter content for fresh installations when landing in the customizer.
 589           * Import starter content at after_setup_theme:100 so that any
 590           * add_theme_support( 'starter-content' ) calls will have been made.
 591           */
 592          if ( get_option( 'fresh_site' ) && 'customize.php' === $pagenow ) {
 593              add_action( 'after_setup_theme', array( $this, 'import_theme_starter_content' ), 100 );
 594          }
 595  
 596          $this->start_previewing_theme();
 597      }
 598  
 599      /**
 600       * Establishes the loaded changeset.
 601       *
 602       * This method runs right at after_setup_theme and applies the 'customize_changeset_branching' filter to determine
 603       * whether concurrent changesets are allowed. Then if the Customizer is not initialized with a `changeset_uuid` param,
 604       * this method will determine which UUID should be used. If changeset branching is disabled, then the most saved
 605       * changeset will be loaded by default. Otherwise, if there are no existing saved changesets or if changeset branching is
 606       * enabled, then a new UUID will be generated.
 607       *
 608       * @since 4.9.0
 609       *
 610       * @global string $pagenow The filename of the current screen.
 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 $manager WP_Customize_Manager instance.
 695           */
 696          do_action( 'start_previewing_theme', $this );
 697      }
 698  
 699      /**
 700       * Stops previewing the selected theme.
 701       *
 702       * Removes filters to change the active 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 $manager 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       *
 742       * @see WP_Customize_Setting::preview()
 743       *
 744       * @return bool
 745       */
 746  	public function settings_previewed() {
 747          return $this->settings_previewed;
 748      }
 749  
 750      /**
 751       * Gets whether data from a changeset's autosaved revision should be loaded if it exists.
 752       *
 753       * @since 4.9.0
 754       *
 755       * @see WP_Customize_Manager::changeset_data()
 756       *
 757       * @return bool Is using autosaved changeset revision.
 758       */
 759  	public function autosaved() {
 760          return $this->autosaved;
 761      }
 762  
 763      /**
 764       * Whether the changeset branching is allowed.
 765       *
 766       * @since 4.9.0
 767       *
 768       * @see WP_Customize_Manager::establish_loaded_changeset()
 769       *
 770       * @return bool Is changeset branching.
 771       */
 772  	public function branching() {
 773  
 774          /**
 775           * Filters whether or not changeset branching is allowed.
 776           *
 777           * By default in core, when changeset branching is not allowed, changesets will operate
 778           * linearly in that only one saved changeset will exist at a time (with a 'draft' or
 779           * 'future' status). This makes the Customizer operate in a way that is similar to going to
 780           * "edit" to one existing post: all users will be making changes to the same post, and autosave
 781           * revisions will be made for that post.
 782           *
 783           * By contrast, when changeset branching is allowed, then the model is like users going
 784           * to "add new" for a page and each user makes changes independently of each other since
 785           * they are all operating on their own separate pages, each getting their own separate
 786           * initial auto-drafts and then once initially saved, autosave revisions on top of that
 787           * user's specific post.
 788           *
 789           * Since linear changesets are deemed to be more suitable for the majority of WordPress users,
 790           * they are the default. For WordPress sites that have heavy site management in the Customizer
 791           * by multiple users then branching changesets should be enabled by means of this filter.
 792           *
 793           * @since 4.9.0
 794           *
 795           * @param bool                 $allow_branching Whether branching is allowed. If `false`, the default,
 796           *                                              then only one saved changeset exists at a time.
 797           * @param WP_Customize_Manager $wp_customize    Manager instance.
 798           */
 799          $this->branching = apply_filters( 'customize_changeset_branching', $this->branching, $this );
 800  
 801          return $this->branching;
 802      }
 803  
 804      /**
 805       * Gets the changeset UUID.
 806       *
 807       * @since 4.7.0
 808       *
 809       * @see WP_Customize_Manager::establish_loaded_changeset()
 810       *
 811       * @return string UUID.
 812       */
 813  	public function changeset_uuid() {
 814          if ( empty( $this->_changeset_uuid ) ) {
 815              $this->establish_loaded_changeset();
 816          }
 817          return $this->_changeset_uuid;
 818      }
 819  
 820      /**
 821       * Gets the theme being customized.
 822       *
 823       * @since 3.4.0
 824       *
 825       * @return WP_Theme
 826       */
 827  	public function theme() {
 828          if ( ! $this->theme ) {
 829              $this->theme = wp_get_theme();
 830          }
 831          return $this->theme;
 832      }
 833  
 834      /**
 835       * Gets the registered settings.
 836       *
 837       * @since 3.4.0
 838       *
 839       * @return array
 840       */
 841  	public function settings() {
 842          return $this->settings;
 843      }
 844  
 845      /**
 846       * Gets the registered controls.
 847       *
 848       * @since 3.4.0
 849       *
 850       * @return array
 851       */
 852  	public function controls() {
 853          return $this->controls;
 854      }
 855  
 856      /**
 857       * Gets the registered containers.
 858       *
 859       * @since 4.0.0
 860       *
 861       * @return array
 862       */
 863  	public function containers() {
 864          return $this->containers;
 865      }
 866  
 867      /**
 868       * Gets the registered sections.
 869       *
 870       * @since 3.4.0
 871       *
 872       * @return array
 873       */
 874  	public function sections() {
 875          return $this->sections;
 876      }
 877  
 878      /**
 879       * Gets the registered panels.
 880       *
 881       * @since 4.0.0
 882       *
 883       * @return array Panels.
 884       */
 885  	public function panels() {
 886          return $this->panels;
 887      }
 888  
 889      /**
 890       * Checks if the current theme is active.
 891       *
 892       * @since 3.4.0
 893       *
 894       * @return bool
 895       */
 896  	public function is_theme_active() {
 897          return $this->get_stylesheet() === $this->original_stylesheet;
 898      }
 899  
 900      /**
 901       * Registers styles/scripts and initialize the preview of each setting
 902       *
 903       * @since 3.4.0
 904       */
 905  	public function wp_loaded() {
 906  
 907          // Unconditionally register core types for panels, sections, and controls
 908          // in case plugin unhooks all customize_register actions.
 909          $this->register_panel_type( 'WP_Customize_Panel' );
 910          $this->register_panel_type( 'WP_Customize_Themes_Panel' );
 911          $this->register_section_type( 'WP_Customize_Section' );
 912          $this->register_section_type( 'WP_Customize_Sidebar_Section' );
 913          $this->register_section_type( 'WP_Customize_Themes_Section' );
 914          $this->register_control_type( 'WP_Customize_Color_Control' );
 915          $this->register_control_type( 'WP_Customize_Media_Control' );
 916          $this->register_control_type( 'WP_Customize_Upload_Control' );
 917          $this->register_control_type( 'WP_Customize_Image_Control' );
 918          $this->register_control_type( 'WP_Customize_Background_Image_Control' );
 919          $this->register_control_type( 'WP_Customize_Background_Position_Control' );
 920          $this->register_control_type( 'WP_Customize_Cropped_Image_Control' );
 921          $this->register_control_type( 'WP_Customize_Site_Icon_Control' );
 922          $this->register_control_type( 'WP_Customize_Theme_Control' );
 923          $this->register_control_type( 'WP_Customize_Code_Editor_Control' );
 924          $this->register_control_type( 'WP_Customize_Date_Time_Control' );
 925  
 926          /**
 927           * Fires once WordPress has loaded, allowing scripts and styles to be initialized.
 928           *
 929           * @since 3.4.0
 930           *
 931           * @param WP_Customize_Manager $manager WP_Customize_Manager instance.
 932           */
 933          do_action( 'customize_register', $this );
 934  
 935          if ( $this->settings_previewed() ) {
 936              foreach ( $this->settings as $setting ) {
 937                  $setting->preview();
 938              }
 939          }
 940  
 941          if ( $this->is_preview() && ! is_admin() ) {
 942              $this->customize_preview_init();
 943          }
 944      }
 945  
 946      /**
 947       * Prevents Ajax requests from following redirects when previewing a theme
 948       * by issuing a 200 response instead of a 30x.
 949       *
 950       * Instead, the JS will sniff out the location header.
 951       *
 952       * @since 3.4.0
 953       * @deprecated 4.7.0
 954       *
 955       * @param int $status Status.
 956       * @return int
 957       */
 958  	public function wp_redirect_status( $status ) {
 959          _deprecated_function( __FUNCTION__, '4.7.0' );
 960  
 961          if ( $this->is_preview() && ! is_admin() ) {
 962              return 200;
 963          }
 964  
 965          return $status;
 966      }
 967  
 968      /**
 969       * Finds the changeset post ID for a given changeset UUID.
 970       *
 971       * @since 4.7.0
 972       *
 973       * @param string $uuid Changeset UUID.
 974       * @return int|null Returns post ID on success and null on failure.
 975       */
 976  	public function find_changeset_post_id( $uuid ) {
 977          $cache_group       = 'customize_changeset_post';
 978          $changeset_post_id = wp_cache_get( $uuid, $cache_group );
 979          if ( $changeset_post_id && 'customize_changeset' === get_post_type( $changeset_post_id ) ) {
 980              return $changeset_post_id;
 981          }
 982  
 983          $changeset_post_query = new WP_Query(
 984              array(
 985                  'post_type'              => 'customize_changeset',
 986                  'post_status'            => get_post_stati(),
 987                  'name'                   => $uuid,
 988                  'posts_per_page'         => 1,
 989                  'no_found_rows'          => true,
 990                  'cache_results'          => true,
 991                  'update_post_meta_cache' => false,
 992                  'update_post_term_cache' => false,
 993                  'lazy_load_term_meta'    => false,
 994              )
 995          );
 996          if ( ! empty( $changeset_post_query->posts ) ) {
 997              // Note: 'fields'=>'ids' is not being used in order to cache the post object as it will be needed.
 998              $changeset_post_id = $changeset_post_query->posts[0]->ID;
 999              wp_cache_set( $uuid, $changeset_post_id, $cache_group );
1000              return $changeset_post_id;
1001          }
1002  
1003          return null;
1004      }
1005  
1006      /**
1007       * Gets changeset posts.
1008       *
1009       * @since 4.9.0
1010       *
1011       * @param array $args {
1012       *     Args to pass into `get_posts()` to query changesets.
1013       *
1014       *     @type int    $posts_per_page             Number of posts to return. Defaults to -1 (all posts).
1015       *     @type int    $author                     Post author. Defaults to current user.
1016       *     @type string $post_status                Status of changeset. Defaults to 'auto-draft'.
1017       *     @type bool   $exclude_restore_dismissed  Whether to exclude changeset auto-drafts that have been dismissed. Defaults to true.
1018       * }
1019       * @return WP_Post[] Auto-draft changesets.
1020       */
1021  	protected function get_changeset_posts( $args = array() ) {
1022          $default_args = array(
1023              'exclude_restore_dismissed' => true,
1024              'posts_per_page'            => -1,
1025              'post_type'                 => 'customize_changeset',
1026              'post_status'               => 'auto-draft',
1027              'order'                     => 'DESC',
1028              'orderby'                   => 'date',
1029              'no_found_rows'             => true,
1030              'cache_results'             => true,
1031              'update_post_meta_cache'    => false,
1032              'update_post_term_cache'    => false,
1033              'lazy_load_term_meta'       => false,
1034          );
1035          if ( get_current_user_id() ) {
1036              $default_args['author'] = get_current_user_id();
1037          }
1038          $args = array_merge( $default_args, $args );
1039  
1040          if ( ! empty( $args['exclude_restore_dismissed'] ) ) {
1041              unset( $args['exclude_restore_dismissed'] );
1042              $args['meta_query'] = array(
1043                  array(
1044                      'key'     => '_customize_restore_dismissed',
1045                      'compare' => 'NOT EXISTS',
1046                  ),
1047              );
1048          }
1049  
1050          return get_posts( $args );
1051      }
1052  
1053      /**
1054       * Dismisses all of the current user's auto-drafts (other than the present one).
1055       *
1056       * @since 4.9.0
1057       * @return int The number of auto-drafts that were dismissed.
1058       */
1059  	protected function dismiss_user_auto_draft_changesets() {
1060          $changeset_autodraft_posts = $this->get_changeset_posts(
1061              array(
1062                  'post_status'               => 'auto-draft',
1063                  'exclude_restore_dismissed' => true,
1064                  'posts_per_page'            => -1,
1065              )
1066          );
1067          $dismissed                 = 0;
1068          foreach ( $changeset_autodraft_posts as $autosave_autodraft_post ) {
1069              if ( $autosave_autodraft_post->ID === $this->changeset_post_id() ) {
1070                  continue;
1071              }
1072              if ( update_post_meta( $autosave_autodraft_post->ID, '_customize_restore_dismissed', true ) ) {
1073                  $dismissed++;
1074              }
1075          }
1076          return $dismissed;
1077      }
1078  
1079      /**
1080       * Gets the changeset post ID for the loaded changeset.
1081       *
1082       * @since 4.7.0
1083       *
1084       * @return int|null Post ID on success or null if there is no post yet saved.
1085       */
1086  	public function changeset_post_id() {
1087          if ( ! isset( $this->_changeset_post_id ) ) {
1088              $post_id = $this->find_changeset_post_id( $this->changeset_uuid() );
1089              if ( ! $post_id ) {
1090                  $post_id = false;
1091              }
1092              $this->_changeset_post_id = $post_id;
1093          }
1094          if ( false === $this->_changeset_post_id ) {
1095              return null;
1096          }
1097          return $this->_changeset_post_id;
1098      }
1099  
1100      /**
1101       * Gets the data stored in a changeset post.
1102       *
1103       * @since 4.7.0
1104       *
1105       * @param int $post_id Changeset post ID.
1106       * @return array|WP_Error Changeset data or WP_Error on error.
1107       */
1108  	protected function get_changeset_post_data( $post_id ) {
1109          if ( ! $post_id ) {
1110              return new WP_Error( 'empty_post_id' );
1111          }
1112          $changeset_post = get_post( $post_id );
1113          if ( ! $changeset_post ) {
1114              return new WP_Error( 'missing_post' );
1115          }
1116          if ( 'revision' === $changeset_post->post_type ) {
1117              if ( 'customize_changeset' !== get_post_type( $changeset_post->post_parent ) ) {
1118                  return new WP_Error( 'wrong_post_type' );
1119              }
1120          } elseif ( 'customize_changeset' !== $changeset_post->post_type ) {
1121              return new WP_Error( 'wrong_post_type' );
1122          }
1123          $changeset_data = json_decode( $changeset_post->post_content, true );
1124          $last_error     = json_last_error();
1125          if ( $last_error ) {
1126              return new WP_Error( 'json_parse_error', '', $last_error );
1127          }
1128          if ( ! is_array( $changeset_data ) ) {
1129              return new WP_Error( 'expected_array' );
1130          }
1131          return $changeset_data;
1132      }
1133  
1134      /**
1135       * Gets changeset data.
1136       *
1137       * @since 4.7.0
1138       * @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.
1139       *
1140       * @return array Changeset data.
1141       */
1142  	public function changeset_data() {
1143          if ( isset( $this->_changeset_data ) ) {
1144              return $this->_changeset_data;
1145          }
1146          $changeset_post_id = $this->changeset_post_id();
1147          if ( ! $changeset_post_id ) {
1148              $this->_changeset_data = array();
1149          } else {
1150              if ( $this->autosaved() && is_user_logged_in() ) {
1151                  $autosave_post = wp_get_post_autosave( $changeset_post_id, get_current_user_id() );
1152                  if ( $autosave_post ) {
1153                      $data = $this->get_changeset_post_data( $autosave_post->ID );
1154                      if ( ! is_wp_error( $data ) ) {
1155                          $this->_changeset_data = $data;
1156                      }
1157                  }
1158              }
1159  
1160              // Load data from the changeset if it was not loaded from an autosave.
1161              if ( ! isset( $this->_changeset_data ) ) {
1162                  $data = $this->get_changeset_post_data( $changeset_post_id );
1163                  if ( ! is_wp_error( $data ) ) {
1164                      $this->_changeset_data = $data;
1165                  } else {
1166                      $this->_changeset_data = array();
1167                  }
1168              }
1169          }
1170          return $this->_changeset_data;
1171      }
1172  
1173      /**
1174       * Starter content setting IDs.
1175       *
1176       * @since 4.7.0
1177       * @var array
1178       */
1179      protected $pending_starter_content_settings_ids = array();
1180  
1181      /**
1182       * Imports theme starter content into the customized state.
1183       *
1184       * @since 4.7.0
1185       *
1186       * @param array $starter_content Starter content. Defaults to `get_theme_starter_content()`.
1187       */
1188  	public function import_theme_starter_content( $starter_content = array() ) {
1189          if ( empty( $starter_content ) ) {
1190              $starter_content = get_theme_starter_content();
1191          }
1192  
1193          $changeset_data = array();
1194          if ( $this->changeset_post_id() ) {
1195              /*
1196               * Don't re-import starter content into a changeset saved persistently.
1197               * This will need to be revisited in the future once theme switching
1198               * is allowed with drafted/scheduled changesets, since switching to
1199               * another theme could result in more starter content being applied.
1200               * However, when doing an explicit save it is currently possible for
1201               * nav menus and nav menu items specifically to lose their starter_content
1202               * flags, thus resulting in duplicates being created since they fail
1203               * to get re-used. See #40146.
1204               */
1205              if ( 'auto-draft' !== get_post_status( $this->changeset_post_id() ) ) {
1206                  return;
1207              }
1208  
1209              $changeset_data = $this->get_changeset_post_data( $this->changeset_post_id() );
1210          }
1211  
1212          $sidebars_widgets = isset( $starter_content['widgets'] ) && ! empty( $this->widgets ) ? $starter_content['widgets'] : array();
1213          $attachments      = isset( $starter_content['attachments'] ) && ! empty( $this->nav_menus ) ? $starter_content['attachments'] : array();
1214          $posts            = isset( $starter_content['posts'] ) && ! empty( $this->nav_menus ) ? $starter_content['posts'] : array();
1215          $options          = isset( $starter_content['options'] ) ? $starter_content['options'] : array();
1216          $nav_menus        = isset( $starter_content['nav_menus'] ) && ! empty( $this->nav_menus ) ? $starter_content['nav_menus'] : array();
1217          $theme_mods       = isset( $starter_content['theme_mods'] ) ? $starter_content['theme_mods'] : array();
1218  
1219          // Widgets.
1220          $max_widget_numbers = array();
1221          foreach ( $sidebars_widgets as $sidebar_id => $widgets ) {
1222              $sidebar_widget_ids = array();
1223              foreach ( $widgets as $widget ) {
1224                  list( $id_base, $instance ) = $widget;
1225  
1226                  if ( ! isset( $max_widget_numbers[ $id_base ] ) ) {
1227  
1228                      // When $settings is an array-like object, get an intrinsic array for use with array_keys().
1229                      $settings = get_option( "widget_{$id_base}", array() );
1230                      if ( $settings instanceof ArrayObject || $settings instanceof ArrayIterator ) {
1231                          $settings = $settings->getArrayCopy();
1232                      }
1233  
1234                      unset( $settings['_multiwidget'] );
1235  
1236                      // Find the max widget number for this type.
1237                      $widget_numbers = array_keys( $settings );
1238                      if ( count( $widget_numbers ) > 0 ) {
1239                          $widget_numbers[]               = 1;
1240                          $max_widget_numbers[ $id_base ] = max( ...$widget_numbers );
1241                      } else {
1242                          $max_widget_numbers[ $id_base ] = 1;
1243                      }
1244                  }
1245                  $max_widget_numbers[ $id_base ] += 1;
1246  
1247                  $widget_id  = sprintf( '%s-%d', $id_base, $max_widget_numbers[ $id_base ] );
1248                  $setting_id = sprintf( 'widget_%s[%d]', $id_base, $max_widget_numbers[ $id_base ] );
1249  
1250                  $setting_value = $this->widgets->sanitize_widget_js_instance( $instance );
1251                  if ( empty( $changeset_data[ $setting_id ] ) || ! empty( $changeset_data[ $setting_id ]['starter_content'] ) ) {
1252                      $this->set_post_value( $setting_id, $setting_value );
1253                      $this->pending_starter_content_settings_ids[] = $setting_id;
1254                  }
1255                  $sidebar_widget_ids[] = $widget_id;
1256              }
1257  
1258              $setting_id = sprintf( 'sidebars_widgets[%s]', $sidebar_id );
1259              if ( empty( $changeset_data[ $setting_id ] ) || ! empty( $changeset_data[ $setting_id ]['starter_content'] ) ) {
1260                  $this->set_post_value( $setting_id, $sidebar_widget_ids );
1261                  $this->pending_starter_content_settings_ids[] = $setting_id;
1262              }
1263          }
1264  
1265          $starter_content_auto_draft_post_ids = array();
1266          if ( ! empty( $changeset_data['nav_menus_created_posts']['value'] ) ) {
1267              $starter_content_auto_draft_post_ids = array_merge( $starter_content_auto_draft_post_ids, $changeset_data['nav_menus_created_posts']['value'] );
1268          }
1269  
1270          // Make an index of all the posts needed and what their slugs are.
1271          $needed_posts = array();
1272          $attachments  = $this->prepare_starter_content_attachments( $attachments );
1273          foreach ( $attachments as $attachment ) {
1274              $key                  = 'attachment:' . $attachment['post_name'];
1275              $needed_posts[ $key ] = true;
1276          }
1277          foreach ( array_keys( $posts ) as $post_symbol ) {
1278              if ( empty( $posts[ $post_symbol ]['post_name'] ) && empty( $posts[ $post_symbol ]['post_title'] ) ) {
1279                  unset( $posts[ $post_symbol ] );
1280                  continue;
1281              }
1282              if ( empty( $posts[ $post_symbol ]['post_name'] ) ) {
1283                  $posts[ $post_symbol ]['post_name'] = sanitize_title( $posts[ $post_symbol ]['post_title'] );
1284              }
1285              if ( empty( $posts[ $post_symbol ]['post_type'] ) ) {
1286                  $posts[ $post_symbol ]['post_type'] = 'post';
1287              }
1288              $needed_posts[ $posts[ $post_symbol ]['post_type'] . ':' . $posts[ $post_symbol ]['post_name'] ] = true;
1289          }
1290          $all_post_slugs = array_merge(
1291              wp_list_pluck( $attachments, 'post_name' ),
1292              wp_list_pluck( $posts, 'post_name' )
1293          );
1294  
1295          /*
1296           * Obtain all post types referenced in starter content to use in query.
1297           * This is needed because 'any' will not account for post types not yet registered.
1298           */
1299          $post_types = array_filter( array_merge( array( 'attachment' ), wp_list_pluck( $posts, 'post_type' ) ) );
1300  
1301          // Re-use auto-draft starter content posts referenced in the current customized state.
1302          $existing_starter_content_posts = array();
1303          if ( ! empty( $starter_content_auto_draft_post_ids ) ) {
1304              $existing_posts_query = new WP_Query(
1305                  array(
1306                      'post__in'       => $starter_content_auto_draft_post_ids,
1307                      'post_status'    => 'auto-draft',
1308                      'post_type'      => $post_types,
1309                      'posts_per_page' => -1,
1310                  )
1311              );
1312              foreach ( $existing_posts_query->posts as $existing_post ) {
1313                  $post_name = $existing_post->post_name;
1314                  if ( empty( $post_name ) ) {
1315                      $post_name = get_post_meta( $existing_post->ID, '_customize_draft_post_name', true );
1316                  }
1317                  $existing_starter_content_posts[ $existing_post->post_type . ':' . $post_name ] = $existing_post;
1318              }
1319          }
1320  
1321          // Re-use non-auto-draft posts.
1322          if ( ! empty( $all_post_slugs ) ) {
1323              $existing_posts_query = new WP_Query(
1324                  array(
1325                      'post_name__in'  => $all_post_slugs,
1326                      'post_status'    => array_diff( get_post_stati(), array( 'auto-draft' ) ),
1327                      'post_type'      => 'any',
1328                      'posts_per_page' => -1,
1329                  )
1330              );
1331              foreach ( $existing_posts_query->posts as $existing_post ) {
1332                  $key = $existing_post->post_type . ':' . $existing_post->post_name;
1333                  if ( isset( $needed_posts[ $key ] ) && ! isset( $existing_starter_content_posts[ $key ] ) ) {
1334                      $existing_starter_content_posts[ $key ] = $existing_post;
1335                  }
1336              }
1337          }
1338  
1339          // Attachments are technically posts but handled differently.
1340          if ( ! empty( $attachments ) ) {
1341  
1342              $attachment_ids = array();
1343  
1344              foreach ( $attachments as $symbol => $attachment ) {
1345                  $file_array    = array(
1346                      'name' => $attachment['file_name'],
1347                  );
1348                  $file_path     = $attachment['file_path'];
1349                  $attachment_id = null;
1350                  $attached_file = null;
1351                  if ( isset( $existing_starter_content_posts[ 'attachment:' . $attachment['post_name'] ] ) ) {
1352                      $attachment_post = $existing_starter_content_posts[ 'attachment:' . $attachment['post_name'] ];
1353                      $attachment_id   = $attachment_post->ID;
1354                      $attached_file   = get_attached_file( $attachment_id );
1355                      if ( empty( $attached_file ) || ! file_exists( $attached_file ) ) {
1356                          $attachment_id = null;
1357                          $attached_file = null;
1358                      } elseif ( $this->get_stylesheet() !== get_post_meta( $attachment_post->ID, '_starter_content_theme', true ) ) {
1359  
1360                          // Re-generate attachment metadata since it was previously generated for a different theme.
1361                          $metadata = wp_generate_attachment_metadata( $attachment_post->ID, $attached_file );
1362                          wp_update_attachment_metadata( $attachment_id, $metadata );
1363                          update_post_meta( $attachment_id, '_starter_content_theme', $this->get_stylesheet() );
1364                      }
1365                  }
1366  
1367                  // Insert the attachment auto-draft because it doesn't yet exist or the attached file is gone.
1368                  if ( ! $attachment_id ) {
1369  
1370                      // Copy file to temp location so that original file won't get deleted from theme after sideloading.
1371                      $temp_file_name = wp_tempnam( wp_basename( $file_path ) );
1372                      if ( $temp_file_name && copy( $file_path, $temp_file_name ) ) {
1373                          $file_array['tmp_name'] = $temp_file_name;
1374                      }
1375                      if ( empty( $file_array['tmp_name'] ) ) {
1376                          continue;
1377                      }
1378  
1379                      $attachment_post_data = array_merge(
1380                          wp_array_slice_assoc( $attachment, array( 'post_title', 'post_content', 'post_excerpt' ) ),
1381                          array(
1382                              'post_status' => 'auto-draft', // So attachment will be garbage collected in a week if changeset is never published.
1383                          )
1384                      );
1385  
1386                      $attachment_id = media_handle_sideload( $file_array, 0, null, $attachment_post_data );
1387                      if ( is_wp_error( $attachment_id ) ) {
1388                          continue;
1389                      }
1390                      update_post_meta( $attachment_id, '_starter_content_theme', $this->get_stylesheet() );
1391                      update_post_meta( $attachment_id, '_customize_draft_post_name', $attachment['post_name'] );
1392                  }
1393  
1394                  $attachment_ids[ $symbol ] = $attachment_id;
1395              }
1396              $starter_content_auto_draft_post_ids = array_merge( $starter_content_auto_draft_post_ids, array_values( $attachment_ids ) );
1397          }
1398  
1399          // Posts & pages.
1400          if ( ! empty( $posts ) ) {
1401              foreach ( array_keys( $posts ) as $post_symbol ) {
1402                  if ( empty( $posts[ $post_symbol ]['post_type'] ) || empty( $posts[ $post_symbol ]['post_name'] ) ) {
1403                      continue;
1404                  }
1405                  $post_type = $posts[ $post_symbol ]['post_type'];
1406                  if ( ! empty( $posts[ $post_symbol ]['post_name'] ) ) {
1407                      $post_name = $posts[ $post_symbol ]['post_name'];
1408                  } elseif ( ! empty( $posts[ $post_symbol ]['post_title'] ) ) {
1409                      $post_name = sanitize_title( $posts[ $post_symbol ]['post_title'] );
1410                  } else {
1411                      continue;
1412                  }
1413  
1414                  // Use existing auto-draft post if one already exists with the same type and name.
1415                  if ( isset( $existing_starter_content_posts[ $post_type . ':' . $post_name ] ) ) {
1416                      $posts[ $post_symbol ]['ID'] = $existing_starter_content_posts[ $post_type . ':' . $post_name ]->ID;
1417                      continue;
1418                  }
1419  
1420                  // Translate the featured image symbol.
1421                  if ( ! empty( $posts[ $post_symbol ]['thumbnail'] )
1422                      && preg_match( '/^{{(?P<symbol>.+)}}$/', $posts[ $post_symbol ]['thumbnail'], $matches )
1423                      && isset( $attachment_ids[ $matches['symbol'] ] ) ) {
1424                      $posts[ $post_symbol ]['meta_input']['_thumbnail_id'] = $attachment_ids[ $matches['symbol'] ];
1425                  }
1426  
1427                  if ( ! empty( $posts[ $post_symbol ]['template'] ) ) {
1428                      $posts[ $post_symbol ]['meta_input']['_wp_page_template'] = $posts[ $post_symbol ]['template'];
1429                  }
1430  
1431                  $r = $this->nav_menus->insert_auto_draft_post( $posts[ $post_symbol ] );
1432                  if ( $r instanceof WP_Post ) {
1433                      $posts[ $post_symbol ]['ID'] = $r->ID;
1434                  }
1435              }
1436  
1437              $starter_content_auto_draft_post_ids = array_merge( $starter_content_auto_draft_post_ids, wp_list_pluck( $posts, 'ID' ) );
1438          }
1439  
1440          // The nav_menus_created_posts setting is why nav_menus component is dependency for adding posts.
1441          if ( ! empty( $this->nav_menus ) && ! empty( $starter_content_auto_draft_post_ids ) ) {
1442              $setting_id = 'nav_menus_created_posts';
1443              $this->set_post_value( $setting_id, array_unique( array_values( $starter_content_auto_draft_post_ids ) ) );
1444              $this->pending_starter_content_settings_ids[] = $setting_id;
1445          }
1446  
1447          // Nav menus.
1448          $placeholder_id              = -1;
1449          $reused_nav_menu_setting_ids = array();
1450          foreach ( $nav_menus as $nav_menu_location => $nav_menu ) {
1451  
1452              $nav_menu_term_id    = null;
1453              $nav_menu_setting_id = null;
1454              $matches             = array();
1455  
1456              // Look for an existing placeholder menu with starter content to re-use.
1457              foreach ( $changeset_data as $setting_id => $setting_params ) {
1458                  $can_reuse = (
1459                      ! empty( $setting_params['starter_content'] )
1460                      &&
1461                      ! in_array( $setting_id, $reused_nav_menu_setting_ids, true )
1462                      &&
1463                      preg_match( '#^nav_menu\[(?P<nav_menu_id>-?\d+)\]$#', $setting_id, $matches )
1464                  );
1465                  if ( $can_reuse ) {
1466                      $nav_menu_term_id              = (int) $matches['nav_menu_id'];
1467                      $nav_menu_setting_id           = $setting_id;
1468                      $reused_nav_menu_setting_ids[] = $setting_id;
1469                      break;
1470                  }
1471              }
1472  
1473              if ( ! $nav_menu_term_id ) {
1474                  while ( isset( $changeset_data[ sprintf( 'nav_menu[%d]', $placeholder_id ) ] ) ) {
1475                      $placeholder_id--;
1476                  }
1477                  $nav_menu_term_id    = $placeholder_id;
1478                  $nav_menu_setting_id = sprintf( 'nav_menu[%d]', $placeholder_id );
1479              }
1480  
1481              $this->set_post_value(
1482                  $nav_menu_setting_id,
1483                  array(
1484                      'name' => isset( $nav_menu['name'] ) ? $nav_menu['name'] : $nav_menu_location,
1485                  )
1486              );
1487              $this->pending_starter_content_settings_ids[] = $nav_menu_setting_id;
1488  
1489              // @todo Add support for menu_item_parent.
1490              $position = 0;
1491              foreach ( $nav_menu['items'] as $nav_menu_item ) {
1492                  $nav_menu_item_setting_id = sprintf( 'nav_menu_item[%d]', $placeholder_id-- );
1493                  if ( ! isset( $nav_menu_item['position'] ) ) {
1494                      $nav_menu_item['position'] = $position++;
1495                  }
1496                  $nav_menu_item['nav_menu_term_id'] = $nav_menu_term_id;
1497  
1498                  if ( isset( $nav_menu_item['object_id'] ) ) {
1499                      if ( 'post_type' === $nav_menu_item['type'] && preg_match( '/^{{(?P<symbol>.+)}}$/', $nav_menu_item['object_id'], $matches ) && isset( $posts[ $matches['symbol'] ] ) ) {
1500                          $nav_menu_item['object_id'] = $posts[ $matches['symbol'] ]['ID'];
1501                          if ( empty( $nav_menu_item['title'] ) ) {
1502                              $original_object        = get_post( $nav_menu_item['object_id'] );
1503                              $nav_menu_item['title'] = $original_object->post_title;
1504                          }
1505                      } else {
1506                          continue;
1507                      }
1508                  } else {
1509                      $nav_menu_item['object_id'] = 0;
1510                  }
1511  
1512                  if ( empty( $changeset_data[ $nav_menu_item_setting_id ] ) || ! empty( $changeset_data[ $nav_menu_item_setting_id ]['starter_content'] ) ) {
1513                      $this->set_post_value( $nav_menu_item_setting_id, $nav_menu_item );
1514                      $this->pending_starter_content_settings_ids[] = $nav_menu_item_setting_id;
1515                  }
1516              }
1517  
1518              $setting_id = sprintf( 'nav_menu_locations[%s]', $nav_menu_location );
1519              if ( empty( $changeset_data[ $setting_id ] ) || ! empty( $changeset_data[ $setting_id ]['starter_content'] ) ) {
1520                  $this->set_post_value( $setting_id, $nav_menu_term_id );
1521                  $this->pending_starter_content_settings_ids[] = $setting_id;
1522              }
1523          }
1524  
1525          // Options.
1526          foreach ( $options as $name => $value ) {
1527  
1528              // Serialize the value to check for post symbols.
1529              $value = maybe_serialize( $value );
1530  
1531              if ( is_serialized( $value ) ) {
1532                  if ( preg_match( '/s:\d+:"{{(?P<symbol>.+)}}"/', $value, $matches ) ) {
1533                      if ( isset( $posts[ $matches['symbol'] ] ) ) {
1534                          $symbol_match = $posts[ $matches['symbol'] ]['ID'];
1535                      } elseif ( isset( $attachment_ids[ $matches['symbol'] ] ) ) {
1536                          $symbol_match = $attachment_ids[ $matches['symbol'] ];
1537                      }
1538  
1539                      // If we have any symbol matches, update the values.
1540                      if ( isset( $symbol_match ) ) {
1541                          // Replace found string matches with post IDs.
1542                          $value = str_replace( $matches[0], "i:{$symbol_match}", $value );
1543                      } else {
1544                          continue;
1545                      }
1546                  }
1547              } elseif ( preg_match( '/^{{(?P<symbol>.+)}}$/', $value, $matches ) ) {
1548                  if ( isset( $posts[ $matches['symbol'] ] ) ) {
1549                      $value = $posts[ $matches['symbol'] ]['ID'];
1550                  } elseif ( isset( $attachment_ids[ $matches['symbol'] ] ) ) {
1551                      $value = $attachment_ids[ $matches['symbol'] ];
1552                  } else {
1553                      continue;
1554                  }
1555              }
1556  
1557              // Unserialize values after checking for post symbols, so they can be properly referenced.
1558              $value = maybe_unserialize( $value );
1559  
1560              if ( empty( $changeset_data[ $name ] ) || ! empty( $changeset_data[ $name ]['starter_content'] ) ) {
1561                  $this->set_post_value( $name, $value );
1562                  $this->pending_starter_content_settings_ids[] = $name;
1563              }
1564          }
1565  
1566          // Theme mods.
1567          foreach ( $theme_mods as $name => $value ) {
1568  
1569              // Serialize the value to check for post symbols.
1570              $value = maybe_serialize( $value );
1571  
1572              // Check if value was serialized.
1573              if ( is_serialized( $value ) ) {
1574                  if ( preg_match( '/s:\d+:"{{(?P<symbol>.+)}}"/', $value, $matches ) ) {
1575                      if ( isset( $posts[ $matches['symbol'] ] ) ) {
1576                          $symbol_match = $posts[ $matches['symbol'] ]['ID'];
1577                      } elseif ( isset( $attachment_ids[ $matches['symbol'] ] ) ) {
1578                          $symbol_match = $attachment_ids[ $matches['symbol'] ];
1579                      }
1580  
1581                      // If we have any symbol matches, update the values.
1582                      if ( isset( $symbol_match ) ) {
1583                          // Replace found string matches with post IDs.
1584                          $value = str_replace( $matches[0], "i:{$symbol_match}", $value );
1585                      } else {
1586                          continue;
1587                      }
1588                  }
1589              } elseif ( preg_match( '/^{{(?P<symbol>.+)}}$/', $value, $matches ) ) {
1590                  if ( isset( $posts[ $matches['symbol'] ] ) ) {
1591                      $value = $posts[ $matches['symbol'] ]['ID'];
1592                  } elseif ( isset( $attachment_ids[ $matches['symbol'] ] ) ) {
1593                      $value = $attachment_ids[ $matches['symbol'] ];
1594                  } else {
1595                      continue;
1596                  }
1597              }
1598  
1599              // Unserialize values after checking for post symbols, so they can be properly referenced.
1600              $value = maybe_unserialize( $value );
1601  
1602              // Handle header image as special case since setting has a legacy format.
1603              if ( 'header_image' === $name ) {
1604                  $name     = 'header_image_data';
1605                  $metadata = wp_get_attachment_metadata( $value );
1606                  if ( empty( $metadata ) ) {
1607                      continue;
1608                  }
1609                  $value = array(
1610                      'attachment_id' => $value,
1611                      'url'           => wp_get_attachment_url( $value ),
1612                      'height'        => $metadata['height'],
1613                      'width'         => $metadata['width'],
1614                  );
1615              } elseif ( 'background_image' === $name ) {
1616                  $value = wp_get_attachment_url( $value );
1617              }
1618  
1619              if ( empty( $changeset_data[ $name ] ) || ! empty( $changeset_data[ $name ]['starter_content'] ) ) {
1620                  $this->set_post_value( $name, $value );
1621                  $this->pending_starter_content_settings_ids[] = $name;
1622              }
1623          }
1624  
1625          if ( ! empty( $this->pending_starter_content_settings_ids ) ) {
1626              if ( did_action( 'customize_register' ) ) {
1627                  $this->_save_starter_content_changeset();
1628              } else {
1629                  add_action( 'customize_register', array( $this, '_save_starter_content_changeset' ), 1000 );
1630              }
1631          }
1632      }
1633  
1634      /**
1635       * Prepares starter content attachments.
1636       *
1637       * Ensure that the attachments are valid and that they have slugs and file name/path.
1638       *
1639       * @since 4.7.0
1640       *
1641       * @param array $attachments Attachments.
1642       * @return array Prepared attachments.
1643       */
1644  	protected function prepare_starter_content_attachments( $attachments ) {
1645          $prepared_attachments = array();
1646          if ( empty( $attachments ) ) {
1647              return $prepared_attachments;
1648          }
1649  
1650          // Such is The WordPress Way.
1651          require_once ABSPATH . 'wp-admin/includes/file.php';
1652          require_once ABSPATH . 'wp-admin/includes/media.php';
1653          require_once ABSPATH . 'wp-admin/includes/image.php';
1654  
1655          foreach ( $attachments as $symbol => $attachment ) {
1656  
1657              // A file is required and URLs to files are not currently allowed.
1658              if ( empty( $attachment['file'] ) || preg_match( '#^https?://$#', $attachment['file'] ) ) {
1659                  continue;
1660              }
1661  
1662              $file_path = null;
1663              if ( file_exists( $attachment['file'] ) ) {
1664                  $file_path = $attachment['file']; // Could be absolute path to file in plugin.
1665              } elseif ( is_child_theme() && file_exists( get_stylesheet_directory() . '/' . $attachment['file'] ) ) {
1666                  $file_path = get_stylesheet_directory() . '/' . $attachment['file'];
1667              } elseif ( file_exists( get_template_directory() . '/' . $attachment['file'] ) ) {
1668                  $file_path = get_template_directory() . '/' . $attachment['file'];
1669              } else {
1670                  continue;
1671              }
1672              $file_name = wp_basename( $attachment['file'] );
1673  
1674              // Skip file types that are not recognized.
1675              $checked_filetype = wp_check_filetype( $file_name );
1676              if ( empty( $checked_filetype['type'] ) ) {
1677                  continue;
1678              }
1679  
1680              // Ensure post_name is set since not automatically derived from post_title for new auto-draft posts.
1681              if ( empty( $attachment['post_name'] ) ) {
1682                  if ( ! empty( $attachment['post_title'] ) ) {
1683                      $attachment['post_name'] = sanitize_title( $attachment['post_title'] );
1684                  } else {
1685                      $attachment['post_name'] = sanitize_title( preg_replace( '/\.\w+$/', '', $file_name ) );
1686                  }
1687              }
1688  
1689              $attachment['file_name']         = $file_name;
1690              $attachment['file_path']         = $file_path;
1691              $prepared_attachments[ $symbol ] = $attachment;
1692          }
1693          return $prepared_attachments;
1694      }
1695  
1696      /**
1697       * Saves starter content changeset.
1698       *
1699       * @since 4.7.0
1700       */
1701  	public function _save_starter_content_changeset() {
1702  
1703          if ( empty( $this->pending_starter_content_settings_ids ) ) {
1704              return;
1705          }
1706  
1707          $this->save_changeset_post(
1708              array(
1709                  'data'            => array_fill_keys( $this->pending_starter_content_settings_ids, array( 'starter_content' => true ) ),
1710                  'starter_content' => true,
1711              )
1712          );
1713          $this->saved_starter_content_changeset = true;
1714  
1715          $this->pending_starter_content_settings_ids = array();
1716      }
1717  
1718      /**
1719       * Gets dirty pre-sanitized setting values in the current customized state.
1720       *
1721       * The returned array consists of a merge of three sources:
1722       * 1. If the theme is not currently active, then the base array is any stashed
1723       *    theme mods that were modified previously but never published.
1724       * 2. The values from the current changeset, if it exists.
1725       * 3. If the user can customize, the values parsed from the incoming
1726       *    `$_POST['customized']` JSON data.
1727       * 4. Any programmatically-set post values via `WP_Customize_Manager::set_post_value()`.
1728       *
1729       * The name "unsanitized_post_values" is a carry-over from when the customized
1730       * state was exclusively sourced from `$_POST['customized']`. Nevertheless,
1731       * the value returned will come from the current changeset post and from the
1732       * incoming post data.
1733       *
1734       * @since 4.1.1
1735       * @since 4.7.0 Added `$args` parameter and merging with changeset values and stashed theme mods.
1736       *
1737       * @param array $args {
1738       *     Args.
1739       *
1740       *     @type bool $exclude_changeset Whether the changeset values should also be excluded. Defaults to false.
1741       *     @type bool $exclude_post_data Whether the post input values should also be excluded. Defaults to false when lacking the customize capability.
1742       * }
1743       * @return array
1744       */
1745  	public function unsanitized_post_values( $args = array() ) {
1746          $args = array_merge(
1747              array(
1748                  'exclude_changeset' => false,
1749                  'exclude_post_data' => ! current_user_can( 'customize' ),
1750              ),
1751              $args
1752          );
1753  
1754          $values = array();
1755  
1756          // Let default values be from the stashed theme mods if doing a theme switch and if no changeset is present.
1757          if ( ! $this->is_theme_active() ) {
1758              $stashed_theme_mods = get_option( 'customize_stashed_theme_mods' );
1759              $stylesheet         = $this->get_stylesheet();
1760              if ( isset( $stashed_theme_mods[ $stylesheet ] ) ) {
1761                  $values = array_merge( $values, wp_list_pluck( $stashed_theme_mods[ $stylesheet ], 'value' ) );
1762              }
1763          }
1764  
1765          if ( ! $args['exclude_changeset'] ) {
1766              foreach ( $this->changeset_data() as $setting_id => $setting_params ) {
1767                  if ( ! array_key_exists( 'value', $setting_params ) ) {
1768                      continue;
1769                  }
1770                  if ( isset( $setting_params['type'] ) && 'theme_mod' === $setting_params['type'] ) {
1771  
1772                      // Ensure that theme mods values are only used if they were saved under the active theme.
1773                      $namespace_pattern = '/^(?P<stylesheet>.+?)::(?P<setting_id>.+)$/';
1774                      if ( preg_match( $namespace_pattern, $setting_id, $matches ) && $this->get_stylesheet() === $matches['stylesheet'] ) {
1775                          $values[ $matches['setting_id'] ] = $setting_params['value'];
1776                      }
1777                  } else {
1778                      $values[ $setting_id ] = $setting_params['value'];
1779                  }
1780              }
1781          }
1782  
1783          if ( ! $args['exclude_post_data'] ) {
1784              if ( ! isset( $this->_post_values ) ) {
1785                  if ( isset( $_POST['customized'] ) ) {
1786                      $post_values = json_decode( wp_unslash( $_POST['customized'] ), true );
1787                  } else {
1788                      $post_values = array();
1789                  }
1790                  if ( is_array( $post_values ) ) {
1791                      $this->_post_values = $post_values;
1792                  } else {
1793                      $this->_post_values = array();
1794                  }
1795              }
1796              $values = array_merge( $values, $this->_post_values );
1797          }
1798          return $values;
1799      }
1800  
1801      /**
1802       * Returns the sanitized value for a given setting from the current customized state.
1803       *
1804       * The name "post_value" is a carry-over from when the customized state was exclusively
1805       * sourced from `$_POST['customized']`. Nevertheless, the value returned will come
1806       * from the current changeset post and from the incoming post data.
1807       *
1808       * @since 3.4.0
1809       * @since 4.1.1 Introduced the `$default_value` parameter.
1810       * @since 4.6.0 `$default_value` is now returned early when the setting post value is invalid.
1811       *
1812       * @see WP_REST_Server::dispatch()
1813       * @see WP_REST_Request::sanitize_params()
1814       * @see WP_REST_Request::has_valid_params()
1815       *
1816       * @param WP_Customize_Setting $setting       A WP_Customize_Setting derived object.
1817       * @param mixed                $default_value Value returned if `$setting` has no post value (added in 4.2.0)
1818       *                                            or the post value is invalid (added in 4.6.0).
1819       * @return string|mixed Sanitized value or the `$default_value` provided.
1820       */
1821  	public function post_value( $setting, $default_value = null ) {
1822          $post_values = $this->unsanitized_post_values();
1823          if ( ! array_key_exists( $setting->id, $post_values ) ) {
1824              return $default_value;
1825          }
1826  
1827          $value = $post_values[ $setting->id ];
1828          $valid = $setting->validate( $value );
1829          if ( is_wp_error( $valid ) ) {
1830              return $default_value;
1831          }
1832  
1833          $value = $setting->sanitize( $value );
1834          if ( is_null( $value ) || is_wp_error( $value ) ) {
1835              return $default_value;
1836          }
1837  
1838          return $value;
1839      }
1840  
1841      /**
1842       * Overrides a setting's value in the current customized state.
1843       *
1844       * The name "post_value" is a carry-over from when the customized state was
1845       * exclusively sourced from `$_POST['customized']`.
1846       *
1847       * @since 4.2.0
1848       *
1849       * @param string $setting_id ID for the WP_Customize_Setting instance.
1850       * @param mixed  $value      Post value.
1851       */
1852  	public function set_post_value( $setting_id, $value ) {
1853          $this->unsanitized_post_values(); // Populate _post_values from $_POST['customized'].
1854          $this->_post_values[ $setting_id ] = $value;
1855  
1856          /**
1857           * Announces when a specific setting's unsanitized post value has been set.
1858           *
1859           * Fires when the WP_Customize_Manager::set_post_value() method is called.
1860           *
1861           * The dynamic portion of the hook name, `$setting_id`, refers to the setting ID.
1862           *
1863           * @since 4.4.0
1864           *
1865           * @param mixed                $value   Unsanitized setting post value.
1866           * @param WP_Customize_Manager $manager WP_Customize_Manager instance.
1867           */
1868          do_action( "customize_post_value_set_{$setting_id}", $value, $this );
1869  
1870          /**
1871           * Announces when any setting's unsanitized post value has been set.
1872           *
1873           * Fires when the WP_Customize_Manager::set_post_value() method is called.
1874           *
1875           * This is useful for `WP_Customize_Setting` instances to watch
1876           * in order to update a cached previewed value.
1877           *
1878           * @since 4.4.0
1879           *
1880           * @param string               $setting_id Setting ID.
1881           * @param mixed                $value      Unsanitized setting post value.
1882           * @param WP_Customize_Manager $manager    WP_Customize_Manager instance.
1883           */
1884          do_action( 'customize_post_value_set', $setting_id, $value, $this );
1885      }
1886  
1887      /**
1888       * Prints JavaScript settings.
1889       *
1890       * @since 3.4.0
1891       */
1892  	public function customize_preview_init() {
1893  
1894          /*
1895           * Now that Customizer previews are loaded into iframes via GET requests
1896           * and natural URLs with transaction UUIDs added, we need to ensure that
1897           * the responses are never cached by proxies. In practice, this will not
1898           * be needed if the user is logged-in anyway. But if anonymous access is
1899           * allowed then the auth cookies would not be sent and WordPress would
1900           * not send no-cache headers by default.
1901           */
1902          if ( ! headers_sent() ) {
1903              nocache_headers();
1904              header( 'X-Robots: noindex, nofollow, noarchive' );
1905          }
1906          add_filter( 'wp_robots', 'wp_robots_no_robots' );
1907          add_filter( 'wp_headers', array( $this, 'filter_iframe_security_headers' ) );
1908  
1909          /*
1910           * If preview is being served inside the customizer preview iframe, and
1911           * if the user doesn't have customize capability, then it is assumed
1912           * that the user's session has expired and they need to re-authenticate.
1913           */
1914          if ( $this->messenger_channel && ! current_user_can( 'customize' ) ) {
1915              $this->wp_die(
1916                  -1,
1917                  sprintf(
1918                      /* translators: %s: customize_messenger_channel */
1919                      __( 'Unauthorized. You may remove the %s param to preview as frontend.' ),
1920                      '<code>customize_messenger_channel<code>'
1921                  )
1922              );
1923              return;
1924          }
1925  
1926          $this->prepare_controls();
1927  
1928          add_filter( 'wp_redirect', array( $this, 'add_state_query_params' ) );
1929  
1930          wp_enqueue_script( 'customize-preview' );
1931          wp_enqueue_style( 'customize-preview' );
1932          add_action( 'wp_head', array( $this, 'customize_preview_loading_style' ) );
1933          add_action( 'wp_head', array( $this, 'remove_frameless_preview_messenger_channel' ) );
1934          add_action( 'wp_footer', array( $this, 'customize_preview_settings' ), 20 );
1935          add_filter( 'get_edit_post_link', '__return_empty_string' );
1936  
1937          /**
1938           * Fires once the Customizer preview has initialized and JavaScript
1939           * settings have been printed.
1940           *
1941           * @since 3.4.0
1942           *
1943           * @param WP_Customize_Manager $manager WP_Customize_Manager instance.
1944           */
1945          do_action( 'customize_preview_init', $this );
1946      }
1947  
1948      /**
1949       * Filters the X-Frame-Options and Content-Security-Policy headers to ensure frontend can load in customizer.
1950       *
1951       * @since 4.7.0
1952       *
1953       * @param array $headers Headers.
1954       * @return array Headers.
1955       */
1956  	public function filter_iframe_security_headers( $headers ) {
1957          $headers['X-Frame-Options']         = 'SAMEORIGIN';
1958          $headers['Content-Security-Policy'] = "frame-ancestors 'self'";
1959          return $headers;
1960      }
1961  
1962      /**
1963       * Adds customize state query params to a given URL if preview is allowed.
1964       *
1965       * @since 4.7.0
1966       *
1967       * @see wp_redirect()
1968       * @see WP_Customize_Manager::get_allowed_url()
1969       *
1970       * @param string $url URL.
1971       * @return string URL.
1972       */
1973  	public function add_state_query_params( $url ) {
1974          $parsed_original_url = wp_parse_url( $url );
1975          $is_allowed          = false;
1976          foreach ( $this->get_allowed_urls() as $allowed_url ) {
1977              $parsed_allowed_url = wp_parse_url( $allowed_url );
1978              $is_allowed         = (
1979                  $parsed_allowed_url['scheme'] === $parsed_original_url['scheme']
1980                  &&
1981                  $parsed_allowed_url['host'] === $parsed_original_url['host']
1982                  &&
1983                  0 === strpos( $parsed_original_url['path'], $parsed_allowed_url['path'] )
1984              );
1985              if ( $is_allowed ) {
1986                  break;
1987              }
1988          }
1989  
1990          if ( $is_allowed ) {
1991              $query_params = array(
1992                  'customize_changeset_uuid' => $this->changeset_uuid(),
1993              );
1994              if ( ! $this->is_theme_active() ) {
1995                  $query_params['customize_theme'] = $this->get_stylesheet();
1996              }
1997              if ( $this->messenger_channel ) {
1998                  $query_params['customize_messenger_channel'] = $this->messenger_channel;
1999              }
2000              $url = add_query_arg( $query_params, $url );
2001          }
2002  
2003          return $url;
2004      }
2005  
2006      /**
2007       * Prevents sending a 404 status when returning the response for the customize
2008       * preview, since it causes the jQuery Ajax to fail. Send 200 instead.
2009       *
2010       * @since 4.0.0
2011       * @deprecated 4.7.0
2012       */
2013  	public function customize_preview_override_404_status() {
2014          _deprecated_function( __METHOD__, '4.7.0' );
2015      }
2016  
2017      /**
2018       * Prints base element for preview frame.
2019       *
2020       * @since 3.4.0
2021       * @deprecated 4.7.0
2022       */
2023  	public function customize_preview_base() {
2024          _deprecated_function( __METHOD__, '4.7.0' );
2025      }
2026  
2027      /**
2028       * Prints a workaround to handle HTML5 tags in IE < 9.
2029       *
2030       * @since 3.4.0
2031       * @deprecated 4.7.0 Customizer no longer supports IE8, so all supported browsers recognize HTML5.
2032       */
2033  	public function customize_preview_html5() {
2034          _deprecated_function( __FUNCTION__, '4.7.0' );
2035      }
2036  
2037      /**
2038       * Prints CSS for loading indicators for the Customizer preview.
2039       *
2040       * @since 4.2.0
2041       */
2042  	public function customize_preview_loading_style() {
2043          ?>
2044          <style>
2045              body.wp-customizer-unloading {
2046                  opacity: 0.25;
2047                  cursor: progress !important;
2048                  -webkit-transition: opacity 0.5s;
2049                  transition: opacity 0.5s;
2050              }
2051              body.wp-customizer-unloading * {
2052                  pointer-events: none !important;
2053              }
2054              form.customize-unpreviewable,
2055              form.customize-unpreviewable input,
2056              form.customize-unpreviewable select,
2057              form.customize-unpreviewable button,
2058              a.customize-unpreviewable,
2059              area.customize-unpreviewable {
2060                  cursor: not-allowed !important;
2061              }
2062          </style>
2063          <?php
2064      }
2065  
2066      /**
2067       * Removes customize_messenger_channel query parameter from the preview window when it is not in an iframe.
2068       *
2069       * This ensures that the admin bar will be shown. It also ensures that link navigation will
2070       * work as expected since the parent frame is not being sent the URL to navigate to.
2071       *
2072       * @since 4.7.0
2073       */
2074  	public function remove_frameless_preview_messenger_channel() {
2075          if ( ! $this->messenger_channel ) {
2076              return;
2077          }
2078          ?>
2079          <script>
2080          ( function() {
2081              var urlParser, oldQueryParams, newQueryParams, i;
2082              if ( parent !== window ) {
2083                  return;
2084              }
2085              urlParser = document.createElement( 'a' );
2086              urlParser.href = location.href;
2087              oldQueryParams = urlParser.search.substr( 1 ).split( /&/ );
2088              newQueryParams = [];
2089              for ( i = 0; i < oldQueryParams.length; i += 1 ) {
2090                  if ( ! /^customize_messenger_channel=/.test( oldQueryParams[ i ] ) ) {
2091                      newQueryParams.push( oldQueryParams[ i ] );
2092                  }
2093              }
2094              urlParser.search = newQueryParams.join( '&' );
2095              if ( urlParser.search !== location.search ) {
2096                  location.replace( urlParser.href );
2097              }
2098          } )();
2099          </script>
2100          <?php
2101      }
2102  
2103      /**
2104       * Prints JavaScript settings for preview frame.
2105       *
2106       * @since 3.4.0
2107       */
2108  	public function customize_preview_settings() {
2109          $post_values                 = $this->unsanitized_post_values( array( 'exclude_changeset' => true ) );
2110          $setting_validities          = $this->validate_setting_values( $post_values );
2111          $exported_setting_validities = array_map( array( $this, 'prepare_setting_validity_for_js' ), $setting_validities );
2112  
2113          // Note that the REQUEST_URI is not passed into home_url() since this breaks subdirectory installations.
2114          $self_url           = empty( $_SERVER['REQUEST_URI'] ) ? home_url( '/' ) : esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ) );
2115          $state_query_params = array(
2116              'customize_theme',
2117              'customize_changeset_uuid',
2118              'customize_messenger_channel',
2119          );
2120          $self_url           = remove_query_arg( $state_query_params, $self_url );
2121  
2122          $allowed_urls  = $this->get_allowed_urls();
2123          $allowed_hosts = array();
2124          foreach ( $allowed_urls as $allowed_url ) {
2125              $parsed = wp_parse_url( $allowed_url );
2126              if ( empty( $parsed['host'] ) ) {
2127                  continue;
2128              }
2129              $host = $parsed['host'];
2130              if ( ! empty( $parsed['port'] ) ) {
2131                  $host .= ':' . $parsed['port'];
2132              }
2133              $allowed_hosts[] = $host;
2134          }
2135  
2136          $switched_locale = switch_to_locale( get_user_locale() );
2137          $l10n            = array(
2138              'shiftClickToEdit'  => __( 'Shift-click to edit this element.' ),
2139              'linkUnpreviewable' => __( 'This link is not live-previewable.' ),
2140              'formUnpreviewable' => __( 'This form is not live-previewable.' ),
2141          );
2142          if ( $switched_locale ) {
2143              restore_previous_locale();
2144          }
2145  
2146          $settings = array(
2147              'changeset'         => array(
2148                  'uuid'      => $this->changeset_uuid(),
2149                  'autosaved' => $this->autosaved(),
2150              ),
2151              'timeouts'          => array(
2152                  'selectiveRefresh' => 250,
2153                  'keepAliveSend'    => 1000,
2154              ),
2155              'theme'             => array(
2156                  'stylesheet' => $this->get_stylesheet(),
2157                  'active'     => $this->is_theme_active(),
2158              ),
2159              'url'               => array(
2160                  'self'          => $self_url,
2161                  'allowed'       => array_map( 'esc_url_raw', $this->get_allowed_urls() ),
2162                  'allowedHosts'  => array_unique( $allowed_hosts ),
2163                  'isCrossDomain' => $this->is_cross_domain(),
2164              ),
2165              'channel'           => $this->messenger_channel,
2166              'activePanels'      => array(),
2167              'activeSections'    => array(),
2168              'activeControls'    => array(),
2169              'settingValidities' => $exported_setting_validities,
2170              'nonce'             => current_user_can( 'customize' ) ? $this->get_nonces() : array(),
2171              'l10n'              => $l10n,
2172              '_dirty'            => array_keys( $post_values ),
2173          );
2174  
2175          foreach ( $this->panels as $panel_id => $panel ) {
2176              if ( $panel->check_capabilities() ) {
2177                  $settings['activePanels'][ $panel_id ] = $panel->active();
2178                  foreach ( $panel->sections as $section_id => $section ) {
2179                      if ( $section->check_capabilities() ) {
2180                          $settings['activeSections'][ $section_id ] = $section->active();
2181                      }
2182                  }
2183              }
2184          }
2185          foreach ( $this->sections as $id => $section ) {
2186              if ( $section->check_capabilities() ) {
2187                  $settings['activeSections'][ $id ] = $section->active();
2188              }
2189          }
2190          foreach ( $this->controls as $id => $control ) {
2191              if ( $control->check_capabilities() ) {
2192                  $settings['activeControls'][ $id ] = $control->active();
2193              }
2194          }
2195  
2196          ?>
2197          <script type="text/javascript">
2198              var _wpCustomizeSettings = <?php echo wp_json_encode( $settings ); ?>;
2199              _wpCustomizeSettings.values = {};
2200              (function( v ) {
2201                  <?php
2202                  /*
2203                   * Serialize settings separately from the initial _wpCustomizeSettings
2204                   * serialization in order to avoid a peak memory usage spike.
2205                   * @todo We may not even need to export the values at all since the pane syncs them anyway.
2206                   */
2207                  foreach ( $this->settings as $id => $setting ) {
2208                      if ( $setting->check_capabilities() ) {
2209                          printf(
2210                              "v[%s] = %s;\n",
2211                              wp_json_encode( $id ),
2212                              wp_json_encode( $setting->js_value() )
2213                          );
2214                      }
2215                  }
2216                  ?>
2217              })( _wpCustomizeSettings.values );
2218          </script>
2219          <?php
2220      }
2221  
2222      /**
2223       * Prints a signature so we can ensure the Customizer was properly executed.
2224       *
2225       * @since 3.4.0
2226       * @deprecated 4.7.0
2227       */
2228  	public function customize_preview_signature() {
2229          _deprecated_function( __METHOD__, '4.7.0' );
2230      }
2231  
2232      /**
2233       * Removes the signature in case we experience a case where the Customizer was not properly executed.
2234       *
2235       * @since 3.4.0
2236       * @deprecated 4.7.0
2237       *
2238       * @param callable|null $callback Optional. Value passed through for {@see 'wp_die_handler'} filter.
2239       *                                Default null.
2240       * @return callable|null Value passed through for {@see 'wp_die_handler'} filter.
2241       */
2242  	public function remove_preview_signature( $callback = null ) {
2243          _deprecated_function( __METHOD__, '4.7.0' );
2244  
2245          return $callback;
2246      }
2247  
2248      /**
2249       * Determines whether it is a theme preview or not.
2250       *
2251       * @since 3.4.0
2252       *
2253       * @return bool True if it's a preview, false if not.
2254       */
2255  	public function is_preview() {
2256          return (bool) $this->previewing;
2257      }
2258  
2259      /**
2260       * Retrieves the template name of the previewed theme.
2261       *
2262       * @since 3.4.0
2263       *
2264       * @return string Template name.
2265       */
2266  	public function get_template() {
2267          return $this->theme()->get_template();
2268      }
2269  
2270      /**
2271       * Retrieves the stylesheet name of the previewed theme.
2272       *
2273       * @since 3.4.0
2274       *
2275       * @return string Stylesheet name.
2276       */
2277  	public function get_stylesheet() {
2278          return $this->theme()->get_stylesheet();
2279      }
2280  
2281      /**
2282       * Retrieves the template root of the previewed theme.
2283       *
2284       * @since 3.4.0
2285       *
2286       * @return string Theme root.
2287       */
2288  	public function get_template_root() {
2289          return get_raw_theme_root( $this->get_template(), true );
2290      }
2291  
2292      /**
2293       * Retrieves the stylesheet root of the previewed theme.
2294       *
2295       * @since 3.4.0
2296       *
2297       * @return string Theme root.
2298       */
2299  	public function get_stylesheet_root() {
2300          return get_raw_theme_root( $this->get_stylesheet(), true );
2301      }
2302  
2303      /**
2304       * Filters the active theme and return the name of the previewed theme.
2305       *
2306       * @since 3.4.0
2307       *
2308       * @param mixed $current_theme {@internal Parameter is not used}
2309       * @return string Theme name.
2310       */
2311  	public function current_theme( $current_theme ) {
2312          return $this->theme()->display( 'Name' );
2313      }
2314  
2315      /**
2316       * Validates setting values.
2317       *
2318       * Validation is skipped for unregistered settings or for values that are
2319       * already null since they will be skipped anyway. Sanitization is applied
2320       * to values that pass validation, and values that become null or `WP_Error`
2321       * after sanitizing are marked invalid.
2322       *
2323       * @since 4.6.0
2324       *
2325       * @see WP_REST_Request::has_valid_params()
2326       * @see WP_Customize_Setting::validate()
2327       *
2328       * @param array $setting_values Mapping of setting IDs to values to validate and sanitize.
2329       * @param array $options {
2330       *     Options.
2331       *
2332       *     @type bool $validate_existence  Whether a setting's existence will be checked.
2333       *     @type bool $validate_capability Whether the setting capability will be checked.
2334       * }
2335       * @return array Mapping of setting IDs to return value of validate method calls, either `true` or `WP_Error`.
2336       */
2337  	public function validate_setting_values( $setting_values, $options = array() ) {
2338          $options = wp_parse_args(
2339              $options,
2340              array(
2341                  'validate_capability' => false,
2342                  'validate_existence'  => false,
2343              )
2344          );
2345  
2346          $validities = array();
2347          foreach ( $setting_values as $setting_id => $unsanitized_value ) {
2348              $setting = $this->get_setting( $setting_id );
2349              if ( ! $setting ) {
2350                  if ( $options['validate_existence'] ) {
2351                      $validities[ $setting_id ] = new WP_Error( 'unrecognized', __( 'Setting does not exist or is unrecognized.' ) );
2352                  }
2353                  continue;
2354              }
2355              if ( $options['validate_capability'] && ! current_user_can( $setting->capability ) ) {
2356                  $validity = new WP_Error( 'unauthorized', __( 'Unauthorized to modify setting due to capability.' ) );
2357              } else {
2358                  if ( is_null( $unsanitized_value ) ) {
2359                      continue;
2360                  }
2361                  $validity = $setting->validate( $unsanitized_value );
2362              }
2363              if ( ! is_wp_error( $validity ) ) {
2364                  /** This filter is documented in wp-includes/class-wp-customize-setting.php */
2365                  $late_validity = apply_filters( "customize_validate_{$setting->id}", new WP_Error(), $unsanitized_value, $setting );
2366                  if ( is_wp_error( $late_validity ) && $late_validity->has_errors() ) {
2367                      $validity = $late_validity;
2368                  }
2369              }
2370              if ( ! is_wp_error( $validity ) ) {
2371                  $value = $setting->sanitize( $unsanitized_value );
2372                  if ( is_null( $value ) ) {
2373                      $validity = false;
2374                  } elseif ( is_wp_error( $value ) ) {
2375                      $validity = $value;
2376                  }
2377              }
2378              if ( false === $validity ) {
2379                  $validity = new WP_Error( 'invalid_value', __( 'Invalid value.' ) );
2380              }
2381              $validities[ $setting_id ] = $validity;
2382          }
2383          return $validities;
2384      }
2385  
2386      /**
2387       * Prepares setting validity for exporting to the client (JS).
2388       *
2389       * Converts `WP_Error` instance into array suitable for passing into the
2390       * `wp.customize.Notification` JS model.
2391       *
2392       * @since 4.6.0
2393       *
2394       * @param true|WP_Error $validity Setting validity.
2395       * @return true|array If `$validity` was a WP_Error, the error codes will be array-mapped
2396       *                    to their respective `message` and `data` to pass into the
2397       *                    `wp.customize.Notification` JS model.
2398       */
2399  	public function prepare_setting_validity_for_js( $validity ) {
2400          if ( is_wp_error( $validity ) ) {
2401              $notification = array();
2402              foreach ( $validity->errors as $error_code => $error_messages ) {
2403                  $notification[ $error_code ] = array(
2404                      'message' => implode( ' ', $error_messages ),
2405                      'data'    => $validity->get_error_data( $error_code ),
2406                  );
2407              }
2408              return $notification;
2409          } else {
2410              return true;
2411          }
2412      }
2413  
2414      /**
2415       * Handles customize_save WP Ajax request to save/update a changeset.
2416       *
2417       * @since 3.4.0
2418       * @since 4.7.0 The semantics of this method have changed to update a changeset, optionally to also change the status and other attributes.
2419       */
2420  	public function save() {
2421          if ( ! is_user_logged_in() ) {
2422              wp_send_json_error( 'unauthenticated' );
2423          }
2424  
2425          if ( ! $this->is_preview() ) {
2426              wp_send_json_error( 'not_preview' );
2427          }
2428  
2429          $action = 'save-customize_' . $this->get_stylesheet();
2430          if ( ! check_ajax_referer( $action, 'nonce', false ) ) {
2431              wp_send_json_error( 'invalid_nonce' );
2432          }
2433  
2434          $changeset_post_id = $this->changeset_post_id();
2435          $is_new_changeset  = empty( $changeset_post_id );
2436          if ( $is_new_changeset ) {
2437              if ( ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->create_posts ) ) {
2438                  wp_send_json_error( 'cannot_create_changeset_post' );
2439              }
2440          } else {
2441              if ( ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->edit_post, $changeset_post_id ) ) {
2442                  wp_send_json_error( 'cannot_edit_changeset_post' );
2443              }
2444          }
2445  
2446          if ( ! empty( $_POST['customize_changeset_data'] ) ) {
2447              $input_changeset_data = json_decode( wp_unslash( $_POST['customize_changeset_data'] ), true );
2448              if ( ! is_array( $input_changeset_data ) ) {
2449                  wp_send_json_error( 'invalid_customize_changeset_data' );
2450              }
2451          } else {
2452              $input_changeset_data = array();
2453          }
2454  
2455          // Validate title.
2456          $changeset_title = null;
2457          if ( isset( $_POST['customize_changeset_title'] ) ) {
2458              $changeset_title = sanitize_text_field( wp_unslash( $_POST['customize_changeset_title'] ) );
2459          }
2460  
2461          // Validate changeset status param.
2462          $is_publish       = null;
2463          $changeset_status = null;
2464          if ( isset( $_POST['customize_changeset_status'] ) ) {
2465              $changeset_status = wp_unslash( $_POST['customize_changeset_status'] );
2466              if ( ! get_post_status_object( $changeset_status ) || ! in_array( $changeset_status, array( 'draft', 'pending', 'publish', 'future' ), true ) ) {
2467                  wp_send_json_error( 'bad_customize_changeset_status', 400 );
2468              }
2469              $is_publish = ( 'publish' === $changeset_status || 'future' === $changeset_status );
2470              if ( $is_publish && ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->publish_posts ) ) {
2471                  wp_send_json_error( 'changeset_publish_unauthorized', 403 );
2472              }
2473          }
2474  
2475          /*
2476           * Validate changeset date param. Date is assumed to be in local time for
2477           * the WP if in MySQL format (YYYY-MM-DD HH:MM:SS). Otherwise, the date
2478           * is parsed with strtotime() so that ISO date format may be supplied
2479           * or a string like "+10 minutes".
2480           */
2481          $changeset_date_gmt = null;
2482          if ( isset( $_POST['customize_changeset_date'] ) ) {
2483              $changeset_date = wp_unslash( $_POST['customize_changeset_date'] );
2484              if ( preg_match( '/^\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d$/', $changeset_date ) ) {
2485                  $mm         = substr( $changeset_date, 5, 2 );
2486                  $jj         = substr( $changeset_date, 8, 2 );
2487                  $aa         = substr( $changeset_date, 0, 4 );
2488                  $valid_date = wp_checkdate( $mm, $jj, $aa, $changeset_date );
2489                  if ( ! $valid_date ) {
2490                      wp_send_json_error( 'bad_customize_changeset_date', 400 );
2491                  }
2492                  $changeset_date_gmt = get_gmt_from_date( $changeset_date );
2493              } else {
2494                  $timestamp = strtotime( $changeset_date );
2495                  if ( ! $timestamp ) {
2496                      wp_send_json_error( 'bad_customize_changeset_date', 400 );
2497                  }
2498                  $changeset_date_gmt = gmdate( 'Y-m-d H:i:s', $timestamp );
2499              }
2500          }
2501  
2502          $lock_user_id = null;
2503          $autosave     = ! empty( $_POST['customize_changeset_autosave'] );
2504          if ( ! $is_new_changeset ) {
2505              $lock_user_id = wp_check_post_lock( $this->changeset_post_id() );
2506          }
2507  
2508          // Force request to autosave when changeset is locked.
2509          if ( $lock_user_id && ! $autosave ) {
2510              $autosave           = true;
2511              $changeset_status   = null;
2512              $changeset_date_gmt = null;
2513          }
2514  
2515          if ( $autosave && ! defined( 'DOING_AUTOSAVE' ) ) { // Back-compat.
2516              define( 'DOING_AUTOSAVE', true );
2517          }
2518  
2519          $autosaved = false;
2520          $r         = $this->save_changeset_post(
2521              array(
2522                  'status'   => $changeset_status,
2523                  'title'    => $changeset_title,
2524                  'date_gmt' => $changeset_date_gmt,
2525                  'data'     => $input_changeset_data,
2526                  'autosave' => $autosave,
2527              )
2528          );
2529          if ( $autosave && ! is_wp_error( $r ) ) {
2530              $autosaved = true;
2531          }
2532  
2533          // If the changeset was locked and an autosave request wasn't itself an error, then now explicitly return with a failure.
2534          if ( $lock_user_id && ! is_wp_error( $r ) ) {
2535              $r = new WP_Error(
2536                  'changeset_locked',
2537                  __( 'Changeset is being edited by other user.' ),
2538                  array(
2539                      'lock_user' => $this->get_lock_user_data( $lock_user_id ),
2540                  )
2541              );
2542          }
2543  
2544          if ( is_wp_error( $r ) ) {
2545              $response = array(
2546                  'message' => $r->get_error_message(),
2547                  'code'    => $r->get_error_code(),
2548              );
2549              if ( is_array( $r->get_error_data() ) ) {
2550                  $response = array_merge( $response, $r->get_error_data() );
2551              } else {
2552                  $response['data'] = $r->get_error_data();
2553              }
2554          } else {
2555              $response       = $r;
2556              $changeset_post = get_post( $this->changeset_post_id() );
2557  
2558              // Dismiss all other auto-draft changeset posts for this user (they serve like autosave revisions), as there should only be one.
2559              if ( $is_new_changeset ) {
2560                  $this->dismiss_user_auto_draft_changesets();
2561              }
2562  
2563              // Note that if the changeset status was publish, then it will get set to Trash if revisions are not supported.
2564              $response['changeset_status'] = $changeset_post->post_status;
2565              if ( $is_publish && 'trash' === $response['changeset_status'] ) {
2566                  $response['changeset_status'] = 'publish';
2567              }
2568  
2569              if ( 'publish' !== $response['changeset_status'] ) {
2570                  $this->set_changeset_lock( $changeset_post->ID );
2571              }
2572  
2573              if ( 'future' === $response['changeset_status'] ) {
2574                  $response['changeset_date'] = $changeset_post->post_date;
2575              }
2576  
2577              if ( 'publish' === $response['changeset_status'] || 'trash' === $response['changeset_status'] ) {
2578                  $response['next_changeset_uuid'] = wp_generate_uuid4();
2579              }
2580          }
2581  
2582          if ( $autosave ) {
2583              $response['autosaved'] = $autosaved;
2584          }
2585  
2586          if ( isset( $response['setting_validities'] ) ) {
2587              $response['setting_validities'] = array_map( array( $this, 'prepare_setting_validity_for_js' ), $response['setting_validities'] );
2588          }
2589  
2590          /**
2591           * Filters response data for a successful customize_save Ajax request.
2592           *
2593           * This filter does not apply if there was a nonce or authentication failure.
2594           *
2595           * @since 4.2.0
2596           *
2597           * @param array                $response Additional information passed back to the 'saved'
2598           *                                       event on `wp.customize`.
2599           * @param WP_Customize_Manager $manager  WP_Customize_Manager instance.
2600           */
2601          $response = apply_filters( 'customize_save_response', $response, $this );
2602  
2603          if ( is_wp_error( $r ) ) {
2604              wp_send_json_error( $response );
2605          } else {
2606              wp_send_json_success( $response );
2607          }
2608      }
2609  
2610      /**
2611       * Saves the post for the loaded changeset.
2612       *
2613       * @since 4.7.0
2614       *
2615       * @param array $args {
2616       *     Args for changeset post.
2617       *
2618       *     @type array  $data            Optional additional changeset data. Values will be merged on top of any existing post values.
2619       *     @type string $status          Post status. Optional. If supplied, the save will be transactional and a post revision will be allowed.
2620       *     @type string $title           Post title. Optional.
2621       *     @type string $date_gmt        Date in GMT. Optional.
2622       *     @type int    $user_id         ID for user who is saving the changeset. Optional, defaults to the current user ID.
2623       *     @type bool   $starter_content Whether the data is starter content. If false (default), then $starter_content will be cleared for any $data being saved.
2624       *     @type bool   $autosave        Whether this is a request to create an autosave revision.
2625       * }
2626       *
2627       * @return array|WP_Error Returns array on success and WP_Error with array data on error.
2628       */
2629  	public function save_changeset_post( $args = array() ) {
2630  
2631          $args = array_merge(
2632              array(
2633                  'status'          => null,
2634                  'title'           => null,
2635                  'data'            => array(),
2636                  'date_gmt'        => null,
2637                  'user_id'         => get_current_user_id(),
2638                  'starter_content' => false,
2639                  'autosave'        => false,
2640              ),
2641              $args
2642          );
2643  
2644          $changeset_post_id       = $this->changeset_post_id();
2645          $existing_changeset_data = array();
2646          if ( $changeset_post_id ) {
2647              $existing_status = get_post_status( $changeset_post_id );
2648              if ( 'publish' === $existing_status || 'trash' === $existing_status ) {
2649                  return new WP_Error(
2650                      'changeset_already_published',
2651                      __( 'The previous set of changes has already been published. Please try saving your current set of changes again.' ),
2652                      array(
2653                          'next_changeset_uuid' => wp_generate_uuid4(),
2654                      )
2655                  );
2656              }
2657  
2658              $existing_changeset_data = $this->get_changeset_post_data( $changeset_post_id );
2659              if ( is_wp_error( $existing_changeset_data ) ) {
2660                  return $existing_changeset_data;
2661              }
2662          }
2663  
2664          // Fail if attempting to publish but publish hook is missing.
2665          if ( 'publish' === $args['status'] && false === has_action( 'transition_post_status', '_wp_customize_publish_changeset' ) ) {
2666              return new WP_Error( 'missing_publish_callback' );
2667          }
2668  
2669          // Validate date.
2670          $now = gmdate( 'Y-m-d H:i:59' );
2671          if ( $args['date_gmt'] ) {
2672              $is_future_dated = ( mysql2date( 'U', $args['date_gmt'], false ) > mysql2date( 'U', $now, false ) );
2673              if ( ! $is_future_dated ) {
2674                  return new WP_Error( 'not_future_date', __( 'You must supply a future date to schedule.' ) ); // Only future dates are allowed.
2675              }
2676  
2677              if ( ! $this->is_theme_active() && ( 'future' === $args['status'] || $is_future_dated ) ) {
2678                  return new WP_Error( 'cannot_schedule_theme_switches' ); // This should be allowed in the future, when theme is a regular setting.
2679              }
2680              $will_remain_auto_draft = ( ! $args['status'] && ( ! $changeset_post_id || 'auto-draft' === get_post_status( $changeset_post_id ) ) );
2681              if ( $will_remain_auto_draft ) {
2682                  return new WP_Error( 'cannot_supply_date_for_auto_draft_changeset' );
2683              }
2684          } elseif ( $changeset_post_id && 'future' === $args['status'] ) {
2685  
2686              // Fail if the new status is future but the existing post's date is not in the future.
2687              $changeset_post = get_post( $changeset_post_id );
2688              if ( mysql2date( 'U', $changeset_post->post_date_gmt, false ) <= mysql2date( 'U', $now, false ) ) {
2689                  return new WP_Error( 'not_future_date', __( 'You must supply a future date to schedule.' ) );
2690              }
2691          }
2692  
2693          if ( ! empty( $is_future_dated ) && 'publish' === $args['status'] ) {
2694              $args['status'] = 'future';
2695          }
2696  
2697          // Validate autosave param. See _wp_post_revision_fields() for why these fields are disallowed.
2698          if ( $args['autosave'] ) {
2699              if ( $args['date_gmt'] ) {
2700                  return new WP_Error( 'illegal_autosave_with_date_gmt' );
2701              } elseif ( $args['status'] ) {
2702                  return new WP_Error( 'illegal_autosave_with_status' );
2703              } elseif ( $args['user_id'] && get_current_user_id() !== $args['user_id'] ) {
2704                  return new WP_Error( 'illegal_autosave_with_non_current_user' );
2705              }
2706          }
2707  
2708          // The request was made via wp.customize.previewer.save().
2709          $update_transactionally = (bool) $args['status'];
2710          $allow_revision         = (bool) $args['status'];
2711  
2712          // Amend post values with any supplied data.
2713          foreach ( $args['data'] as $setting_id => $setting_params ) {
2714              if ( is_array( $setting_params ) && array_key_exists( 'value', $setting_params ) ) {
2715                  $this->set_post_value( $setting_id, $setting_params['value'] ); // Add to post values so that they can be validated and sanitized.
2716              }
2717          }
2718  
2719          // Note that in addition to post data, this will include any stashed theme mods.
2720          $post_values = $this->unsanitized_post_values(
2721              array(
2722                  'exclude_changeset' => true,
2723                  'exclude_post_data' => false,
2724              )
2725          );
2726          $this->add_dynamic_settings( array_keys( $post_values ) ); // Ensure settings get created even if they lack an input value.
2727  
2728          /*
2729           * Get list of IDs for settings that have values different from what is currently
2730           * saved in the changeset. By skipping any values that are already the same, the
2731           * subset of changed settings can be passed into validate_setting_values to prevent
2732           * an underprivileged modifying a single setting for which they have the capability
2733           * from being blocked from saving. This also prevents a user from touching of the
2734           * previous saved settings and overriding the associated user_id if they made no change.
2735           */
2736          $changed_setting_ids = array();
2737          foreach ( $post_values as $setting_id => $setting_value ) {
2738              $setting = $this->get_setting( $setting_id );
2739  
2740              if ( $setting && 'theme_mod' === $setting->type ) {
2741                  $prefixed_setting_id = $this->get_stylesheet() . '::' . $setting->id;
2742              } else {
2743                  $prefixed_setting_id = $setting_id;
2744              }
2745  
2746              $is_value_changed = (
2747                  ! isset( $existing_changeset_data[ $prefixed_setting_id ] )
2748                  ||
2749                  ! array_key_exists( 'value', $existing_changeset_data[ $prefixed_setting_id ] )
2750                  ||
2751                  $existing_changeset_data[ $prefixed_setting_id ]['value'] !== $setting_value
2752              );
2753              if ( $is_value_changed ) {
2754                  $changed_setting_ids[] = $setting_id;
2755              }
2756          }
2757  
2758          /**
2759           * Fires before save validation happens.
2760           *
2761           * Plugins can add just-in-time {@see 'customize_validate_{$this->ID}'} filters
2762           * at this point to catch any settings registered after `customize_register`.
2763           * The dynamic portion of the hook name, `$this->ID` refers to the setting ID.
2764           *
2765           * @since 4.6.0
2766           *
2767           * @param WP_Customize_Manager $manager WP_Customize_Manager instance.
2768           */
2769          do_action( 'customize_save_validation_before', $this );
2770  
2771          // Validate settings.
2772          $validated_values      = array_merge(
2773              array_fill_keys( array_keys( $args['data'] ), null ), // Make sure existence/capability checks are done on value-less setting updates.
2774              $post_values
2775          );
2776          $setting_validities    = $this->validate_setting_values(
2777              $validated_values,
2778              array(
2779                  'validate_capability' => true,
2780                  'validate_existence'  => true,
2781              )
2782          );
2783          $invalid_setting_count = count( array_filter( $setting_validities, 'is_wp_error' ) );
2784  
2785          /*
2786           * Short-circuit if there are invalid settings the update is transactional.
2787           * A changeset update is transactional when a status is supplied in the request.
2788           */
2789          if ( $update_transactionally && $invalid_setting_count > 0 ) {
2790              $response = array(
2791                  'setting_validities' => $setting_validities,
2792                  /* translators: %s: Number of invalid settings. */
2793                  '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 ) ),
2794              );
2795              return new WP_Error( 'transaction_fail', '', $response );
2796          }
2797  
2798          // Obtain/merge data for changeset.
2799          $original_changeset_data = $this->get_changeset_post_data( $changeset_post_id );
2800          $data                    = $original_changeset_data;
2801          if ( is_wp_error( $data ) ) {
2802              $data = array();
2803          }
2804  
2805          // Ensure that all post values are included in the changeset data.
2806          foreach ( $post_values as $setting_id => $post_value ) {
2807              if ( ! isset( $args['data'][ $setting_id ] ) ) {
2808                  $args['data'][ $setting_id ] = array();
2809              }
2810              if ( ! isset( $args['data'][ $setting_id ]['value'] ) ) {
2811                  $args['data'][ $setting_id ]['value'] = $post_value;
2812              }
2813          }
2814  
2815          foreach ( $args['data'] as $setting_id => $setting_params ) {
2816              $setting = $this->get_setting( $setting_id );
2817              if ( ! $setting || ! $setting->check_capabilities() ) {
2818                  continue;
2819              }
2820  
2821              // Skip updating changeset for invalid setting values.
2822              if ( isset( $setting_validities[ $setting_id ] ) && is_wp_error( $setting_validities[ $setting_id ] ) ) {
2823                  continue;
2824              }
2825  
2826              $changeset_setting_id = $setting_id;
2827              if ( 'theme_mod' === $setting->type ) {
2828                  $changeset_setting_id = sprintf( '%s::%s', $this->get_stylesheet(), $setting_id );
2829              }
2830  
2831              if ( null === $setting_params ) {
2832                  // Remove setting from changeset entirely.
2833                  unset( $data[ $changeset_setting_id ] );
2834              } else {
2835  
2836                  if ( ! isset( $data[ $changeset_setting_id ] ) ) {
2837                      $data[ $changeset_setting_id ] = array();
2838                  }
2839  
2840                  // Merge any additional setting params that have been supplied with the existing params.
2841                  $merged_setting_params = array_merge( $data[ $changeset_setting_id ], $setting_params );
2842  
2843                  // Skip updating setting params if unchanged (ensuring the user_id is not overwritten).
2844                  if ( $data[ $changeset_setting_id ] === $merged_setting_params ) {
2845                      continue;
2846                  }
2847  
2848                  $data[ $changeset_setting_id ] = array_merge(
2849                      $merged_setting_params,
2850                      array(
2851                          'type'              => $setting->type,
2852                          'user_id'           => $args['user_id'],
2853                          'date_modified_gmt' => current_time( 'mysql', true ),
2854                      )
2855                  );
2856  
2857                  // Clear starter_content flag in data if changeset is not explicitly being updated for starter content.
2858                  if ( empty( $args['starter_content'] ) ) {
2859                      unset( $data[ $changeset_setting_id ]['starter_content'] );
2860                  }
2861              }
2862          }
2863  
2864          $filter_context = array(
2865              'uuid'          => $this->changeset_uuid(),
2866              'title'         => $args['title'],
2867              'status'        => $args['status'],
2868              'date_gmt'      => $args['date_gmt'],
2869              'post_id'       => $changeset_post_id,
2870              'previous_data' => is_wp_error( $original_changeset_data ) ? array() : $original_changeset_data,
2871              'manager'       => $this,
2872          );
2873  
2874          /**
2875           * Filters the settings' data that will be persisted into the changeset.
2876           *
2877           * Plugins may amend additional data (such as additional meta for settings) into the changeset with this filter.
2878           *
2879           * @since 4.7.0
2880           *
2881           * @param array $data Updated changeset data, mapping setting IDs to arrays containing a $value item and optionally other metadata.
2882           * @param array $context {
2883           *     Filter context.
2884           *
2885           *     @type string               $uuid          Changeset UUID.
2886           *     @type string               $title         Requested title for the changeset post.
2887           *     @type string               $status        Requested status for the changeset post.
2888           *     @type string               $date_gmt      Requested date for the changeset post in MySQL format and GMT timezone.
2889           *     @type int|false            $post_id       Post ID for the changeset, or false if it doesn't exist yet.
2890           *     @type array                $previous_data Previous data contained in the changeset.
2891           *     @type WP_Customize_Manager $manager       Manager instance.
2892           * }
2893           */
2894          $data = apply_filters( 'customize_changeset_save_data', $data, $filter_context );
2895  
2896          // Switch theme if publishing changes now.
2897          if ( 'publish' === $args['status'] && ! $this->is_theme_active() ) {
2898              // Temporarily stop previewing the theme to allow switch_themes() to operate properly.
2899              $this->stop_previewing_theme();
2900              switch_theme( $this->get_stylesheet() );
2901              update_option( 'theme_switched_via_customizer', true );
2902              $this->start_previewing_theme();
2903          }
2904  
2905          // Gather the data for wp_insert_post()/wp_update_post().
2906          $post_array = array(
2907              // JSON_UNESCAPED_SLASHES is only to improve readability as slashes needn't be escaped in storage.
2908              'post_content' => wp_json_encode( $data, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT ),
2909          );
2910          if ( $args['title'] ) {
2911              $post_array['post_title'] = $args['title'];
2912          }
2913          if ( $changeset_post_id ) {
2914              $post_array['ID'] = $changeset_post_id;
2915          } else {
2916              $post_array['post_type']   = 'customize_changeset';
2917              $post_array['post_name']   = $this->changeset_uuid();
2918              $post_array['post_status'] = 'auto-draft';
2919          }
2920          if ( $args['status'] ) {
2921              $post_array['post_status'] = $args['status'];
2922          }
2923  
2924          // Reset post date to now if we are publishing, otherwise pass post_date_gmt and translate for post_date.
2925          if ( 'publish' === $args['status'] ) {
2926              $post_array['post_date_gmt'] = '0000-00-00 00:00:00';
2927              $post_array['post_date']     = '0000-00-00 00:00:00';
2928          } elseif ( $args['date_gmt'] ) {
2929              $post_array['post_date_gmt'] = $args['date_gmt'];
2930              $post_array['post_date']     = get_date_from_gmt( $args['date_gmt'] );
2931          } elseif ( $changeset_post_id && 'auto-draft' === get_post_status( $changeset_post_id ) ) {
2932              /*
2933               * Keep bumping the date for the auto-draft whenever it is modified;
2934               * this extends its life, preserving it from garbage-collection via
2935               * wp_delete_auto_drafts().
2936               */
2937              $post_array['post_date']     = current_time( 'mysql' );
2938              $post_array['post_date_gmt'] = '';
2939          }
2940  
2941          $this->store_changeset_revision = $allow_revision;
2942          add_filter( 'wp_save_post_revision_post_has_changed', array( $this, '_filter_revision_post_has_changed' ), 5, 3 );
2943  
2944          /*
2945           * Update the changeset post. The publish_customize_changeset action will cause the settings in the
2946           * changeset to be saved via WP_Customize_Setting::save(). Updating a post with publish status will
2947           * trigger WP_Customize_Manager::publish_changeset_values().
2948           */
2949          add_filter( 'wp_insert_post_data', array( $this, 'preserve_insert_changeset_post_content' ), 5, 3 );
2950          if ( $changeset_post_id ) {
2951              if ( $args['autosave'] && 'auto-draft' !== get_post_status( $changeset_post_id ) ) {
2952                  // See _wp_translate_postdata() for why this is required as it will use the edit_post meta capability.
2953                  add_filter( 'map_meta_cap', array( $this, 'grant_edit_post_capability_for_changeset' ), 10, 4 );
2954  
2955                  $post_array['post_ID']   = $post_array['ID'];
2956                  $post_array['post_type'] = 'customize_changeset';
2957  
2958                  $r = wp_create_post_autosave( wp_slash( $post_array ) );
2959  
2960                  remove_filter( 'map_meta_cap', array( $this, 'grant_edit_post_capability_for_changeset' ), 10 );
2961              } else {
2962                  $post_array['edit_date'] = true; // Prevent date clearing.
2963  
2964                  $r = wp_update_post( wp_slash( $post_array ), true );
2965  
2966                  // Delete autosave revision for user when the changeset is updated.
2967                  if ( ! empty( $args['user_id'] ) ) {
2968                      $autosave_draft = wp_get_post_autosave( $changeset_post_id, $args['user_id'] );
2969                      if ( $autosave_draft ) {
2970                          wp_delete_post( $autosave_draft->ID, true );
2971                      }
2972                  }
2973              }
2974          } else {
2975              $r = wp_insert_post( wp_slash( $post_array ), true );
2976              if ( ! is_wp_error( $r ) ) {
2977                  $this->_changeset_post_id = $r; // Update cached post ID for the loaded changeset.
2978              }
2979          }
2980          remove_filter( 'wp_insert_post_data', array( $this, 'preserve_insert_changeset_post_content' ), 5 );
2981  
2982          $this->_changeset_data = null; // Reset so WP_Customize_Manager::changeset_data() will re-populate with updated contents.
2983  
2984          remove_filter( 'wp_save_post_revision_post_has_changed', array( $this, '_filter_revision_post_has_changed' ) );
2985  
2986          $response = array(
2987              'setting_validities' => $setting_validities,
2988          );
2989  
2990          if ( is_wp_error( $r ) ) {
2991              $response['changeset_post_save_failure'] = $r->get_error_code();
2992              return new WP_Error( 'changeset_post_save_failure', '', $response );
2993          }
2994  
2995          return $response;
2996      }
2997  
2998      /**
2999       * Preserves the initial JSON post_content passed to save into the post.
3000       *
3001       * This is needed to prevent KSES and other {@see 'content_save_pre'} filters
3002       * from corrupting JSON data.
3003       *
3004       * Note that WP_Customize_Manager::validate_setting_values() have already
3005       * run on the setting values being serialized as JSON into the post content
3006       * so it is pre-sanitized.
3007       *
3008       * Also, the sanitization logic is re-run through the respective
3009       * WP_Customize_Setting::sanitize() method when being read out of the
3010       * changeset, via WP_Customize_Manager::post_value(), and this sanitized
3011       * value will also be sent into WP_Customize_Setting::update() for
3012       * persisting to the DB.
3013       *
3014       * Multiple users can collaborate on a single changeset, where one user may
3015       * have the unfiltered_html capability but another may not. A user with
3016       * unfiltered_html may add a script tag to some field which needs to be kept
3017       * intact even when another user updates the changeset to modify another field
3018       * when they do not have unfiltered_html.
3019       *
3020       * @since 5.4.1
3021       *
3022       * @param array $data                An array of slashed and processed post data.
3023       * @param array $postarr             An array of sanitized (and slashed) but otherwise unmodified post data.
3024       * @param array $unsanitized_postarr An array of slashed yet *unsanitized* and unprocessed post data as originally passed to wp_insert_post().
3025       * @return array Filtered post data.
3026       */
3027  	public function preserve_insert_changeset_post_content( $data, $postarr, $unsanitized_postarr ) {
3028          if (
3029              isset( $data['post_type'] ) &&
3030              isset( $unsanitized_postarr['post_content'] ) &&
3031              'customize_changeset' === $data['post_type'] ||
3032              (
3033                  'revision' === $data['post_type'] &&
3034                  ! empty( $data['post_parent'] ) &&
3035                  'customize_changeset' === get_post_type( $data['post_parent'] )
3036              )
3037          ) {
3038              $data['post_content'] = $unsanitized_postarr['post_content'];
3039          }
3040          return $data;
3041      }
3042  
3043      /**
3044       * Trashes or deletes a changeset post.
3045       *
3046       * The following re-formulates the logic from `wp_trash_post()` as done in
3047       * `wp_publish_post()`. The reason for bypassing `wp_trash_post()` is that it
3048       * will mutate the the `post_content` and the `post_name` when they should be
3049       * untouched.
3050       *
3051       * @since 4.9.0
3052       *
3053       * @see wp_trash_post()
3054       * @global wpdb $wpdb WordPress database abstraction object.
3055       *
3056       * @param int|WP_Post $post The changeset post.
3057       * @return mixed A WP_Post object for the trashed post or an empty value on failure.
3058       */
3059  	public function trash_changeset_post( $post ) {
3060          global $wpdb;
3061  
3062          $post = get_post( $post );
3063  
3064          if ( ! ( $post instanceof WP_Post ) ) {
3065              return $post;
3066          }
3067          $post_id = $post->ID;
3068  
3069          if ( ! EMPTY_TRASH_DAYS ) {
3070              return wp_delete_post( $post_id, true );
3071          }
3072  
3073          if ( 'trash' === get_post_status( $post ) ) {
3074              return false;
3075          }
3076  
3077          /** This filter is documented in wp-includes/post.php */
3078          $check = apply_filters( 'pre_trash_post', null, $post );
3079          if ( null !== $check ) {
3080              return $check;
3081          }
3082  
3083          /** This action is documented in wp-includes/post.php */
3084          do_action( 'wp_trash_post', $post_id );
3085  
3086          add_post_meta( $post_id, '_wp_trash_meta_status', $post->post_status );
3087          add_post_meta( $post_id, '_wp_trash_meta_time', time() );
3088  
3089          $old_status = $post->post_status;
3090          $new_status = 'trash';
3091          $wpdb->update( $wpdb->posts, array( 'post_status' => $new_status ), array( 'ID' => $post->ID ) );
3092          clean_post_cache( $post->ID );
3093  
3094          $post->post_status = $new_status;
3095          wp_transition_post_status( $new_status, $old_status, $post );
3096  
3097          /** This action is documented in wp-includes/post.php */
3098          do_action( "edit_post_{$post->post_type}", $post->ID, $post );
3099  
3100          /** This action is documented in wp-includes/post.php */
3101          do_action( 'edit_post', $post->ID, $post );
3102  
3103          /** This action is documented in wp-includes/post.php */
3104          do_action( "save_post_{$post->post_type}", $post->ID, $post, true );
3105  
3106          /** This action is documented in wp-includes/post.php */
3107          do_action( 'save_post', $post->ID, $post, true );
3108  
3109          /** This action is documented in wp-includes/post.php */
3110          do_action( 'wp_insert_post', $post->ID, $post, true );
3111  
3112          wp_after_insert_post( get_post( $post_id ), true, $post );
3113  
3114          wp_trash_post_comments( $post_id );
3115  
3116          /** This action is documented in wp-includes/post.php */
3117          do_action( 'trashed_post', $post_id );
3118  
3119          return $post;
3120      }
3121  
3122      /**
3123       * Handles request to trash a changeset.
3124       *
3125       * @since 4.9.0
3126       */
3127  	public function handle_changeset_trash_request() {
3128          if ( ! is_user_logged_in() ) {
3129              wp_send_json_error( 'unauthenticated' );
3130          }
3131  
3132          if ( ! $this->is_preview() ) {
3133              wp_send_json_error( 'not_preview' );
3134          }
3135  
3136          if ( ! check_ajax_referer( 'trash_customize_changeset', 'nonce', false ) ) {
3137              wp_send_json_error(
3138                  array(
3139                      'code'    => 'invalid_nonce',
3140                      'message' => __( 'There was an authentication problem. Please reload and try again.' ),
3141                  )
3142              );
3143          }
3144  
3145          $changeset_post_id = $this->changeset_post_id();
3146  
3147          if ( ! $changeset_post_id ) {
3148              wp_send_json_error(
3149                  array(
3150                      'message' => __( 'No changes saved yet, so there is nothing to trash.' ),
3151                      'code'    => 'non_existent_changeset',
3152                  )
3153              );
3154              return;
3155          }
3156  
3157          if ( $changeset_post_id ) {
3158              if ( ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->delete_post, $changeset_post_id ) ) {
3159                  wp_send_json_error(
3160                      array(
3161                          'code'    => 'changeset_trash_unauthorized',
3162                          'message' => __( 'Unable to trash changes.' ),
3163                      )
3164                  );
3165              }
3166  
3167              $lock_user = (int) wp_check_post_lock( $changeset_post_id );
3168  
3169              if ( $lock_user && get_current_user_id() !== $lock_user ) {
3170                  wp_send_json_error(
3171                      array(
3172                          'code'     => 'changeset_locked',
3173                          'message'  => __( 'Changeset is being edited by other user.' ),
3174                          'lockUser' => $this->get_lock_user_data( $lock_user ),
3175                      )
3176                  );
3177              }
3178          }
3179  
3180          if ( 'trash' === get_post_status( $changeset_post_id ) ) {
3181              wp_send_json_error(
3182                  array(
3183                      'message' => __( 'Changes have already been trashed.' ),
3184                      'code'    => 'changeset_already_trashed',
3185                  )
3186              );
3187              return;
3188          }
3189  
3190          $r = $this->trash_changeset_post( $changeset_post_id );
3191          if ( ! ( $r instanceof WP_Post ) ) {
3192              wp_send_json_error(
3193                  array(
3194                      'code'    => 'changeset_trash_failure',
3195                      'message' => __( 'Unable to trash changes.' ),
3196                  )
3197              );
3198          }
3199  
3200          wp_send_json_success(
3201              array(
3202                  'message' => __( 'Changes trashed successfully.' ),
3203              )
3204          );
3205      }
3206  
3207      /**
3208       * Re-maps 'edit_post' meta cap for a customize_changeset post to be the same as 'customize' maps.
3209       *
3210       * There is essentially a "meta meta" cap in play here, where 'edit_post' meta cap maps to
3211       * the 'customize' meta cap which then maps to 'edit_theme_options'. This is currently
3212       * required in core for `wp_create_post_autosave()` because it will call
3213       * `_wp_translate_postdata()` which in turn will check if a user can 'edit_post', but the
3214       * the caps for the customize_changeset post type are all mapping to the meta capability.
3215       * This should be able to be removed once #40922 is addressed in core.
3216       *
3217       * @since 4.9.0
3218       *
3219       * @link https://core.trac.wordpress.org/ticket/40922
3220       * @see WP_Customize_Manager::save_changeset_post()
3221       * @see _wp_translate_postdata()
3222       *
3223       * @param string[] $caps    Array of the user's capabilities.
3224       * @param string   $cap     Capability name.
3225       * @param int      $user_id The user ID.
3226       * @param array    $args    Adds the context to the cap. Typically the object ID.
3227       * @return array Capabilities.
3228       */
3229  	public function grant_edit_post_capability_for_changeset( $caps, $cap, $user_id, $args ) {
3230          if ( 'edit_post' === $cap && ! empty( $args[0] ) && 'customize_changeset' === get_post_type( $args[0] ) ) {
3231              $post_type_obj = get_post_type_object( 'customize_changeset' );
3232              $caps          = map_meta_cap( $post_type_obj->cap->$cap, $user_id );
3233          }
3234          return $caps;
3235      }
3236  
3237      /**
3238       * Marks the changeset post as being currently edited by the current user.
3239       *
3240       * @since 4.9.0
3241       *
3242       * @param int  $changeset_post_id Changeset post ID.
3243       * @param bool $take_over Whether to take over the changeset. Default false.
3244       */
3245  	public function set_changeset_lock( $changeset_post_id, $take_over = false ) {
3246          if ( $changeset_post_id ) {
3247              $can_override = ! (bool) get_post_meta( $changeset_post_id, '_edit_lock', true );
3248  
3249              if ( $take_over ) {
3250                  $can_override = true;
3251              }
3252  
3253              if ( $can_override ) {
3254                  $lock = sprintf( '%s:%s', time(), get_current_user_id() );
3255                  update_post_meta( $changeset_post_id, '_edit_lock', $lock );
3256              } else {
3257                  $this->refresh_changeset_lock( $changeset_post_id );
3258              }
3259          }
3260      }
3261  
3262      /**
3263       * Refreshes changeset lock with the current time if current user edited the changeset before.
3264       *
3265       * @since 4.9.0
3266       *
3267       * @param int $changeset_post_id Changeset post ID.
3268       */
3269  	public function refresh_changeset_lock( $changeset_post_id ) {
3270          if ( ! $changeset_post_id ) {
3271              return;
3272          }
3273  
3274          $lock = get_post_meta( $changeset_post_id, '_edit_lock', true );
3275          $lock = explode( ':', $lock );
3276  
3277          if ( $lock && ! empty( $lock[1] ) ) {
3278              $user_id         = (int) $lock[1];
3279              $current_user_id = get_current_user_id();
3280              if ( $user_id === $current_user_id ) {
3281                  $lock = sprintf( '%s:%s', time(), $user_id );
3282                  update_post_meta( $changeset_post_id, '_edit_lock', $lock );
3283              }
3284          }
3285      }
3286  
3287      /**
3288       * Filters heartbeat settings for the Customizer.
3289       *
3290       * @since 4.9.0
3291       *
3292       * @global string $pagenow The filename of the current screen.
3293       *
3294       * @param array $settings Current settings to filter.
3295       * @return array Heartbeat settings.
3296       */
3297  	public function add_customize_screen_to_heartbeat_settings( $settings ) {
3298          global $pagenow;
3299  
3300          if ( 'customize.php' === $pagenow ) {
3301              $settings['screenId'] = 'customize';
3302          }
3303  
3304          return $settings;
3305      }
3306  
3307      /**
3308       * Gets lock user data.
3309       *
3310       * @since 4.9.0
3311       *
3312       * @param int $user_id User ID.
3313       * @return array|null User data formatted for client.
3314       */
3315  	protected function get_lock_user_data( $user_id ) {
3316          if ( ! $user_id ) {
3317              return null;
3318          }
3319  
3320          $lock_user = get_userdata( $user_id );
3321  
3322          if ( ! $lock_user ) {
3323              return null;
3324          }
3325  
3326          return array(
3327              'id'     => $lock_user->ID,
3328              'name'   => $lock_user->display_name,
3329              'avatar' => get_avatar_url( $lock_user->ID, array( 'size' => 128 ) ),
3330          );
3331      }
3332  
3333      /**
3334       * Checks locked changeset with heartbeat API.
3335       *
3336       * @since 4.9.0
3337       *
3338       * @param array  $response  The Heartbeat response.
3339       * @param array  $data      The $_POST data sent.
3340       * @param string $screen_id The screen id.
3341       * @return array The Heartbeat response.
3342       */
3343  	public function check_changeset_lock_with_heartbeat( $response, $data, $screen_id ) {
3344          if ( isset( $data['changeset_uuid'] ) ) {
3345              $changeset_post_id = $this->find_changeset_post_id( $data['changeset_uuid'] );
3346          } else {
3347              $changeset_post_id = $this->changeset_post_id();
3348          }
3349  
3350          if (
3351              array_key_exists( 'check_changeset_lock', $data )
3352              && 'customize' === $screen_id
3353              && $changeset_post_id
3354              && current_user_can( get_post_type_object( 'customize_changeset' )->cap->edit_post, $changeset_post_id )
3355          ) {
3356              $lock_user_id = wp_check_post_lock( $changeset_post_id );
3357  
3358              if ( $lock_user_id ) {
3359                  $response['customize_changeset_lock_user'] = $this->get_lock_user_data( $lock_user_id );
3360              } else {
3361  
3362                  // Refreshing time will ensure that the user is sitting on customizer and has not closed the customizer tab.
3363                  $this->refresh_changeset_lock( $changeset_post_id );
3364              }
3365          }
3366  
3367          return $response;
3368      }
3369  
3370      /**
3371       * Removes changeset lock when take over request is sent via Ajax.
3372       *
3373       * @since 4.9.0
3374       */
3375  	public function handle_override_changeset_lock_request() {
3376          if ( ! $this->is_preview() ) {
3377              wp_send_json_error( 'not_preview', 400 );
3378          }
3379  
3380          if ( ! check_ajax_referer( 'customize_override_changeset_lock', 'nonce', false ) ) {
3381              wp_send_json_error(
3382                  array(
3383                      'code'    => 'invalid_nonce',
3384                      'message' => __( 'Security check failed.' ),
3385                  )
3386              );
3387          }
3388  
3389          $changeset_post_id = $this->changeset_post_id();
3390  
3391          if ( empty( $changeset_post_id ) ) {
3392              wp_send_json_error(
3393                  array(
3394                      'code'    => 'no_changeset_found_to_take_over',
3395                      'message' => __( 'No changeset found to take over' ),
3396                  )
3397              );
3398          }
3399  
3400          if ( ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->edit_post, $changeset_post_id ) ) {
3401              wp_send_json_error(
3402                  array(
3403                      'code'    => 'cannot_remove_changeset_lock',
3404                      'message' => __( 'Sorry, you are not allowed to take over.' ),
3405                  )
3406              );
3407          }
3408  
3409          $this->set_changeset_lock( $changeset_post_id, true );
3410  
3411          wp_send_json_success( 'changeset_taken_over' );
3412      }
3413  
3414      /**
3415       * Determines whether a changeset revision should be made.
3416       *
3417       * @since 4.7.0
3418       * @var bool
3419       */
3420      protected $store_changeset_revision;
3421  
3422      /**
3423       * Filters whether a changeset has changed to create a new revision.
3424       *
3425       * Note that this will not be called while a changeset post remains in auto-draft status.
3426       *
3427       * @since 4.7.0
3428       *
3429       * @param bool    $post_has_changed Whether the post has changed.
3430       * @param WP_Post $last_revision    The last revision post object.
3431       * @param WP_Post $post             The post object.
3432       * @return bool Whether a revision should be made.
3433       */
3434  	public function _filter_revision_post_has_changed( $post_has_changed, $last_revision, $post ) {
3435          unset( $last_revision );
3436          if ( 'customize_changeset' === $post->post_type ) {
3437              $post_has_changed = $this->store_changeset_revision;
3438          }
3439          return $post_has_changed;
3440      }
3441  
3442      /**
3443       * Publishes the values of a changeset.
3444       *
3445       * This will publish the values contained in a changeset, even changesets that do not
3446       * correspond to current manager instance. This is called by
3447       * `_wp_customize_publish_changeset()` when a customize_changeset post is
3448       * transitioned to the `publish` status. As such, this method should not be
3449       * called directly and instead `wp_publish_post()` should be used.
3450       *
3451       * Please note that if the settings in the changeset are for a non-activated
3452       * theme, the theme must first be switched to (via `switch_theme()`) before
3453       * invoking this method.
3454       *
3455       * @since 4.7.0
3456       *
3457       * @see _wp_customize_publish_changeset()
3458       * @global wpdb $wpdb WordPress database abstraction object.
3459       *
3460       * @param int $changeset_post_id ID for customize_changeset post. Defaults to the changeset for the current manager instance.
3461       * @return true|WP_Error True or error info.
3462       */
3463  	public function _publish_changeset_values( $changeset_post_id ) {
3464          global $wpdb;
3465  
3466          $publishing_changeset_data = $this->get_changeset_post_data( $changeset_post_id );
3467          if ( is_wp_error( $publishing_changeset_data ) ) {
3468              return $publishing_changeset_data;
3469          }
3470  
3471          $changeset_post = get_post( $changeset_post_id );
3472  
3473          /*
3474           * Temporarily override the changeset context so that it will be read
3475           * in calls to unsanitized_post_values() and so that it will be available
3476           * on the $wp_customize object passed to hooks during the save logic.
3477           */
3478          $previous_changeset_post_id = $this->_changeset_post_id;
3479          $this->_changeset_post_id   = $changeset_post_id;
3480          $previous_changeset_uuid    = $this->_changeset_uuid;
3481          $this->_changeset_uuid      = $changeset_post->post_name;
3482          $previous_changeset_data    = $this->_changeset_data;
3483          $this->_changeset_data      = $publishing_changeset_data;
3484  
3485          // Parse changeset data to identify theme mod settings and user IDs associated with settings to be saved.
3486          $setting_user_ids   = array();
3487          $theme_mod_settings = array();
3488          $namespace_pattern  = '/^(?P<stylesheet>.+?)::(?P<setting_id>.+)$/';
3489          $matches            = array();
3490          foreach ( $this->_changeset_data as $raw_setting_id => $setting_params ) {
3491              $actual_setting_id    = null;
3492              $is_theme_mod_setting = (
3493                  isset( $setting_params['value'] )
3494                  &&
3495                  isset( $setting_params['type'] )
3496                  &&
3497                  'theme_mod' === $setting_params['type']
3498                  &&
3499                  preg_match( $namespace_pattern, $raw_setting_id, $matches )
3500              );
3501              if ( $is_theme_mod_setting ) {
3502                  if ( ! isset( $theme_mod_settings[ $matches['stylesheet'] ] ) ) {
3503                      $theme_mod_settings[ $matches['stylesheet'] ] = array();
3504                  }
3505                  $theme_mod_settings[ $matches['stylesheet'] ][ $matches['setting_id'] ] = $setting_params;
3506  
3507                  if ( $this->get_stylesheet() === $matches['stylesheet'] ) {
3508                      $actual_setting_id = $matches['setting_id'];
3509                  }
3510              } else {
3511                  $actual_setting_id = $raw_setting_id;
3512              }
3513  
3514              // Keep track of the user IDs for settings actually for this theme.
3515              if ( $actual_setting_id && isset( $setting_params['user_id'] ) ) {
3516                  $setting_user_ids[ $actual_setting_id ] = $setting_params['user_id'];
3517              }
3518          }
3519  
3520          $changeset_setting_values = $this->unsanitized_post_values(
3521              array(
3522                  'exclude_post_data' => true,
3523                  'exclude_changeset' => false,
3524              )
3525          );
3526          $changeset_setting_ids    = array_keys( $changeset_setting_values );
3527          $this->add_dynamic_settings( $changeset_setting_ids );
3528  
3529          /**
3530           * Fires once the theme has switched in the Customizer, but before settings
3531           * have been saved.
3532           *
3533           * @since 3.4.0
3534           *
3535           * @param WP_Customize_Manager $manager WP_Customize_Manager instance.
3536           */
3537          do_action( 'customize_save', $this );
3538  
3539          /*
3540           * Ensure that all settings will allow themselves to be saved. Note that
3541           * this is safe because the setting would have checked the capability
3542           * when the setting value was written into the changeset. So this is why
3543           * an additional capability check is not required here.
3544           */
3545          $original_setting_capabilities = array();
3546          foreach ( $changeset_setting_ids as $setting_id ) {
3547              $setting = $this->get_setting( $setting_id );
3548              if ( $setting && ! isset( $setting_user_ids[ $setting_id ] ) ) {
3549                  $original_setting_capabilities[ $setting->id ] = $setting->capability;
3550                  $setting->capability                           = 'exist';
3551              }
3552          }
3553  
3554          $original_user_id = get_current_user_id();
3555          foreach ( $changeset_setting_ids as $setting_id ) {
3556              $setting = $this->get_setting( $setting_id );
3557              if ( $setting ) {
3558                  /*
3559                   * Set the current user to match the user who saved the value into
3560                   * the changeset so that any filters that apply during the save
3561                   * process will respect the original user's capabilities. This
3562                   * will ensure, for example, that KSES won't strip unsafe HTML
3563                   * when a scheduled changeset publishes via WP Cron.
3564                   */
3565                  if ( isset( $setting_user_ids[ $setting_id ] ) ) {
3566                      wp_set_current_user( $setting_user_ids[ $setting_id ] );
3567                  } else {
3568                      wp_set_current_user( $original_user_id );
3569                  }
3570  
3571                  $setting->save();
3572              }
3573          }
3574          wp_set_current_user( $original_user_id );
3575  
3576          // Update the stashed theme mod settings, removing the active theme's stashed settings, if activated.
3577          if ( did_action( 'switch_theme' ) ) {
3578              $other_theme_mod_settings = $theme_mod_settings;
3579              unset( $other_theme_mod_settings[ $this->get_stylesheet() ] );
3580              $this->update_stashed_theme_mod_settings( $other_theme_mod_settings );
3581          }
3582  
3583          /**
3584           * Fires after Customize settings have been saved.
3585           *
3586           * @since 3.6.0
3587           *
3588           * @param WP_Customize_Manager $manager WP_Customize_Manager instance.
3589           */
3590          do_action( 'customize_save_after', $this );
3591  
3592          // Restore original capabilities.
3593          foreach ( $original_setting_capabilities as $setting_id => $capability ) {
3594              $setting = $this->get_setting( $setting_id );
3595              if ( $setting ) {
3596                  $setting->capability = $capability;
3597              }
3598          }
3599  
3600          // Restore original changeset data.
3601          $this->_changeset_data    = $previous_changeset_data;
3602          $this->_changeset_post_id = $previous_changeset_post_id;
3603          $this->_changeset_uuid    = $previous_changeset_uuid;
3604  
3605          /*
3606           * Convert all autosave revisions into their own auto-drafts so that users can be prompted to
3607           * restore them when a changeset is published, but they had been locked out from including
3608           * their changes in the changeset.
3609           */
3610          $revisions = wp_get_post_revisions( $changeset_post_id, array( 'check_enabled' => false ) );
3611          foreach ( $revisions as $revision ) {
3612              if ( false !== strpos( $revision->post_name, "{$changeset_post_id}-autosave" ) ) {
3613                  $wpdb->update(
3614                      $wpdb->posts,
3615                      array(
3616                          'post_status' => 'auto-draft',
3617                          'post_type'   => 'customize_changeset',
3618                          'post_name'   => wp_generate_uuid4(),
3619                          'post_parent' => 0,
3620                      ),
3621                      array(
3622                          'ID' => $revision->ID,
3623                      )
3624                  );
3625                  clean_post_cache( $revision->ID );
3626              }
3627          }
3628  
3629          return true;
3630      }
3631  
3632      /**
3633       * Updates stashed theme mod settings.
3634       *
3635       * @since 4.7.0
3636       *
3637       * @param array $inactive_theme_mod_settings Mapping of stylesheet to arrays of theme mod settings.
3638       * @return array|false Returns array of updated stashed theme mods or false if the update failed or there were no changes.
3639       */
3640  	protected function update_stashed_theme_mod_settings( $inactive_theme_mod_settings ) {
3641          $stashed_theme_mod_settings = get_option( 'customize_stashed_theme_mods' );
3642          if ( empty( $stashed_theme_mod_settings ) ) {
3643              $stashed_theme_mod_settings = array();
3644          }
3645  
3646          // Delete any stashed theme mods for the active theme since they would have been loaded and saved upon activation.
3647          unset( $stashed_theme_mod_settings[ $this->get_stylesheet() ] );
3648  
3649          // Merge inactive theme mods with the stashed theme mod settings.
3650          foreach ( $inactive_theme_mod_settings as $stylesheet => $theme_mod_settings ) {
3651              if ( ! isset( $stashed_theme_mod_settings[ $stylesheet ] ) ) {
3652                  $stashed_theme_mod_settings[ $stylesheet ] = array();
3653              }
3654  
3655              $stashed_theme_mod_settings[ $stylesheet ] = array_merge(
3656                  $stashed_theme_mod_settings[ $stylesheet ],
3657                  $theme_mod_settings
3658              );
3659          }
3660  
3661          $autoload = false;
3662          $result   = update_option( 'customize_stashed_theme_mods', $stashed_theme_mod_settings, $autoload );
3663          if ( ! $result ) {
3664              return false;
3665          }
3666          return $stashed_theme_mod_settings;
3667      }
3668  
3669      /**
3670       * Refreshes nonces for the current preview.
3671       *
3672       * @since 4.2.0
3673       */
3674  	public function refresh_nonces() {
3675          if ( ! $this->is_preview() ) {
3676              wp_send_json_error( 'not_preview' );
3677          }
3678  
3679          wp_send_json_success( $this->get_nonces() );
3680      }
3681  
3682      /**
3683       * Deletes a given auto-draft changeset or the autosave revision for a given changeset or delete changeset lock.
3684       *
3685       * @since 4.9.0
3686       */
3687  	public function handle_dismiss_autosave_or_lock_request() {
3688          // Calls to dismiss_user_auto_draft_changesets() and wp_get_post_autosave() require non-zero get_current_user_id().
3689          if ( ! is_user_logged_in() ) {
3690              wp_send_json_error( 'unauthenticated', 401 );
3691          }
3692  
3693          if ( ! $this->is_preview() ) {
3694              wp_send_json_error( 'not_preview', 400 );
3695          }
3696  
3697          if ( ! check_ajax_referer( 'customize_dismiss_autosave_or_lock', 'nonce', false ) ) {
3698              wp_send_json_error( 'invalid_nonce', 403 );
3699          }
3700  
3701          $changeset_post_id = $this->changeset_post_id();
3702          $dismiss_lock      = ! empty( $_POST['dismiss_lock'] );
3703          $dismiss_autosave  = ! empty( $_POST['dismiss_autosave'] );
3704  
3705          if ( $dismiss_lock ) {
3706              if ( empty( $changeset_post_id ) && ! $dismiss_autosave ) {
3707                  wp_send_json_error( 'no_changeset_to_dismiss_lock', 404 );
3708              }
3709              if ( ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->edit_post, $changeset_post_id ) && ! $dismiss_autosave ) {
3710                  wp_send_json_error( 'cannot_remove_changeset_lock', 403 );
3711              }
3712  
3713              delete_post_meta( $changeset_post_id, '_edit_lock' );
3714  
3715              if ( ! $dismiss_autosave ) {
3716                  wp_send_json_success( 'changeset_lock_dismissed' );
3717              }
3718          }
3719  
3720          if ( $dismiss_autosave ) {
3721              if ( empty( $changeset_post_id ) || 'auto-draft' === get_post_status( $changeset_post_id ) ) {
3722                  $dismissed = $this->dismiss_user_auto_draft_changesets();
3723                  if ( $dismissed > 0 ) {
3724                      wp_send_json_success( 'auto_draft_dismissed' );
3725                  } else {
3726                      wp_send_json_error( 'no_auto_draft_to_delete', 404 );
3727                  }
3728              } else {
3729                  $revision = wp_get_post_autosave( $changeset_post_id, get_current_user_id() );
3730  
3731                  if ( $revision ) {
3732                      if ( ! current_user_can( get_post_type_object( 'customize_changeset' )->cap->delete_post, $changeset_post_id ) ) {
3733                          wp_send_json_error( 'cannot_delete_autosave_revision', 403 );
3734                      }
3735  
3736                      if ( ! wp_delete_post( $revision->ID, true ) ) {
3737                          wp_send_json_error( 'autosave_revision_deletion_failure', 500 );
3738                      } else {
3739                          wp_send_json_success( 'autosave_revision_deleted' );
3740                      }
3741                  } else {
3742                      wp_send_json_error( 'no_autosave_revision_to_delete', 404 );
3743                  }
3744              }
3745          }
3746  
3747          wp_send_json_error( 'unknown_error', 500 );
3748      }
3749  
3750      /**
3751       * Adds a customize setting.
3752       *
3753       * @since 3.4.0
3754       * @since 4.5.0 Return added WP_Customize_Setting instance.
3755       *
3756       * @see WP_Customize_Setting::__construct()
3757       * @link https://developer.wordpress.org/themes/customize-api
3758       *
3759       * @param WP_Customize_Setting|string $id   Customize Setting object, or ID.
3760       * @param array                       $args Optional. Array of properties for the new Setting object.
3761       *                                          See WP_Customize_Setting::__construct() for information
3762       *                                          on accepted arguments. Default empty array.
3763       * @return WP_Customize_Setting The instance of the setting that was added.
3764       */
3765  	public function add_setting( $id, $args = array() ) {
3766          if ( $id instanceof WP_Customize_Setting ) {
3767              $setting = $id;
3768          } else {
3769              $class = 'WP_Customize_Setting';
3770  
3771              /** This filter is documented in wp-includes/class-wp-customize-manager.php */
3772              $args = apply_filters( 'customize_dynamic_setting_args', $args, $id );
3773  
3774              /** This filter is documented in wp-includes/class-wp-customize-manager.php */
3775              $class = apply_filters( 'customize_dynamic_setting_class', $class, $id, $args );
3776  
3777              $setting = new $class( $this, $id, $args );
3778          }
3779  
3780          $this->settings[ $setting->id ] = $setting;
3781          return $setting;
3782      }
3783  
3784      /**
3785       * Registers any dynamically-created settings, such as those from $_POST['customized']
3786       * that have no corresponding setting created.
3787       *
3788       * This is a mechanism to "wake up" settings that have been dynamically created
3789       * on the front end and have been sent to WordPress in `$_POST['customized']`. When WP
3790       * loads, the dynamically-created settings then will get created and previewed
3791       * even though they are not directly created statically with code.
3792       *
3793       * @since 4.2.0
3794       *
3795       * @param array $setting_ids The setting IDs to add.
3796       * @return array The WP_Customize_Setting objects added.
3797       */
3798  	public function add_dynamic_settings( $setting_ids ) {
3799          $new_settings = array();
3800          foreach ( $setting_ids as $setting_id ) {
3801              // Skip settings already created.
3802              if ( $this->get_setting( $setting_id ) ) {
3803                  continue;
3804              }
3805  
3806              $setting_args  = false;
3807              $setting_class = 'WP_Customize_Setting';
3808  
3809              /**
3810               * Filters a dynamic setting's constructor args.
3811               *
3812               * For a dynamic setting to be registered, this filter must be employed
3813               * to override the default false value with an array of args to pass to
3814               * the WP_Customize_Setting constructor.
3815               *
3816               * @since 4.2.0
3817               *
3818               * @param false|array $setting_args The arguments to the WP_Customize_Setting constructor.
3819               * @param string      $setting_id   ID for dynamic setting, usually coming from `$_POST['customized']`.
3820               */
3821              $setting_args = apply_filters( 'customize_dynamic_setting_args', $setting_args, $setting_id );
3822              if ( false === $setting_args ) {
3823                  continue;
3824              }
3825  
3826              /**
3827               * Allow non-statically created settings to be constructed with custom WP_Customize_Setting subclass.
3828               *
3829               * @since 4.2.0
3830               *
3831               * @param string $setting_class WP_Customize_Setting or a subclass.
3832               * @param string $setting_id    ID for dynamic setting, usually coming from `$_POST['customized']`.
3833               * @param array  $setting_args  WP_Customize_Setting or a subclass.
3834               */
3835              $setting_class = apply_filters( 'customize_dynamic_setting_class', $setting_class, $setting_id, $setting_args );
3836  
3837              $setting = new $setting_class( $this, $setting_id, $setting_args );
3838  
3839              $this->add_setting( $setting );
3840              $new_settings[] = $setting;
3841          }
3842          return $new_settings;
3843      }
3844  
3845      /**
3846       * Retrieves a customize setting.
3847       *
3848       * @since 3.4.0
3849       *
3850       * @param string $id Customize Setting ID.
3851       * @return WP_Customize_Setting|void The setting, if set.
3852       */
3853  	public function get_setting( $id ) {
3854          if ( isset( $this->settings[ $id ] ) ) {
3855              return $this->settings[ $id ];
3856          }
3857      }
3858  
3859      /**
3860       * Removes a customize setting.
3861       *
3862       * Note that removing the setting doesn't destroy the WP_Customize_Setting instance or remove its filters.
3863       *
3864       * @since 3.4.0
3865       *
3866       * @param string $id Customize Setting ID.
3867       */
3868  	public function remove_setting( $id ) {
3869          unset( $this->settings[ $id ] );
3870      }
3871  
3872      /**
3873       * Adds a customize panel.
3874       *
3875       * @since 4.0.0
3876       * @since 4.5.0 Return added WP_Customize_Panel instance.
3877       *
3878       * @see WP_Customize_Panel::__construct()
3879       *
3880       * @param WP_Customize_Panel|string $id   Customize Panel object, or ID.
3881       * @param array                     $args Optional. Array of properties for the new Panel object.
3882       *                                        See WP_Customize_Panel::__construct() for information
3883       *                                        on accepted arguments. Default empty array.
3884       * @return WP_Customize_Panel The instance of the panel that was added.
3885       */
3886  	public function add_panel( $id, $args = array() ) {
3887          if ( $id instanceof WP_Customize_Panel ) {
3888              $panel = $id;
3889          } else {
3890              $panel = new WP_Customize_Panel( $this, $id, $args );
3891          }
3892  
3893          $this->panels[ $panel->id ] = $panel;
3894          return $panel;
3895      }
3896  
3897      /**
3898       * Retrieves a customize panel.
3899       *
3900       * @since 4.0.0
3901       *
3902       * @param string $id Panel ID to get.
3903       * @return WP_Customize_Panel|void Requested panel instance, if set.
3904       */
3905  	public function get_panel( $id ) {
3906          if ( isset( $this->panels[ $id ] ) ) {
3907              return $this->panels[ $id ];
3908          }
3909      }
3910  
3911      /**
3912       * Removes a customize panel.
3913       *
3914       * Note that removing the panel doesn't destroy the WP_Customize_Panel instance or remove its filters.
3915       *
3916       * @since 4.0.0
3917       *
3918       * @param string $id Panel ID to remove.
3919       */
3920  	public function remove_panel( $id ) {
3921          // Removing core components this way is _doing_it_wrong().
3922          if ( in_array( $id, $this->components, true ) ) {
3923              _doing_it_wrong(
3924                  __METHOD__,
3925                  sprintf(
3926                      /* translators: 1: Panel ID, 2: Link to 'customize_loaded_components' filter reference. */
3927                      __( 'Removing %1$s manually will cause PHP warnings. Use the %2$s filter instead.' ),
3928                      $id,
3929                      sprintf(
3930                          '<a href="%1$s">%2$s</a>',
3931                          esc_url( 'https://developer.wordpress.org/reference/hooks/customize_loaded_components/' ),
3932                          '<code>customize_loaded_components</code>'
3933                      )
3934                  ),
3935                  '4.5.0'
3936              );
3937          }
3938          unset( $this->panels[ $id ] );
3939      }
3940  
3941      /**
3942       * Registers a customize panel type.
3943       *
3944       * Registered types are eligible to be rendered via JS and created dynamically.
3945       *
3946       * @since 4.3.0
3947       *
3948       * @see WP_Customize_Panel
3949       *
3950       * @param string $panel Name of a custom panel which is a subclass of WP_Customize_Panel.
3951       */
3952  	public function register_panel_type( $panel ) {
3953          $this->registered_panel_types[] = $panel;
3954      }
3955  
3956      /**
3957       * Renders JS templates for all registered panel types.
3958       *
3959       * @since 4.3.0
3960       */
3961  	public function render_panel_templates() {
3962          foreach ( $this->registered_panel_types as $panel_type ) {
3963              $panel = new $panel_type( $this, 'temp', array() );
3964              $panel->print_template();
3965          }
3966      }
3967  
3968      /**
3969       * Adds a customize section.
3970       *
3971       * @since 3.4.0
3972       * @since 4.5.0 Return added WP_Customize_Section instance.
3973       *
3974       * @see WP_Customize_Section::__construct()
3975       *
3976       * @param WP_Customize_Section|string $id   Customize Section object, or ID.
3977       * @param array                       $args Optional. Array of properties for the new Section object.
3978       *                                          See WP_Customize_Section::__construct() for information
3979       *                                          on accepted arguments. Default empty array.
3980       * @return WP_Customize_Section The instance of the section that was added.
3981       */
3982  	public function add_section( $id, $args = array() ) {
3983          if ( $id instanceof WP_Customize_Section ) {
3984              $section = $id;
3985          } else {
3986              $section = new WP_Customize_Section( $this, $id, $args );
3987          }
3988  
3989          $this->sections[ $section->id ] = $section;
3990          return $section;
3991      }
3992  
3993      /**
3994       * Retrieves a customize section.
3995       *
3996       * @since 3.4.0
3997       *
3998       * @param string $id Section ID.
3999       * @return WP_Customize_Section|void The section, if set.
4000       */
4001  	public function get_section( $id ) {
4002          if ( isset( $this->sections[ $id ] ) ) {
4003              return $this->sections[ $id ];
4004          }
4005      }
4006  
4007      /**
4008       * Removes a customize section.
4009       *
4010       * Note that removing the section doesn't destroy the WP_Customize_Section instance or remove its filters.
4011       *
4012       * @since 3.4.0
4013       *
4014       * @param string $id Section ID.
4015       */
4016  	public function remove_section( $id ) {
4017          unset( $this->sections[ $id ] );
4018      }
4019  
4020      /**
4021       * Registers a customize section type.
4022       *
4023       * Registered types are eligible to be rendered via JS and created dynamically.
4024       *
4025       * @since 4.3.0
4026       *
4027       * @see WP_Customize_Section
4028       *
4029       * @param string $section Name of a custom section which is a subclass of WP_Customize_Section.
4030       */
4031  	public function register_section_type( $section ) {
4032          $this->registered_section_types[] = $section;
4033      }
4034  
4035      /**
4036       * Renders JS templates for all registered section types.
4037       *
4038       * @since 4.3.0
4039       */
4040  	public function render_section_templates() {
4041          foreach ( $this->registered_section_types as $section_type ) {
4042              $section = new $section_type( $this, 'temp', array() );
4043              $section->print_template();
4044          }
4045      }
4046  
4047      /**
4048       * Adds a customize control.
4049       *
4050       * @since 3.4.0
4051       * @since 4.5.0 Return added WP_Customize_Control instance.
4052       *
4053       * @see WP_Customize_Control::__construct()
4054       *
4055       * @param WP_Customize_Control|string $id   Customize Control object, or ID.
4056       * @param array                       $args Optional. Array of properties for the new Control object.
4057       *                                          See WP_Customize_Control::__construct() for information
4058       *                                          on accepted arguments. Default empty array.
4059       * @return WP_Customize_Control The instance of the control that was added.
4060       */
4061  	public function add_control( $id, $args = array() ) {
4062          if ( $id instanceof WP_Customize_Control ) {
4063              $control = $id;
4064          } else {
4065              $control = new WP_Customize_Control( $this, $id, $args );
4066          }
4067  
4068          $this->controls[ $control->id ] = $control;
4069          return $control;
4070      }
4071  
4072      /**
4073       * Retrieves a customize control.
4074       *
4075       * @since 3.4.0
4076       *
4077       * @param string $id ID of the control.
4078       * @return WP_Customize_Control|void The control object, if set.
4079       */
4080  	public function get_control( $id ) {
4081          if ( isset( $this->controls[ $id ] ) ) {
4082              return $this->controls[ $id ];
4083          }
4084      }
4085  
4086      /**
4087       * Removes a customize control.
4088       *
4089       * Note that removing the control doesn't destroy the WP_Customize_Control instance or remove its filters.
4090       *
4091       * @since 3.4.0
4092       *
4093       * @param string $id ID of the control.
4094       */
4095  	public function remove_control( $id ) {
4096          unset( $this->controls[ $id ] );
4097      }
4098  
4099      /**
4100       * Registers a customize control type.
4101       *
4102       * Registered types are eligible to be rendered via JS and created dynamically.
4103       *
4104       * @since 4.1.0
4105       *
4106       * @param string $control Name of a custom control which is a subclass of
4107       *                        WP_Customize_Control.
4108       */
4109  	public function register_control_type( $control ) {
4110          $this->registered_control_types[] = $control;
4111      }
4112  
4113      /**
4114       * Renders JS templates for all registered control types.
4115       *
4116       * @since 4.1.0
4117       */
4118  	public function render_control_templates() {
4119          if ( $this->branching() ) {
4120              $l10n = array(
4121                  /* translators: %s: User who is customizing the changeset in customizer. */
4122                  'locked'                => __( '%s is already customizing this changeset. Please wait until they are done to try customizing. Your latest changes have been autosaved.' ),
4123                  /* translators: %s: User who is customizing the changeset in customizer. */
4124                  'locked_allow_override' => __( '%s is already customizing this changeset. Do you want to take over?' ),
4125              );
4126          } else {
4127              $l10n = array(
4128                  /* translators: %s: User who is customizing the changeset in customizer. */
4129                  'locked'                => __( '%s is already customizing this site. Please wait until they are done to try customizing. Your latest changes have been autosaved.' ),
4130                  /* translators: %s: User who is customizing the changeset in customizer. */
4131                  'locked_allow_override' => __( '%s is already customizing this site. Do you want to take over?' ),
4132              );
4133          }
4134  
4135          foreach ( $this->registered_control_types as $control_type ) {
4136              $control = new $control_type(
4137                  $this,
4138                  'temp',
4139                  array(
4140                      'settings' => array(),
4141                  )
4142              );
4143              $control->print_template();
4144          }
4145          ?>
4146  
4147          <script type="text/html" id="tmpl-customize-control-default-content">
4148              <#
4149              var inputId = _.uniqueId( 'customize-control-default-input-' );
4150              var descriptionId = _.uniqueId( 'customize-control-default-description-' );
4151              var describedByAttr = data.description ? ' aria-describedby="' + descriptionId + '" ' : '';
4152              #>
4153              <# switch ( data.type ) {
4154                  case 'checkbox': #>
4155                      <span class="customize-inside-control-row">
4156                          <input
4157                              id="{{ inputId }}"
4158                              {{{ describedByAttr }}}
4159                              type="checkbox"
4160                              value="{{ data.value }}"
4161                              data-customize-setting-key-link="default"
4162                          >
4163                          <label for="{{ inputId }}">
4164                              {{ data.label }}
4165                          </label>
4166                          <# if ( data.description ) { #>
4167                              <span id="{{ descriptionId }}" class="description customize-control-description">{{{ data.description }}}</span>
4168                          <# } #>
4169                      </span>
4170                      <#
4171                      break;
4172                  case 'radio':
4173                      if ( ! data.choices ) {
4174                          return;
4175                      }
4176                      #>
4177                      <# if ( data.label ) { #>
4178                          <label for="{{ inputId }}" class="customize-control-title">
4179                              {{ data.label }}
4180                          </label>
4181                      <# } #>
4182                      <# if ( data.description ) { #>
4183                          <span id="{{ descriptionId }}" class="description customize-control-description">{{{ data.description }}}</span>
4184                      <# } #>
4185                      <# _.each( data.choices, function( val, key ) { #>
4186                          <span class="customize-inside-control-row">
4187                              <#
4188                              var value, text;
4189                              if ( _.isObject( val ) ) {
4190                                  value = val.value;
4191                                  text = val.text;
4192                              } else {
4193                                  value = key;
4194                                  text = val;
4195                              }
4196                              #>
4197                              <input
4198                                  id="{{ inputId + '-' + value }}"
4199                                  type="radio"
4200                                  value="{{ value }}"
4201                                  name="{{ inputId }}"
4202                                  data-customize-setting-key-link="default"
4203                                  {{{ describedByAttr }}}
4204                              >
4205                              <label for="{{ inputId + '-' + value }}">{{ text }}</label>
4206                          </span>
4207                      <# } ); #>
4208                      <#
4209                      break;
4210                  default:
4211                      #>
4212                      <# if ( data.label ) { #>
4213                          <label for="{{ inputId }}" class="customize-control-title">
4214                              {{ data.label }}
4215                          </label>
4216                      <# } #>
4217                      <# if ( data.description ) { #>
4218                          <span id="{{ descriptionId }}" class="description customize-control-description">{{{ data.description }}}</span>
4219                      <# } #>
4220  
4221                      <#
4222                      var inputAttrs = {
4223                          id: inputId,
4224                          'data-customize-setting-key-link': 'default'
4225                      };
4226                      if ( 'textarea' === data.type ) {
4227                          inputAttrs.rows = '5';
4228                      } else if ( 'button' === data.type ) {
4229                          inputAttrs['class'] = 'button button-secondary';
4230                          inputAttrs.type = 'button';
4231                      } else {
4232                          inputAttrs.type = data.type;
4233                      }
4234                      if ( data.description ) {
4235                          inputAttrs['aria-describedby'] = descriptionId;
4236                      }
4237                      _.extend( inputAttrs, data.input_attrs );
4238                      #>
4239  
4240                      <# if ( 'button' === data.type ) { #>
4241                          <button
4242                              <# _.each( _.extend( inputAttrs ), function( value, key ) { #>
4243                                  {{{ key }}}="{{ value }}"
4244                              <# } ); #>
4245                          >{{ inputAttrs.value }}</button>
4246                      <# } else if ( 'textarea' === data.type ) { #>
4247                          <textarea
4248                              <# _.each( _.extend( inputAttrs ), function( value, key ) { #>
4249                                  {{{ key }}}="{{ value }}"
4250                              <# }); #>
4251                          >{{ inputAttrs.value }}</textarea>
4252                      <# } else if ( 'select' === data.type ) { #>
4253                          <# delete inputAttrs.type; #>
4254                          <select
4255                              <# _.each( _.extend( inputAttrs ), function( value, key ) { #>
4256                                  {{{ key }}}="{{ value }}"
4257                              <# }); #>
4258                              >
4259                              <# _.each( data.choices, function( val, key ) { #>
4260                                  <#
4261                                  var value, text;
4262                                  if ( _.isObject( val ) ) {
4263                                      value = val.value;
4264                                      text = val.text;
4265                                  } else {
4266                                      value = key;
4267                                      text = val;
4268                                  }
4269                                  #>
4270                                  <option value="{{ value }}">{{ text }}</option>
4271                              <# } ); #>
4272                          </select>
4273                      <# } else { #>
4274                          <input
4275                              <# _.each( _.extend( inputAttrs ), function( value, key ) { #>
4276                                  {{{ key }}}="{{ value }}"
4277                              <# }); #>
4278                              >
4279                      <# } #>
4280              <# } #>
4281          </script>
4282  
4283          <script type="text/html" id="tmpl-customize-notification">
4284              <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 }}">
4285                  <div class="notification-message">{{{ data.message || data.code }}}</div>
4286                  <# if ( data.dismissible ) { #>
4287                      <button type="button" class="notice-dismiss"><span class="screen-reader-text"><?php _e( 'Dismiss' ); ?></span></button>
4288                  <# } #>
4289              </li>
4290          </script>
4291  
4292          <script type="text/html" id="tmpl-customize-changeset-locked-notification">
4293              <li class="notice notice-{{ data.type || 'info' }} {{ data.containerClasses || '' }}" data-code="{{ data.code }}" data-type="{{ data.type }}">
4294                  <div class="notification-message customize-changeset-locked-message">
4295                      <img class="customize-changeset-locked-avatar" src="{{ data.lockUser.avatar }}" alt="{{ data.lockUser.name }}" />
4296                      <p class="currently-editing">
4297                          <# if ( data.message ) { #>
4298                              {{{ data.message }}}
4299                          <# } else if ( data.allowOverride ) { #>
4300                              <?php
4301                              echo esc_html( sprintf( $l10n['locked_allow_override'], '{{ data.lockUser.name }}' ) );
4302                              ?>
4303                          <# } else { #>
4304                              <?php
4305                              echo esc_html( sprintf( $l10n['locked'], '{{ data.lockUser.name }}' ) );
4306                              ?>
4307                          <# } #>
4308                      </p>
4309                      <p class="notice notice-error notice-alt" hidden></p>
4310                      <p class="action-buttons">
4311                          <# if ( data.returnUrl !== data.previewUrl ) { #>
4312                              <a class="button customize-notice-go-back-button" href="{{ data.returnUrl }}"><?php _e( 'Go back' ); ?></a>
4313                          <# } #>
4314                          <a class="button customize-notice-preview-button" href="{{ data.frontendPreviewUrl }}"><?php _e( 'Preview' ); ?></a>
4315                          <# if ( data.allowOverride ) { #>
4316                              <button class="button button-primary wp-tab-last customize-notice-take-over-button"><?php _e( 'Take over' ); ?></button>
4317                          <# } #>
4318                      </p>
4319                  </div>
4320              </li>
4321          </script>
4322  
4323          <script type="text/html" id="tmpl-customize-code-editor-lint-error-notification">
4324              <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 }}">
4325                  <div class="notification-message">{{{ data.message || data.code }}}</div>
4326  
4327                  <p>
4328                      <# var elementId = 'el-' + String( Math.random() ); #>
4329                      <input id="{{ elementId }}" type="checkbox">
4330                      <label for="{{ elementId }}"><?php _e( 'Update anyway, even though it might break your site?' ); ?></label>
4331                  </p>
4332              </li>
4333          </script>
4334  
4335          <?php
4336          /* The following template is obsolete in core but retained for plugins. */
4337          ?>
4338          <script type="text/html" id="tmpl-customize-control-notifications">
4339              <ul>
4340                  <# _.each( data.notifications, function( notification ) { #>
4341                      <li class="notice notice-{{ notification.type || 'info' }} {{ data.altNotice ? 'notice-alt' : '' }}" data-code="{{ notification.code }}" data-type="{{ notification.type }}">{{{ notification.message || notification.code }}}</li>
4342                  <# } ); #>
4343              </ul>
4344          </script>
4345  
4346          <script type="text/html" id="tmpl-customize-preview-link-control" >
4347              <# var elementPrefix = _.uniqueId( 'el' ) + '-' #>
4348              <p class="customize-control-title">
4349                  <?php esc_html_e( 'Share Preview Link' ); ?>
4350              </p>
4351              <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>
4352              <div class="customize-control-notifications-container"></div>
4353              <div class="preview-link-wrapper">
4354                  <label for="{{ elementPrefix }}customize-preview-link-input" class="screen-reader-text"><?php esc_html_e( 'Preview Link' ); ?></label>
4355                  <a href="" target="">
4356                      <span class="preview-control-element" data-component="url"></span>
4357                      <span class="screen-reader-text"><?php _e( '(opens in a new tab)' ); ?></span>
4358                  </a>
4359                  <input id="{{ elementPrefix }}customize-preview-link-input" readonly tabindex="-1" class="preview-control-element" data-component="input">
4360                  <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>
4361              </div>
4362          </script>
4363          <script type="text/html" id="tmpl-customize-selected-changeset-status-control">
4364              <# var inputId = _.uniqueId( 'customize-selected-changeset-status-control-input-' ); #>
4365              <# var descriptionId = _.uniqueId( 'customize-selected-changeset-status-control-description-' ); #>
4366              <# if ( data.label ) { #>
4367                  <label for="{{ inputId }}" class="customize-control-title">{{ data.label }}</label>
4368              <# } #>
4369              <# if ( data.description ) { #>
4370                  <span id="{{ descriptionId }}" class="description customize-control-description">{{{ data.description }}}</span>
4371              <# } #>
4372              <# _.each( data.choices, function( choice ) { #>
4373                  <# var choiceId = inputId + '-' + choice.status; #>
4374                  <span class="customize-inside-control-row">
4375                      <input id="{{ choiceId }}" type="radio" value="{{ choice.status }}" name="{{ inputId }}" data-customize-setting-key-link="default">
4376                      <label for="{{ choiceId }}">{{ choice.label }}</label>
4377                  </span>
4378              <# } ); #>
4379          </script>
4380          <?php
4381      }
4382  
4383      /**
4384       * Helper function to compare two objects by priority, ensuring sort stability via instance_number.
4385       *
4386       * @since 3.4.0
4387       * @deprecated 4.7.0 Use wp_list_sort()
4388       *
4389       * @param WP_Customize_Panel|WP_Customize_Section|WP_Customize_Control $a Object A.
4390       * @param WP_Customize_Panel|WP_Customize_Section|WP_Customize_Control $b Object B.
4391       * @return int
4392       */
4393  	protected function _cmp_priority( $a, $b ) {
4394          _deprecated_function( __METHOD__, '4.7.0', 'wp_list_sort' );
4395  
4396          if ( $a->priority === $b->priority ) {
4397              return $a->instance_number - $b->instance_number;
4398          } else {
4399              return $a->priority - $b->priority;
4400          }
4401      }
4402  
4403      /**
4404       * Prepares panels, sections, and controls.
4405       *
4406       * For each, check if required related components exist,
4407       * whether the user has the necessary capabilities,
4408       * and sort by priority.
4409       *
4410       * @since 3.4.0
4411       */
4412  	public function prepare_controls() {
4413  
4414          $controls       = array();
4415          $this->controls = wp_list_sort(
4416              $this->controls,
4417              array(
4418                  'priority'        => 'ASC',
4419                  'instance_number' => 'ASC',
4420              ),
4421              'ASC',
4422              true
4423          );
4424  
4425          foreach ( $this->controls as $id => $control ) {
4426              if ( ! isset( $this->sections[ $control->section ] ) || ! $control->check_capabilities() ) {
4427                  continue;
4428              }
4429  
4430              $this->sections[ $control->section ]->controls[] = $control;
4431              $controls[ $id ]                                 = $control;
4432          }
4433          $this->controls = $controls;
4434  
4435          // Prepare sections.
4436          $this->sections = wp_list_sort(
4437              $this->sections,
4438              array(
4439                  'priority'        => 'ASC',
4440                  'instance_number' => 'ASC',
4441              ),
4442              'ASC',
4443              true
4444          );
4445          $sections       = array();
4446  
4447          foreach ( $this->sections as $section ) {
4448              if ( ! $section->check_capabilities() ) {
4449                  continue;
4450              }
4451  
4452              $section->controls = wp_list_sort(
4453                  $section->controls,
4454                  array(
4455                      'priority'        => 'ASC',
4456                      'instance_number' => 'ASC',
4457                  )
4458              );
4459  
4460              if ( ! $section->panel ) {
4461                  // Top-level section.
4462                  $sections[ $section->id ] = $section;
4463              } else {
4464                  // This section belongs to a panel.
4465                  if ( isset( $this->panels [ $section->panel ] ) ) {
4466                      $this->panels[ $section->panel ]->sections[ $section->id ] = $section;
4467                  }
4468              }
4469          }
4470          $this->sections = $sections;
4471  
4472          // Prepare panels.
4473          $this->panels = wp_list_sort(
4474              $this->panels,
4475              array(
4476                  'priority'        => 'ASC',
4477                  'instance_number' => 'ASC',
4478              ),
4479              'ASC',
4480              true
4481          );
4482          $panels       = array();
4483  
4484          foreach ( $this->panels as $panel ) {
4485              if ( ! $panel->check_capabilities() ) {
4486                  continue;
4487              }
4488  
4489              $panel->sections      = wp_list_sort(
4490                  $panel->sections,
4491                  array(
4492                      'priority'        => 'ASC',
4493                      'instance_number' => 'ASC',
4494                  ),
4495                  'ASC',
4496                  true
4497              );
4498              $panels[ $panel->id ] = $panel;
4499          }
4500          $this->panels = $panels;
4501  
4502          // Sort panels and top-level sections together.
4503          $this->containers = array_merge( $this->panels, $this->sections );
4504          $this->containers = wp_list_sort(
4505              $this->containers,
4506              array(
4507                  'priority'        => 'ASC',
4508                  'instance_number' => 'ASC',
4509              ),
4510              'ASC',
4511              true
4512          );
4513      }
4514  
4515      /**
4516       * Enqueues scripts for customize controls.
4517       *
4518       * @since 3.4.0
4519       */
4520  	public function enqueue_control_scripts() {
4521          foreach ( $this->controls as $control ) {
4522              $control->enqueue();
4523          }
4524  
4525          if ( ! is_multisite() && ( current_user_can( 'install_themes' ) || current_user_can( 'update_themes' ) || current_user_can( 'delete_themes' ) ) ) {
4526              wp_enqueue_script( 'updates' );
4527              wp_localize_script(
4528                  'updates',
4529                  '_wpUpdatesItemCounts',
4530                  array(
4531                      'totals' => wp_get_update_data(),
4532                  )
4533              );
4534          }
4535      }
4536  
4537      /**
4538       * Determines whether the user agent is iOS.
4539       *
4540       * @since 4.4.0
4541       *
4542       * @return bool Whether the user agent is iOS.
4543       */
4544  	public function is_ios() {
4545          return wp_is_mobile() && preg_match( '/iPad|iPod|iPhone/', $_SERVER['HTTP_USER_AGENT'] );
4546      }
4547  
4548      /**
4549       * Gets the template string for the Customizer pane document title.
4550       *
4551       * @since 4.4.0
4552       *
4553       * @return string The template string for the document title.
4554       */
4555  	public function get_document_title_template() {
4556          if ( $this->is_theme_active() ) {
4557              /* translators: %s: Document title from the preview. */
4558              $document_title_tmpl = __( 'Customize: %s' );
4559          } else {
4560              /* translators: %s: Document title from the preview. */
4561              $document_title_tmpl = __( 'Live Preview: %s' );
4562          }
4563          $document_title_tmpl = html_entity_decode( $document_title_tmpl, ENT_QUOTES, 'UTF-8' ); // Because exported to JS and assigned to document.title.
4564          return $document_title_tmpl;
4565      }
4566  
4567      /**
4568       * Sets the initial URL to be previewed.
4569       *
4570       * URL is validated.
4571       *
4572       * @since 4.4.0
4573       *
4574       * @param string $preview_url URL to be previewed.
4575       */
4576  	public function set_preview_url( $preview_url ) {
4577          $preview_url       = esc_url_raw( $preview_url );
4578          $this->preview_url = wp_validate_redirect( $preview_url, home_url( '/' ) );
4579      }
4580  
4581      /**
4582       * Gets the initial URL to be previewed.
4583       *
4584       * @since 4.4.0
4585       *
4586       * @return string URL being previewed.
4587       */
4588  	public function get_preview_url() {
4589          if ( empty( $this->preview_url ) ) {
4590              $preview_url = home_url( '/' );
4591          } else {
4592              $preview_url = $this->preview_url;
4593          }
4594          return $preview_url;
4595      }
4596  
4597      /**
4598       * Determines whether the admin and the frontend are on different domains.
4599       *
4600       * @since 4.7.0
4601       *
4602       * @return bool Whether cross-domain.
4603       */
4604  	public function is_cross_domain() {
4605          $admin_origin = wp_parse_url( admin_url() );
4606          $home_origin  = wp_parse_url( home_url() );
4607          $cross_domain = ( strtolower( $admin_origin['host'] ) !== strtolower( $home_origin['host'] ) );
4608          return $cross_domain;
4609      }
4610  
4611      /**
4612       * Gets URLs allowed to be previewed.
4613       *
4614       * If the front end and the admin are served from the same domain, load the
4615       * preview over ssl if the Customizer is being loaded over ssl. This avoids
4616       * insecure content warnings. This is not attempted if the admin and front end
4617       * are on different domains to avoid the case where the front end doesn't have
4618       * ssl certs. Domain mapping plugins can allow other urls in these conditions
4619       * using the customize_allowed_urls filter.
4620       *
4621       * @since 4.7.0
4622       *
4623       * @return array Allowed URLs.
4624       */
4625  	public function get_allowed_urls() {
4626          $allowed_urls = array( home_url( '/' ) );
4627  
4628          if ( is_ssl() && ! $this->is_cross_domain() ) {
4629              $allowed_urls[] = home_url( '/', 'https' );
4630          }
4631  
4632          /**
4633           * Filters the list of URLs allowed to be clicked and followed in the Customizer preview.
4634           *
4635           * @since 3.4.0
4636           *
4637           * @param string[] $allowed_urls An array of allowed URLs.
4638           */
4639          $allowed_urls = array_unique( apply_filters( 'customize_allowed_urls', $allowed_urls ) );
4640  
4641          return $allowed_urls;
4642      }
4643  
4644      /**
4645       * Gets messenger channel.
4646       *
4647       * @since 4.7.0
4648       *
4649       * @return string Messenger channel.
4650       */
4651  	public function get_messenger_channel() {
4652          return $this->messenger_channel;
4653      }
4654  
4655      /**
4656       * Sets URL to link the user to when closing the Customizer.
4657       *
4658       * URL is validated.
4659       *
4660       * @since 4.4.0
4661       *
4662       * @param string $return_url URL for return link.
4663       */
4664  	public function set_return_url( $return_url ) {
4665          $return_url       = esc_url_raw( $return_url );
4666          $return_url       = remove_query_arg( wp_removable_query_args(), $return_url );
4667          $return_url       = wp_validate_redirect( $return_url );
4668          $this->return_url = $return_url;
4669      }
4670  
4671      /**
4672       * Gets URL to link the user to when closing the Customizer.
4673       *
4674       * @since 4.4.0
4675       *
4676       * @global array $_registered_pages
4677       *
4678       * @return string URL for link to close Customizer.
4679       */
4680  	public function get_return_url() {
4681          global $_registered_pages;
4682  
4683          $referer                    = wp_get_referer();
4684          $excluded_referer_basenames = array( 'customize.php', 'wp-login.php' );
4685  
4686          if ( $this->return_url ) {
4687              $return_url = $this->return_url;
4688          } elseif ( $referer && ! in_array( wp_basename( parse_url( $referer, PHP_URL_PATH ) ), $excluded_referer_basenames, true ) ) {
4689              $return_url = $referer;
4690          } elseif ( $this->preview_url ) {
4691              $return_url = $this->preview_url;
4692          } else {
4693              $return_url = home_url( '/' );
4694          }
4695  
4696          $return_url_basename = wp_basename( parse_url( $this->return_url, PHP_URL_PATH ) );
4697          $return_url_query    = parse_url( $this->return_url, PHP_URL_QUERY );
4698  
4699          if ( 'themes.php' === $return_url_basename && $return_url_query ) {
4700              parse_str( $return_url_query, $query_vars );
4701  
4702              /*
4703               * If the return URL is a page added by a theme to the Appearance menu via add_submenu_page(),
4704               * verify that it belongs to the active theme, otherwise fall back to the Themes screen.
4705               */
4706              if ( isset( $query_vars['page'] ) && ! isset( $_registered_pages[ "appearance_page_{$query_vars['page']}" ] ) ) {
4707                  $return_url = admin_url( 'themes.php' );
4708              }
4709          }
4710  
4711          return $return_url;
4712      }
4713  
4714      /**
4715       * Sets the autofocused constructs.
4716       *
4717       * @since 4.4.0
4718       *
4719       * @param array $autofocus {
4720       *     Mapping of 'panel', 'section', 'control' to the ID which should be autofocused.
4721       *
4722       *     @type string $control ID for control to be autofocused.
4723       *     @type string $section ID for section to be autofocused.
4724       *     @type string $panel   ID for panel to be autofocused.
4725       * }
4726       */
4727  	public function set_autofocus( $autofocus ) {
4728          $this->autofocus = array_filter( wp_array_slice_assoc( $autofocus, array( 'panel', 'section', 'control' ) ), 'is_string' );
4729      }
4730  
4731      /**
4732       * Gets the autofocused constructs.
4733       *
4734       * @since 4.4.0
4735       *
4736       * @return string[] {
4737       *     Mapping of 'panel', 'section', 'control' to the ID which should be autofocused.
4738       *
4739       *     @type string $control ID for control to be autofocused.
4740       *     @type string $section ID for section to be autofocused.
4741       *     @type string $panel   ID for panel to be autofocused.
4742       * }
4743       */
4744  	public function get_autofocus() {
4745          return $this->autofocus;
4746      }
4747  
4748      /**
4749       * Gets nonces for the Customizer.
4750       *
4751       * @since 4.5.0
4752       *
4753       * @return array Nonces.
4754       */
4755  	public function get_nonces() {
4756          $nonces = array(
4757              'save'                     => wp_create_nonce( 'save-customize_' . $this->get_stylesheet() ),
4758              'preview'                  => wp_create_nonce( 'preview-customize_' . $this->get_stylesheet() ),
4759              'switch_themes'            => wp_create_nonce( 'switch_themes' ),
4760              'dismiss_autosave_or_lock' => wp_create_nonce( 'customize_dismiss_autosave_or_lock' ),
4761              'override_lock'            => wp_create_nonce( 'customize_override_changeset_lock' ),
4762              'trash'                    => wp_create_nonce( 'trash_customize_changeset' ),
4763          );
4764  
4765          /**
4766           * Filters nonces for Customizer.
4767           *
4768           * @since 4.2.0
4769           *
4770           * @param string[]             $nonces  Array of refreshed nonces for save and
4771           *                                      preview actions.
4772           * @param WP_Customize_Manager $manager WP_Customize_Manager instance.
4773           */
4774          $nonces = apply_filters( 'customize_refresh_nonces', $nonces, $this );
4775  
4776          return $nonces;
4777      }
4778  
4779      /**
4780       * Prints JavaScript settings for parent window.
4781       *
4782       * @since 4.4.0
4783       */
4784  	public function customize_pane_settings() {
4785  
4786          $login_url = add_query_arg(
4787              array(
4788                  'interim-login'   => 1,
4789                  'customize-login' => 1,
4790              ),
4791              wp_login_url()
4792          );
4793  
4794          // Ensure dirty flags are set for modified settings.
4795          foreach ( array_keys( $this->unsanitized_post_values() ) as $setting_id ) {
4796              $setting = $this->get_setting( $setting_id );
4797              if ( $setting ) {
4798                  $setting->dirty = true;
4799              }
4800          }
4801  
4802          $autosave_revision_post  = null;
4803          $autosave_autodraft_post = null;
4804          $changeset_post_id       = $this->changeset_post_id();
4805          if ( ! $this->saved_starter_content_changeset && ! $this->autosaved() ) {
4806              if ( $changeset_post_id ) {
4807                  if ( is_user_logged_in() ) {
4808                      $autosave_revision_post = wp_get_post_autosave( $changeset_post_id, get_current_user_id() );
4809                  }
4810              } else {
4811                  $autosave_autodraft_posts = $this->get_changeset_posts(
4812                      array(
4813                          'posts_per_page'            => 1,
4814                          'post_status'               => 'auto-draft',
4815                          'exclude_restore_dismissed' => true,
4816                      )
4817                  );
4818                  if ( ! empty( $autosave_autodraft_posts ) ) {
4819                      $autosave_autodraft_post = array_shift( $autosave_autodraft_posts );
4820                  }
4821              }
4822          }
4823  
4824          $current_user_can_publish = current_user_can( get_post_type_object( 'customize_changeset' )->cap->publish_posts );
4825  
4826          // @todo Include all of the status labels here from script-loader.php, and then allow it to be filtered.
4827          $status_choices = array();
4828          if ( $current_user_can_publish ) {
4829              $status_choices[] = array(
4830                  'status' => 'publish',
4831                  'label'  => __( 'Publish' ),
4832              );
4833          }
4834          $status_choices[] = array(
4835              'status' => 'draft',
4836              'label'  => __( 'Save Draft' ),
4837          );
4838          if ( $current_user_can_publish ) {
4839              $status_choices[] = array(
4840                  'status' => 'future',
4841                  'label'  => _x( 'Schedule', 'customizer changeset action/button label' ),
4842              );
4843          }
4844  
4845          // Prepare Customizer settings to pass to JavaScript.
4846          $changeset_post = null;
4847          if ( $changeset_post_id ) {
4848              $changeset_post = get_post( $changeset_post_id );
4849          }
4850  
4851          // Determine initial date to be at present or future, not past.
4852          $current_time = current_time( 'mysql', false );
4853          $initial_date = $current_time;
4854          if ( $changeset_post ) {
4855              $initial_date = get_the_time( 'Y-m-d H:i:s', $changeset_post->ID );
4856              if ( $initial_date < $current_time ) {
4857                  $initial_date = $current_time;
4858              }
4859          }
4860  
4861          $lock_user_id = false;
4862          if ( $this->changeset_post_id() ) {
4863              $lock_user_id = wp_check_post_lock( $this->changeset_post_id() );
4864          }
4865  
4866          $settings = array(
4867              'changeset'              => array(
4868                  'uuid'                  => $this->changeset_uuid(),
4869                  'branching'             => $this->branching(),
4870                  'autosaved'             => $this->autosaved(),
4871                  'hasAutosaveRevision'   => ! empty( $autosave_revision_post ),
4872                  'latestAutoDraftUuid'   => $autosave_autodraft_post ? $autosave_autodraft_post->post_name : null,
4873                  'status'                => $changeset_post ? $changeset_post->post_status : '',
4874                  'currentUserCanPublish' => $current_user_can_publish,
4875                  'publishDate'           => $initial_date,
4876                  'statusChoices'         => $status_choices,
4877                  'lockUser'              => $lock_user_id ? $this->get_lock_user_data( $lock_user_id ) : null,
4878              ),
4879              'initialServerDate'      => $current_time,
4880              'dateFormat'             => get_option( 'date_format' ),
4881              'timeFormat'             => get_option( 'time_format' ),
4882              'initialServerTimestamp' => floor( microtime( true ) * 1000 ),
4883              'initialClientTimestamp' => -1, // To be set with JS below.
4884              'timeouts'               => array(
4885                  'windowRefresh'           => 250,
4886                  'changesetAutoSave'       => AUTOSAVE_INTERVAL * 1000,
4887                  'keepAliveCheck'          => 2500,
4888                  'reflowPaneContents'      => 100,
4889                  'previewFrameSensitivity' => 2000,
4890              ),
4891              'theme'                  => array(
4892                  'stylesheet'  => $this->get_stylesheet(),
4893                  'active'      => $this->is_theme_active(),
4894                  '_canInstall' => current_user_can( 'install_themes' ),
4895              ),
4896              'url'                    => array(
4897                  'preview'       => esc_url_raw( $this->get_preview_url() ),
4898                  'return'        => esc_url_raw( $this->get_return_url() ),
4899                  'parent'        => esc_url_raw( admin_url() ),
4900                  'activated'     => esc_url_raw( home_url( '/' ) ),
4901                  'ajax'          => esc_url_raw( admin_url( 'admin-ajax.php', 'relative' ) ),
4902                  'allowed'       => array_map( 'esc_url_raw', $this->get_allowed_urls() ),
4903                  'isCrossDomain' => $this->is_cross_domain(),
4904                  'home'          => esc_url_raw( home_url( '/' ) ),
4905                  'login'         => esc_url_raw( $login_url ),
4906              ),
4907              'browser'                => array(
4908                  'mobile' => wp_is_mobile(),
4909                  'ios'    => $this->is_ios(),
4910              ),
4911              'panels'                 => array(),
4912              'sections'               => array(),
4913              'nonce'                  => $this->get_nonces(),
4914              'autofocus'              => $this->get_autofocus(),
4915              'documentTitleTmpl'      => $this->get_document_title_template(),
4916              'previewableDevices'     => $this->get_previewable_devices(),
4917              'l10n'                   => array(
4918                  'confirmDeleteTheme'   => __( 'Are you sure you want to delete this theme?' ),
4919                  /* translators: %d: Number of theme search results, which cannot currently consider singular vs. plural forms. */
4920                  'themeSearchResults'   => __( '%d themes found' ),
4921                  /* translators: %d: Number of themes being displayed, which cannot currently consider singular vs. plural forms. */
4922                  'announceThemeCount'   => __( 'Displaying %d themes' ),
4923                  /* translators: %s: Theme name. */
4924                  'announceThemeDetails' => __( 'Showing details for theme: %s' ),
4925              ),
4926          );
4927  
4928          // Temporarily disable installation in Customizer. See #42184.
4929          $filesystem_method = get_filesystem_method();
4930          ob_start();
4931          $filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
4932          ob_end_clean();
4933          if ( 'direct' !== $filesystem_method && ! $filesystem_credentials_are_stored ) {
4934              $settings['theme']['_filesystemCredentialsNeeded'] = true;
4935          }
4936  
4937          // Prepare Customize Section objects to pass to JavaScript.
4938          foreach ( $this->sections() as $id => $section ) {
4939              if ( $section->check_capabilities() ) {
4940                  $settings['sections'][ $id ] = $section->json();
4941              }
4942          }
4943  
4944          // Prepare Customize Panel objects to pass to JavaScript.
4945          foreach ( $this->panels() as $panel_id => $panel ) {
4946              if ( $panel->check_capabilities() ) {
4947                  $settings['panels'][ $panel_id ] = $panel->json();
4948                  foreach ( $panel->sections as $section_id => $section ) {
4949                      if ( $section->check_capabilities() ) {
4950                          $settings['sections'][ $section_id ] = $section->json();
4951                      }
4952                  }
4953              }
4954          }
4955  
4956          ?>
4957          <script type="text/javascript">
4958              var _wpCustomizeSettings = <?php echo wp_json_encode( $settings ); ?>;
4959              _wpCustomizeSettings.initialClientTimestamp = _.now();
4960              _wpCustomizeSettings.controls = {};
4961              _wpCustomizeSettings.settings = {};
4962              <?php
4963  
4964              // Serialize settings one by one to improve memory usage.
4965              echo "(function ( s ){\n";
4966              foreach ( $this->settings() as $setting ) {
4967                  if ( $setting->check_capabilities() ) {
4968                      printf(
4969                          "s[%s] = %s;\n",
4970                          wp_json_encode( $setting->id ),
4971                          wp_json_encode( $setting->json() )
4972                      );
4973                  }
4974              }
4975              echo "})( _wpCustomizeSettings.settings );\n";
4976  
4977              // Serialize controls one by one to improve memory usage.
4978              echo "(function ( c ){\n";
4979              foreach ( $this->controls() as $control ) {
4980                  if ( $control->check_capabilities() ) {
4981                      printf(
4982                          "c[%s] = %s;\n",
4983                          wp_json_encode( $control->id ),
4984                          wp_json_encode( $control->json() )
4985                      );
4986                  }
4987              }
4988              echo "})( _wpCustomizeSettings.controls );\n";
4989              ?>
4990          </script>
4991          <?php
4992      }
4993  
4994      /**
4995       * Returns a list of devices to allow previewing.
4996       *
4997       * @since 4.5.0
4998       *
4999       * @return array List of devices with labels and default setting.
5000       */
5001  	public function get_previewable_devices() {
5002          $devices = array(
5003              'desktop' => array(
5004                  'label'   => __( 'Enter desktop preview mode' ),
5005                  'default' => true,
5006              ),
5007              'tablet'  => array(
5008                  'label' => __( 'Enter tablet preview mode' ),
5009              ),
5010              'mobile'  => array(
5011                  'label' => __( 'Enter mobile preview mode' ),
5012              ),
5013          );
5014  
5015          /**
5016           * Filters the available devices to allow previewing in the Customizer.
5017           *
5018           * @since 4.5.0
5019           *
5020           * @see WP_Customize_Manager::get_previewable_devices()
5021           *
5022           * @param array $devices List of devices with labels and default setting.
5023           */
5024          $devices = apply_filters( 'customize_previewable_devices', $devices );
5025  
5026          return $devices;
5027      }
5028  
5029      /**
5030       * Registers some default controls.
5031       *
5032       * @since 3.4.0
5033       */
5034  	public function register_controls() {
5035  
5036          /* Themes (controls are loaded via ajax) */
5037  
5038          $this->add_panel(
5039              new WP_Customize_Themes_Panel(
5040                  $this,
5041                  'themes',
5042                  array(
5043                      'title'       => $this->theme()->display( 'Name' ),
5044                      'description' => (
5045                      '<p>' . __( 'Looking for a theme? You can search or browse the WordPress.org theme directory, install and preview themes, then activate them right here.' ) . '</p>' .
5046                      '<p>' . __( 'While previewing a new theme, you can continue to tailor things like widgets and menus, and explore theme-specific options.' ) . '</p>'
5047                      ),
5048                      'capability'  => 'switch_themes',
5049                      'priority'    => 0,
5050                  )
5051              )
5052          );
5053  
5054          $this->add_section(
5055              new WP_Customize_Themes_Section(
5056                  $this,
5057                  'installed_themes',
5058                  array(
5059                      'title'      => __( 'Installed themes' ),
5060                      'action'     => 'installed',
5061                      'capability' => 'switch_themes',
5062                      'panel'      => 'themes',
5063                      'priority'   => 0,
5064                  )
5065              )
5066          );
5067  
5068          if ( ! is_multisite() ) {
5069              $this->add_section(
5070                  new WP_Customize_Themes_Section(
5071                      $this,
5072                      'wporg_themes',
5073                      array(
5074                          'title'       => __( 'WordPress.org themes' ),
5075                          'action'      => 'wporg',
5076                          'filter_type' => 'remote',
5077                          'capability'  => 'install_themes',
5078                          'panel'       => 'themes',
5079                          'priority'    => 5,
5080                      )
5081                  )
5082              );
5083          }
5084  
5085          // Themes Setting (unused - the theme is considerably more fundamental to the Customizer experience).
5086          $this->add_setting(
5087              new WP_Customize_Filter_Setting(
5088                  $this,
5089                  'active_theme',
5090                  array(
5091                      'capability' => 'switch_themes',
5092                  )
5093              )
5094          );
5095  
5096          /* Site Identity */
5097  
5098          $this->add_section(
5099              'title_tagline',
5100              array(
5101                  'title'    => __( 'Site Identity' ),
5102                  'priority' => 20,
5103              )
5104          );
5105  
5106          $this->add_setting(
5107              'blogname',
5108              array(
5109                  'default'    => get_option( 'blogname' ),
5110                  'type'       => 'option',
5111                  'capability' => 'manage_options',
5112              )
5113          );
5114  
5115          $this->add_control(
5116              'blogname',
5117              array(
5118                  'label'   => __( 'Site Title' ),
5119                  'section' => 'title_tagline',
5120              )
5121          );
5122  
5123          $this->add_setting(
5124              'blogdescription',
5125              array(
5126                  'default'    => get_option( 'blogdescription' ),
5127                  'type'       => 'option',
5128                  'capability' => 'manage_options',
5129              )
5130          );
5131  
5132          $this->add_control(
5133              'blogdescription',
5134              array(
5135                  'label'   => __( 'Tagline' ),
5136                  'section' => 'title_tagline',
5137              )
5138          );
5139  
5140          // Add a setting to hide header text if the theme doesn't support custom headers.
5141          if ( ! current_theme_supports( 'custom-header', 'header-text' ) ) {
5142              $this->add_setting(
5143                  'header_text',
5144                  array(
5145                      'theme_supports'    => array( 'custom-logo', 'header-text' ),
5146                      'default'           => 1,
5147                      'sanitize_callback' => 'absint',
5148                  )
5149              );
5150  
5151              $this->add_control(
5152                  'header_text',
5153                  array(
5154                      'label'    => __( 'Display Site Title and Tagline' ),
5155                      'section'  => 'title_tagline',
5156                      'settings' => 'header_text',
5157                      'type'     => 'checkbox',
5158                  )
5159              );
5160          }
5161  
5162          $this->add_setting(
5163              'site_icon',
5164              array(
5165                  'type'       => 'option',
5166                  'capability' => 'manage_options',
5167                  'transport'  => 'postMessage', // Previewed with JS in the Customizer controls window.
5168              )
5169          );
5170  
5171          $this->add_control(
5172              new WP_Customize_Site_Icon_Control(
5173                  $this,
5174                  'site_icon',
5175                  array(
5176                      'label'       => __( 'Site Icon' ),
5177                      'description' => sprintf(
5178                          '<p>' . __( 'Site Icons are what you see in browser tabs, bookmark bars, and within the WordPress mobile apps. Upload one here!' ) . '</p>' .
5179                          /* translators: %s: Site icon size in pixels. */
5180                          '<p>' . __( 'Site Icons should be square and at least %s pixels.' ) . '</p>',
5181                          '<strong>512 &times; 512</strong>'
5182                      ),
5183                      'section'     => 'title_tagline',
5184                      'priority'    => 60,
5185                      'height'      => 512,
5186                      'width'       => 512,
5187                  )
5188              )
5189          );
5190  
5191          $this->add_setting(
5192              'custom_logo',
5193              array(
5194                  'theme_supports' => array( 'custom-logo' ),
5195                  'transport'      => 'postMessage',
5196              )
5197          );
5198  
5199          $custom_logo_args = get_theme_support( 'custom-logo' );
5200          $this->add_control(
5201              new WP_Customize_Cropped_Image_Control(
5202                  $this,
5203                  'custom_logo',
5204                  array(
5205                      'label'         => __( 'Logo' ),
5206                      'section'       => 'title_tagline',
5207                      'priority'      => 8,
5208                      'height'        => isset( $custom_logo_args[0]['height'] ) ? $custom_logo_args[0]['height'] : null,
5209                      'width'         => isset( $custom_logo_args[0]['width'] ) ? $custom_logo_args[0]['width'] : null,
5210                      'flex_height'   => isset( $custom_logo_args[0]['flex-height'] ) ? $custom_logo_args[0]['flex-height'] : null,
5211                      'flex_width'    => isset( $custom_logo_args[0]['flex-width'] ) ? $custom_logo_args[0]['flex-width'] : null,
5212                      'button_labels' => array(
5213                          'select'       => __( 'Select logo' ),
5214                          'change'       => __( 'Change logo' ),
5215                          'remove'       => __( 'Remove' ),
5216                          'default'      => __( 'Default' ),
5217                          'placeholder'  => __( 'No logo selected' ),
5218                          'frame_title'  => __( 'Select logo' ),
5219                          'frame_button' => __( 'Choose logo' ),
5220                      ),
5221                  )
5222              )
5223          );
5224  
5225          $this->selective_refresh->add_partial(
5226              'custom_logo',
5227              array(
5228                  'settings'            => array( 'custom_logo' ),
5229                  'selector'            => '.custom-logo-link',
5230                  'render_callback'     => array( $this, '_render_custom_logo_partial' ),
5231                  'container_inclusive' => true,
5232              )
5233          );
5234  
5235          /* Colors */
5236  
5237          $this->add_section(
5238              'colors',
5239              array(
5240                  'title'    => __( 'Colors' ),
5241                  'priority' => 40,
5242              )
5243          );
5244  
5245          $this->add_setting(
5246              'header_textcolor',
5247              array(
5248                  'theme_supports'       => array( 'custom-header', 'header-text' ),
5249                  'default'              => get_theme_support( 'custom-header', 'default-text-color' ),
5250  
5251                  'sanitize_callback'    => array( $this, '_sanitize_header_textcolor' ),
5252                  'sanitize_js_callback' => 'maybe_hash_hex_color',
5253              )
5254          );
5255  
5256          // Input type: checkbox.
5257          // With custom value.
5258          $this->add_control(
5259              'display_header_text',
5260              array(
5261                  'settings' => 'header_textcolor',
5262                  'label'    => __( 'Display Site Title and Tagline' ),
5263                  'section'  => 'title_tagline',
5264                  'type'     => 'checkbox',
5265                  'priority' => 40,
5266              )
5267          );
5268  
5269          $this->add_control(
5270              new WP_Customize_Color_Control(
5271                  $this,
5272                  'header_textcolor',
5273                  array(
5274                      'label'   => __( 'Header Text Color' ),
5275                      'section' => 'colors',
5276                  )
5277              )
5278          );
5279  
5280          // Input type: color.
5281          // With sanitize_callback.
5282          $this->add_setting(
5283              'background_color',
5284              array(
5285                  'default'              => get_theme_support( 'custom-background', 'default-color' ),
5286                  'theme_supports'       => 'custom-background',
5287  
5288                  'sanitize_callback'    => 'sanitize_hex_color_no_hash',
5289                  'sanitize_js_callback' => 'maybe_hash_hex_color',
5290              )
5291          );
5292  
5293          $this->add_control(
5294              new WP_Customize_Color_Control(
5295                  $this,
5296                  'background_color',
5297                  array(
5298                      'label'   => __( 'Background Color' ),
5299                      'section' => 'colors',
5300                  )
5301              )
5302          );
5303  
5304          /* Custom Header */
5305  
5306          if ( current_theme_supports( 'custom-header', 'video' ) ) {
5307              $title       = __( 'Header Media' );
5308              $description = '<p>' . __( 'If you add a video, the image will be used as a fallback while the video loads.' ) . '</p>';
5309  
5310              $width  = absint( get_theme_support( 'custom-header', 'width' ) );
5311              $height = absint( get_theme_support( 'custom-header', 'height' ) );
5312              if ( $width && $height ) {
5313                  $control_description = sprintf(
5314                      /* translators: 1: .mp4, 2: Header size in pixels. */
5315                      __( 'Upload your video in %1$s format and minimize its file size for best results. Your theme recommends dimensions of %2$s pixels.' ),
5316                      '<code>.mp4</code>',
5317                      sprintf( '<strong>%s &times; %s</strong>', $width, $height )
5318                  );
5319              } elseif ( $width ) {
5320                  $control_description = sprintf(
5321                      /* translators: 1: .mp4, 2: Header width in pixels. */
5322                      __( 'Upload your video in %1$s format and minimize its file size for best results. Your theme recommends a width of %2$s pixels.' ),
5323                      '<code>.mp4</code>',
5324                      sprintf( '<strong>%s</strong>', $width )
5325                  );
5326              } else {
5327                  $control_description = sprintf(
5328                      /* translators: 1: .mp4, 2: Header height in pixels. */
5329                      __( 'Upload your video in %1$s format and minimize its file size for best results. Your theme recommends a height of %2$s pixels.' ),
5330                      '<code>.mp4</code>',
5331                      sprintf( '<strong>%s</strong>', $height )
5332                  );
5333              }
5334          } else {
5335              $title               = __( 'Header Image' );
5336              $description         = '';
5337              $control_description = '';
5338          }
5339  
5340          $this->add_section(
5341              'header_image',
5342              array(
5343                  'title'          => $title,
5344                  'description'    => $description,
5345                  'theme_supports' => 'custom-header',
5346                  'priority'       => 60,
5347              )
5348          );
5349  
5350          $this->add_setting(
5351              'header_video',
5352              array(
5353                  'theme_supports'    => array( 'custom-header', 'video' ),
5354                  'transport'         => 'postMessage',
5355                  'sanitize_callback' => 'absint',
5356                  'validate_callback' => array( $this, '_validate_header_video' ),
5357              )
5358          );
5359  
5360          $this->add_setting(
5361              'external_header_video',
5362              array(
5363                  'theme_supports'    => array( 'custom-header', 'video' ),
5364                  'transport'         => 'postMessage',
5365                  'sanitize_callback' => array( $this, '_sanitize_external_header_video' ),
5366                  'validate_callback' => array( $this, '_validate_external_header_video' ),
5367              )
5368          );
5369  
5370          $this->add_setting(
5371              new WP_Customize_Filter_Setting(
5372                  $this,
5373                  'header_image',
5374                  array(
5375                      'default'        => sprintf( get_theme_support( 'custom-header', 'default-image' ), get_template_directory_uri(), get_stylesheet_directory_uri() ),
5376                      'theme_supports' => 'custom-header',
5377                  )
5378              )
5379          );
5380  
5381          $this->add_setting(
5382              new WP_Customize_Header_Image_Setting(
5383                  $this,
5384                  'header_image_data',
5385                  array(
5386                      'theme_supports' => 'custom-header',
5387                  )
5388              )
5389          );
5390  
5391          /*
5392           * Switch image settings to postMessage when video support is enabled since
5393           * it entails that the_custom_header_markup() will be used, and thus selective
5394           * refresh can be utilized.
5395           */
5396          if ( current_theme_supports( 'custom-header', 'video' ) ) {
5397              $this->get_setting( 'header_image' )->transport      = 'postMessage';
5398              $this->get_setting( 'header_image_data' )->transport = 'postMessage';
5399          }
5400  
5401          $this->add_control(
5402              new WP_Customize_Media_Control(
5403                  $this,
5404                  'header_video',
5405                  array(
5406                      'theme_supports'  => array( 'custom-header', 'video' ),
5407                      'label'           => __( 'Header Video' ),
5408                      'description'     => $control_description,
5409                      'section'         => 'header_image',
5410                      'mime_type'       => 'video',
5411                      'active_callback' => 'is_header_video_active',
5412                  )
5413              )
5414          );
5415  
5416          $this->add_control(
5417              'external_header_video',
5418              array(
5419                  'theme_supports'  => array( 'custom-header', 'video' ),
5420                  'type'            => 'url',
5421                  'description'     => __( 'Or, enter a YouTube URL:' ),
5422                  'section'         => 'header_image',
5423                  'active_callback' => 'is_header_video_active',
5424              )
5425          );
5426  
5427          $this->add_control( new WP_Customize_Header_Image_Control( $this ) );
5428  
5429          $this->selective_refresh->add_partial(
5430              'custom_header',
5431              array(
5432                  'selector'            => '#wp-custom-header',
5433                  'render_callback'     => 'the_custom_header_markup',
5434                  'settings'            => array( 'header_video', 'external_header_video', 'header_image' ), // The image is used as a video fallback here.
5435                  'container_inclusive' => true,
5436              )
5437          );
5438  
5439          /* Custom Background */
5440  
5441          $this->add_section(
5442              'background_image',
5443              array(
5444                  'title'          => __( 'Background Image' ),
5445                  'theme_supports' => 'custom-background',
5446                  'priority'       => 80,
5447              )
5448          );
5449  
5450          $this->add_setting(
5451              'background_image',
5452              array(
5453                  'default'           => get_theme_support( 'custom-background', 'default-image' ),
5454                  'theme_supports'    => 'custom-background',
5455                  'sanitize_callback' => array( $this, '_sanitize_background_setting' ),
5456              )
5457          );
5458  
5459          $this->add_setting(
5460              new WP_Customize_Background_Image_Setting(
5461                  $this,
5462                  'background_image_thumb',
5463                  array(
5464                      'theme_supports'    => 'custom-background',
5465                      'sanitize_callback' => array( $this, '_sanitize_background_setting' ),
5466                  )
5467              )
5468          );
5469  
5470          $this->add_control( new WP_Customize_Background_Image_Control( $this ) );
5471  
5472          $this->add_setting(
5473              'background_preset',
5474              array(
5475                  'default'           => get_theme_support( 'custom-background', 'default-preset' ),
5476                  'theme_supports'    => 'custom-background',
5477                  'sanitize_callback' => array( $this, '_sanitize_background_setting' ),
5478              )
5479          );
5480  
5481          $this->add_control(
5482              'background_preset',
5483              array(
5484                  'label'   => _x( 'Preset', 'Background Preset' ),
5485                  'section' => 'background_image',
5486                  'type'    => 'select',
5487                  'choices' => array(
5488                      'default' => _x( 'Default', 'Default Preset' ),
5489                      'fill'    => __( 'Fill Screen' ),
5490                      'fit'     => __( 'Fit to Screen' ),
5491                      'repeat'  => _x( 'Repeat', 'Repeat Image' ),
5492                      'custom'  => _x( 'Custom', 'Custom Preset' ),
5493                  ),
5494              )
5495          );
5496  
5497          $this->add_setting(
5498              'background_position_x',
5499              array(
5500                  'default'           => get_theme_support( 'custom-background', 'default-position-x' ),
5501                  'theme_supports'    => 'custom-background',
5502                  'sanitize_callback' => array( $this, '_sanitize_background_setting' ),
5503              )
5504          );
5505  
5506          $this->add_setting(
5507              'background_position_y',
5508              array(
5509                  'default'           => get_theme_support( 'custom-background', 'default-position-y' ),
5510                  'theme_supports'    => 'custom-background',
5511                  'sanitize_callback' => array( $this, '_sanitize_background_setting' ),
5512              )
5513          );
5514  
5515          $this->add_control(
5516              new WP_Customize_Background_Position_Control(
5517                  $this,
5518                  'background_position',
5519                  array(
5520                      'label'    => __( 'Image Position' ),
5521                      'section'  => 'background_image',
5522                      'settings' => array(
5523                          'x' => 'background_position_x',
5524                          'y' => 'background_position_y',
5525                      ),
5526                  )
5527              )
5528          );
5529  
5530          $this->add_setting(
5531              'background_size',
5532              array(
5533                  'default'           => get_theme_support( 'custom-background', 'default-size' ),
5534                  'theme_supports'    => 'custom-background',
5535                  'sanitize_callback' => array( $this, '_sanitize_background_setting' ),
5536              )
5537          );
5538  
5539          $this->add_control(
5540              'background_size',
5541              array(
5542                  'label'   => __( 'Image Size' ),
5543                  'section' => 'background_image',
5544                  'type'    => 'select',
5545                  'choices' => array(
5546                      'auto'    => _x( 'Original', 'Original Size' ),
5547                      'contain' => __( 'Fit to Screen' ),
5548                      'cover'   => __( 'Fill Screen' ),
5549                  ),
5550              )
5551          );
5552  
5553          $this->add_setting(
5554              'background_repeat',
5555              array(
5556                  'default'           => get_theme_support( 'custom-background', 'default-repeat' ),
5557                  'sanitize_callback' => array( $this, '_sanitize_background_setting' ),
5558                  'theme_supports'    => 'custom-background',
5559              )
5560          );
5561  
5562          $this->add_control(
5563              'background_repeat',
5564              array(
5565                  'label'   => __( 'Repeat Background Image' ),
5566                  'section' => 'background_image',
5567                  'type'    => 'checkbox',
5568              )
5569          );
5570  
5571          $this->add_setting(
5572              'background_attachment',
5573              array(
5574                  'default'           => get_theme_support( 'custom-background', 'default-attachment' ),
5575                  'sanitize_callback' => array( $this, '_sanitize_background_setting' ),
5576                  'theme_supports'    => 'custom-background',
5577              )
5578          );
5579  
5580          $this->add_control(
5581              'background_attachment',
5582              array(
5583                  'label'   => __( 'Scroll with Page' ),
5584                  'section' => 'background_image',
5585                  'type'    => 'checkbox',
5586              )
5587          );
5588  
5589          // If the theme is using the default background callback, we can update
5590          // the background CSS using postMessage.
5591          if ( get_theme_support( 'custom-background', 'wp-head-callback' ) === '_custom_background_cb' ) {
5592              foreach ( array( 'color', 'image', 'preset', 'position_x', 'position_y', 'size', 'repeat', 'attachment' ) as $prop ) {
5593                  $this->get_setting( 'background_' . $prop )->transport = 'postMessage';
5594              }
5595          }
5596  
5597          /*
5598           * Static Front Page
5599           * See also https://core.trac.wordpress.org/ticket/19627 which introduces the static-front-page theme_support.
5600           * The following replicates behavior from options-reading.php.
5601           */
5602  
5603          $this->add_section(
5604              'static_front_page',
5605              array(
5606                  'title'           => __( 'Homepage Settings' ),
5607                  'priority'        => 120,
5608                  'description'     => __( 'You can choose what&#8217;s displayed on the homepage of your site. It can be posts in reverse chronological order (classic blog), or a fixed/static page. To set a static homepage, you first need to create two Pages. One will become the homepage, and the other will be where your posts are displayed.' ),
5609                  'active_callback' => array( $this, 'has_published_pages' ),
5610              )
5611          );
5612  
5613          $this->add_setting(
5614              'show_on_front',
5615              array(
5616                  'default'    => get_option( 'show_on_front' ),
5617                  'capability' => 'manage_options',
5618                  'type'       => 'option',
5619              )
5620          );
5621  
5622          $this->add_control(
5623              'show_on_front',
5624              array(
5625                  'label'   => __( 'Your homepage displays' ),
5626                  'section' => 'static_front_page',
5627                  'type'    => 'radio',
5628                  'choices' => array(
5629                      'posts' => __( 'Your latest posts' ),
5630                      'page'  => __( 'A static page' ),
5631                  ),
5632              )
5633          );
5634  
5635          $this->add_setting(
5636              'page_on_front',
5637              array(
5638                  'type'       => 'option',
5639                  'capability' => 'manage_options',
5640              )
5641          );
5642  
5643          $this->add_control(
5644              'page_on_front',
5645              array(
5646                  'label'          => __( 'Homepage' ),
5647                  'section'        => 'static_front_page',
5648                  'type'           => 'dropdown-pages',
5649                  'allow_addition' => true,
5650              )
5651          );
5652  
5653          $this->add_setting(
5654              'page_for_posts',
5655              array(
5656                  'type'       => 'option',
5657                  'capability' => 'manage_options',
5658              )
5659          );
5660  
5661          $this->add_control(
5662              'page_for_posts',
5663              array(
5664                  'label'          => __( 'Posts page' ),
5665                  'section'        => 'static_front_page',
5666                  'type'           => 'dropdown-pages',
5667                  'allow_addition' => true,
5668              )
5669          );
5670  
5671          /* Custom CSS */
5672          $section_description  = '<p>';
5673          $section_description .= __( 'Add your own CSS code here to customize the appearance and layout of your site.' );
5674          $section_description .= sprintf(
5675              ' <a href="%1$s" class="external-link" target="_blank">%2$s<span class="screen-reader-text"> %3$s</span></a>',
5676              esc_url( __( 'https://codex.wordpress.org/CSS' ) ),
5677              __( 'Learn more about CSS' ),
5678              /* translators: Accessibility text. */
5679              __( '(opens in a new tab)' )
5680          );
5681          $section_description .= '</p>';
5682  
5683          $section_description .= '<p id="editor-keyboard-trap-help-1">' . __( 'When using a keyboard to navigate:' ) . '</p>';
5684          $section_description .= '<ul>';
5685          $section_description .= '<li id="editor-keyboard-trap-help-2">' . __( 'In the editing area, the Tab key enters a tab character.' ) . '</li>';
5686          $section_description .= '<li id="editor-keyboard-trap-help-3">' . __( 'To move away from this area, press the Esc key followed by the Tab key.' ) . '</li>';
5687          $section_description .= '<li id="editor-keyboard-trap-help-4">' . __( 'Screen reader users: when in forms mode, you may need to press the Esc key twice.' ) . '</li>';
5688          $section_description .= '</ul>';
5689  
5690          if ( 'false' !== wp_get_current_user()->syntax_highlighting ) {
5691              $section_description .= '<p>';
5692              $section_description .= sprintf(
5693                  /* translators: 1: Link to user profile, 2: Additional link attributes, 3: Accessibility text. */
5694                  __( 'The edit field automatically highlights code syntax. You can disable this in your <a href="%1$s" %2$s>user profile%3$s</a> to work in plain text mode.' ),
5695                  esc_url( get_edit_profile_url() ),
5696                  'class="external-link" target="_blank"',
5697                  sprintf(
5698                      '<span class="screen-reader-text"> %s</span>',
5699                      /* translators: Accessibility text. */
5700                      __( '(opens in a new tab)' )
5701                  )
5702              );
5703              $section_description .= '</p>';
5704          }
5705  
5706          $section_description .= '<p class="section-description-buttons">';
5707          $section_description .= '<button type="button" class="button-link section-description-close">' . __( 'Close' ) . '</button>';
5708          $section_description .= '</p>';
5709  
5710          $this->add_section(
5711              'custom_css',
5712              array(
5713                  'title'              => __( 'Additional CSS' ),
5714                  'priority'           => 200,
5715                  'description_hidden' => true,
5716                  'description'        => $section_description,
5717              )
5718          );
5719  
5720          $custom_css_setting = new WP_Customize_Custom_CSS_Setting(
5721              $this,
5722              sprintf( 'custom_css[%s]', get_stylesheet() ),
5723              array(
5724                  'capability' => 'edit_css',
5725                  'default'    => '',
5726              )
5727          );
5728          $this->add_setting( $custom_css_setting );
5729  
5730          $this->add_control(
5731              new WP_Customize_Code_Editor_Control(
5732                  $this,
5733                  'custom_css',
5734                  array(
5735                      'label'       => __( 'CSS code' ),
5736                      'section'     => 'custom_css',
5737                      'settings'    => array( 'default' => $custom_css_setting->id ),
5738                      'code_type'   => 'text/css',
5739                      'input_attrs' => array(
5740                          'aria-describedby' => 'editor-keyboard-trap-help-1 editor-keyboard-trap-help-2 editor-keyboard-trap-help-3 editor-keyboard-trap-help-4',
5741                      ),
5742                  )
5743              )
5744          );
5745      }
5746  
5747      /**
5748       * Returns whether there are published pages.
5749       *
5750       * Used as active callback for static front page section and controls.
5751       *
5752       * @since 4.7.0
5753       *
5754       * @return bool Whether there are published (or to be published) pages.
5755       */
5756  	public function has_published_pages() {
5757  
5758          $setting = $this->get_setting( 'nav_menus_created_posts' );
5759          if ( $setting ) {
5760              foreach ( $setting->value() as $post_id ) {
5761                  if ( 'page' === get_post_type( $post_id ) ) {
5762                      return true;
5763                  }
5764              }
5765          }
5766          return 0 !== count( get_pages( array( 'number' => 1 ) ) );
5767      }
5768  
5769      /**
5770       * Adds settings from the POST data that were not added with code, e.g. dynamically-created settings for Widgets
5771       *
5772       * @since 4.2.0
5773       *
5774       * @see add_dynamic_settings()
5775       */
5776  	public function register_dynamic_settings() {
5777          $setting_ids = array_keys( $this->unsanitized_post_values() );
5778          $this->add_dynamic_settings( $setting_ids );
5779      }
5780  
5781      /**
5782       * Loads themes into the theme browsing/installation UI.
5783       *
5784       * @since 4.9.0
5785       */
5786  	public function handle_load_themes_request() {
5787          check_ajax_referer( 'switch_themes', 'nonce' );
5788  
5789          if ( ! current_user_can( 'switch_themes' ) ) {
5790              wp_die( -1 );
5791          }
5792  
5793          if ( empty( $_POST['theme_action'] ) ) {
5794              wp_send_json_error( 'missing_theme_action' );
5795          }
5796          $theme_action = sanitize_key( $_POST['theme_action'] );
5797          $themes       = array();
5798          $args         = array();
5799  
5800          // Define query filters based on user input.
5801          if ( ! array_key_exists( 'search', $_POST ) ) {
5802              $args['search'] = '';
5803          } else {
5804              $args['search'] = sanitize_text_field( wp_unslash( $_POST['search'] ) );
5805          }
5806  
5807          if ( ! array_key_exists( 'tags', $_POST ) ) {
5808              $args['tag'] = '';
5809          } else {
5810              $args['tag'] = array_map( 'sanitize_text_field', wp_unslash( (array) $_POST['tags'] ) );
5811          }
5812  
5813          if ( ! array_key_exists( 'page', $_POST ) ) {
5814              $args['page'] = 1;
5815          } else {
5816              $args['page'] = absint( $_POST['page'] );
5817          }
5818  
5819          require_once ABSPATH . 'wp-admin/includes/theme.php';
5820  
5821          if ( 'installed' === $theme_action ) {
5822  
5823              // Load all installed themes from wp_prepare_themes_for_js().
5824              $themes = array( 'themes' => array() );
5825              foreach ( wp_prepare_themes_for_js() as $theme ) {
5826                  $theme['type']      = 'installed';
5827                  $theme['active']    = ( isset( $_POST['customized_theme'] ) && $_POST['customized_theme'] === $theme['id'] );
5828                  $themes['themes'][] = $theme;
5829              }
5830          } elseif ( 'wporg' === $theme_action ) {
5831  
5832              // Load WordPress.org themes from the .org API and normalize data to match installed theme objects.
5833              if ( ! current_user_can( 'install_themes' ) ) {
5834                  wp_die( -1 );
5835              }
5836  
5837              // Arguments for all queries.
5838              $wporg_args = array(
5839                  'per_page' => 100,
5840                  'fields'   => array(
5841                      'reviews_url' => true, // Explicitly request the reviews URL to be linked from the customizer.
5842                  ),
5843              );
5844  
5845              $args = array_merge( $wporg_args, $args );
5846  
5847              if ( '' === $args['search'] && '' === $args['tag'] ) {
5848                  $args['browse'] = 'new'; // Sort by latest themes by default.
5849              }
5850  
5851              // Load themes from the .org API.
5852              $themes = themes_api( 'query_themes', $args );
5853              if ( is_wp_error( $themes ) ) {
5854                  wp_send_json_error();
5855              }
5856  
5857              // This list matches the allowed tags in wp-admin/includes/theme-install.php.
5858              $themes_allowedtags                     = array_fill_keys(
5859                  array( 'a', 'abbr', 'acronym', 'code', 'pre', 'em', 'strong', 'div', 'p', 'ul', 'ol', 'li', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'img' ),
5860                  array()
5861              );
5862              $themes_allowedtags['a']                = array_fill_keys( array( 'href', 'title', 'target' ), true );
5863              $themes_allowedtags['acronym']['title'] = true;
5864              $themes_allowedtags['abbr']['title']    = true;
5865              $themes_allowedtags['img']              = array_fill_keys( array( 'src', 'class', 'alt' ), true );
5866  
5867              // Prepare a list of installed themes to check against before the loop.
5868              $installed_themes = array();
5869              $wp_themes        = wp_get_themes();
5870              foreach ( $wp_themes as $theme ) {
5871                  $installed_themes[] = $theme->get_stylesheet();
5872              }
5873              $update_php = network_admin_url( 'update.php?action=install-theme' );
5874  
5875              // Set up properties for themes available on WordPress.org.
5876              foreach ( $themes->themes as &$theme ) {
5877                  $theme->install_url = add_query_arg(
5878                      array(
5879                          'theme'    => $theme->slug,
5880                          '_wpnonce' => wp_create_nonce( 'install-theme_' . $theme->slug ),
5881                      ),
5882                      $update_php
5883                  );
5884  
5885                  $theme->name        = wp_kses( $theme->name, $themes_allowedtags );
5886                  $theme->version     = wp_kses( $theme->version, $themes_allowedtags );
5887                  $theme->description = wp_kses( $theme->description, $themes_allowedtags );
5888                  $theme->stars       = wp_star_rating(
5889                      array(
5890                          'rating' => $theme->rating,
5891                          'type'   => 'percent',
5892                          'number' => $theme->num_ratings,
5893                          'echo'   => false,
5894                      )
5895                  );
5896                  $theme->num_ratings = number_format_i18n( $theme->num_ratings );
5897                  $theme->preview_url = set_url_scheme( $theme->preview_url );
5898  
5899                  // Handle themes that are already installed as installed themes.
5900                  if ( in_array( $theme->slug, $installed_themes, true ) ) {
5901                      $theme->type = 'installed';
5902                  } else {
5903                      $theme->type = $theme_action;
5904                  }
5905  
5906                  // Set active based on customized theme.
5907                  $theme->active = ( isset( $_POST['customized_theme'] ) && $_POST['customized_theme'] === $theme->slug );
5908  
5909                  // Map available theme properties to installed theme properties.
5910                  $theme->id            = $theme->slug;
5911                  $theme->screenshot    = array( $theme->screenshot_url );
5912                  $theme->authorAndUri  = wp_kses( $theme->author['display_name'], $themes_allowedtags );
5913                  $theme->compatibleWP  = is_wp_version_compatible( $theme->requires ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName
5914                  $theme->compatiblePHP = is_php_version_compatible( $theme->requires_php ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName
5915  
5916                  if ( isset( $theme->parent ) ) {
5917                      $theme->parent = $theme->parent['slug'];
5918                  } else {
5919                      $theme->parent = false;
5920                  }
5921                  unset( $theme->slug );
5922                  unset( $theme->screenshot_url );
5923                  unset( $theme->author );
5924              } // End foreach().
5925          } // End if().
5926  
5927          /**
5928           * Filters the theme data loaded in the customizer.
5929           *
5930           * This allows theme data to be loading from an external source,
5931           * or modification of data loaded from `wp_prepare_themes_for_js()`
5932           * or WordPress.org via `themes_api()`.
5933           *
5934           * @since 4.9.0
5935           *
5936           * @see wp_prepare_themes_for_js()
5937           * @see themes_api()
5938           * @see WP_Customize_Manager::__construct()
5939           *
5940           * @param array|stdClass       $themes  Nested array or object of theme data.
5941           * @param array                $args    List of arguments, such as page, search term, and tags to query for.
5942           * @param WP_Customize_Manager $manager Instance of Customize manager.
5943           */
5944          $themes = apply_filters( 'customize_load_themes', $themes, $args, $this );
5945  
5946          wp_send_json_success( $themes );
5947      }
5948  
5949  
5950      /**
5951       * Callback for validating the header_textcolor value.
5952       *
5953       * Accepts 'blank', and otherwise uses sanitize_hex_color_no_hash().
5954       * Returns default text color if hex color is empty.
5955       *
5956       * @since 3.4.0
5957       *
5958       * @param string $color
5959       * @return mixed
5960       */
5961  	public function _sanitize_header_textcolor( $color ) {
5962          if ( 'blank' === $color ) {
5963              return 'blank';
5964          }
5965  
5966          $color = sanitize_hex_color_no_hash( $color );
5967          if ( empty( $color ) ) {
5968              $color = get_theme_support( 'custom-header', 'default-text-color' );
5969          }
5970  
5971          return $color;
5972      }
5973  
5974      /**
5975       * Callback for validating a background setting value.
5976       *
5977       * @since 4.7.0
5978       *
5979       * @param string               $value   Repeat value.
5980       * @param WP_Customize_Setting $setting Setting.
5981       * @return string|WP_Error Background value or validation error.
5982       */
5983  	public function _sanitize_background_setting( $value, $setting ) {
5984          if ( 'background_repeat' === $setting->id ) {
5985              if ( ! in_array( $value, array( 'repeat-x', 'repeat-y', 'repeat', 'no-repeat' ), true ) ) {
5986                  return new WP_Error( 'invalid_value', __( 'Invalid value for background repeat.' ) );
5987              }
5988          } elseif ( 'background_attachment' === $setting->id ) {
5989              if ( ! in_array( $value, array( 'fixed', 'scroll' ), true ) ) {
5990                  return new WP_Error( 'invalid_value', __( 'Invalid value for background attachment.' ) );
5991              }
5992          } elseif ( 'background_position_x' === $setting->id ) {
5993              if ( ! in_array( $value, array( 'left', 'center', 'right' ), true ) ) {
5994                  return new WP_Error( 'invalid_value', __( 'Invalid value for background position X.' ) );
5995              }
5996          } elseif ( 'background_position_y' === $setting->id ) {
5997              if ( ! in_array( $value, array( 'top', 'center', 'bottom' ), true ) ) {
5998                  return new WP_Error( 'invalid_value', __( 'Invalid value for background position Y.' ) );
5999              }
6000          } elseif ( 'background_size' === $setting->id ) {
6001              if ( ! in_array( $value, array( 'auto', 'contain', 'cover' ), true ) ) {
6002                  return new WP_Error( 'invalid_value', __( 'Invalid value for background size.' ) );
6003              }
6004          } elseif ( 'background_preset' === $setting->id ) {
6005              if ( ! in_array( $value, array( 'default', 'fill', 'fit', 'repeat', 'custom' ), true ) ) {
6006                  return new WP_Error( 'invalid_value', __( 'Invalid value for background size.' ) );
6007              }
6008          } elseif ( 'background_image' === $setting->id || 'background_image_thumb' === $setting->id ) {
6009              $value = empty( $value ) ? '' : esc_url_raw( $value );
6010          } else {
6011              return new WP_Error( 'unrecognized_setting', __( 'Unrecognized background setting.' ) );
6012          }
6013          return $value;
6014      }
6015  
6016      /**
6017       * Exports header video settings to facilitate selective refresh.
6018       *
6019       * @since 4.7.0
6020       *
6021       * @param array                          $response          Response.
6022       * @param WP_Customize_Selective_Refresh $selective_refresh Selective refresh component.
6023       * @param array                          $partials          Array of partials.
6024       * @return array
6025       */
6026  	public function export_header_video_settings( $response, $selective_refresh, $partials ) {
6027          if ( isset( $partials['custom_header'] ) ) {
6028              $response['custom_header_settings'] = get_header_video_settings();
6029          }
6030  
6031          return $response;
6032      }
6033  
6034      /**
6035       * Callback for validating the header_video value.
6036       *
6037       * Ensures that the selected video is less than 8MB and provides an error message.
6038       *
6039       * @since 4.7.0
6040       *
6041       * @param WP_Error $validity
6042       * @param mixed    $value
6043       * @return mixed
6044       */
6045  	public function _validate_header_video( $validity, $value ) {
6046          $video = get_attached_file( absint( $value ) );
6047          if ( $video ) {
6048              $size = filesize( $video );
6049              if ( $size > 8 * MB_IN_BYTES ) {
6050                  $validity->add(
6051                      'size_too_large',
6052                      __( 'This video file is too large to use as a header video. Try a shorter video or optimize the compression settings and re-upload a file that is less than 8MB. Or, upload your video to YouTube and link it with the option below.' )
6053                  );
6054              }
6055              if ( '.mp4' !== substr( $video, -4 ) && '.mov' !== substr( $video, -4 ) ) { // Check for .mp4 or .mov format, which (assuming h.264 encoding) are the only cross-browser-supported formats.
6056                  $validity->add(
6057                      'invalid_file_type',
6058                      sprintf(
6059                          /* translators: 1: .mp4, 2: .mov */
6060                          __( 'Only %1$s or %2$s files may be used for header video. Please convert your video file and try again, or, upload your video to YouTube and link it with the option below.' ),
6061                          '<code>.mp4</code>',
6062                          '<code>.mov</code>'
6063                      )
6064                  );
6065              }
6066          }
6067          return $validity;
6068      }
6069  
6070      /**
6071       * Callback for validating the external_header_video value.
6072       *
6073       * Ensures that the provided URL is supported.
6074       *
6075       * @since 4.7.0
6076       *
6077       * @param WP_Error $validity
6078       * @param mixed    $value
6079       * @return mixed
6080       */
6081  	public function _validate_external_header_video( $validity, $value ) {
6082          $video = esc_url_raw( $value );
6083          if ( $video ) {
6084              if ( ! preg_match( '#^https?://(?:www\.)?(?:youtube\.com/watch|youtu\.be/)#', $video ) ) {
6085                  $validity->add( 'invalid_url', __( 'Please enter a valid YouTube URL.' ) );
6086              }
6087          }
6088          return $validity;
6089      }
6090  
6091      /**
6092       * Callback for sanitizing the external_header_video value.
6093       *
6094       * @since 4.7.1
6095       *
6096       * @param string $value URL.
6097       * @return string Sanitized URL.
6098       */
6099  	public function _sanitize_external_header_video( $value ) {
6100          return esc_url_raw( trim( $value ) );
6101      }
6102  
6103      /**
6104       * Callback for rendering the custom logo, used in the custom_logo partial.
6105       *
6106       * This method exists because the partial object and context data are passed
6107       * into a partial's render_callback so we cannot use get_custom_logo() as
6108       * the render_callback directly since it expects a blog ID as the first
6109       * argument. When WP no longer supports PHP 5.3, this method can be removed
6110       * in favor of an anonymous function.
6111       *
6112       * @see WP_Customize_Manager::register_controls()
6113       *
6114       * @since 4.5.0
6115       *
6116       * @return string Custom logo.
6117       */
6118  	public function _render_custom_logo_partial() {
6119          return get_custom_logo();
6120      }
6121  }


Generated: Thu Mar 28 01:00:02 2024 Cross-referenced by PHPXref 0.7.1