W3cubDocs

/WordPress

WP_Customize_Manager::customize_pane_settings()

Print JavaScript settings for parent window.

Source

File: wp-includes/class-wp-customize-manager.php

public function customize_pane_settings() {

		$login_url = add_query_arg(
			array(
				'interim-login'   => 1,
				'customize-login' => 1,
			),
			wp_login_url()
		);

		// Ensure dirty flags are set for modified settings.
		foreach ( array_keys( $this->unsanitized_post_values() ) as $setting_id ) {
			$setting = $this->get_setting( $setting_id );
			if ( $setting ) {
				$setting->dirty = true;
			}
		}

		$autosave_revision_post  = null;
		$autosave_autodraft_post = null;
		$changeset_post_id       = $this->changeset_post_id();
		if ( ! $this->saved_starter_content_changeset && ! $this->autosaved() ) {
			if ( $changeset_post_id ) {
				if ( is_user_logged_in() ) {
					$autosave_revision_post = wp_get_post_autosave( $changeset_post_id, get_current_user_id() );
				}
			} else {
				$autosave_autodraft_posts = $this->get_changeset_posts(
					array(
						'posts_per_page'            => 1,
						'post_status'               => 'auto-draft',
						'exclude_restore_dismissed' => true,
					)
				);
				if ( ! empty( $autosave_autodraft_posts ) ) {
					$autosave_autodraft_post = array_shift( $autosave_autodraft_posts );
				}
			}
		}

		$current_user_can_publish = current_user_can( get_post_type_object( 'customize_changeset' )->cap->publish_posts );

		// @todo Include all of the status labels here from script-loader.php, and then allow it to be filtered.
		$status_choices = array();
		if ( $current_user_can_publish ) {
			$status_choices[] = array(
				'status' => 'publish',
				'label'  => __( 'Publish' ),
			);
		}
		$status_choices[] = array(
			'status' => 'draft',
			'label'  => __( 'Save Draft' ),
		);
		if ( $current_user_can_publish ) {
			$status_choices[] = array(
				'status' => 'future',
				'label'  => _x( 'Schedule', 'customizer changeset action/button label' ),
			);
		}

		// Prepare Customizer settings to pass to JavaScript.
		$changeset_post = null;
		if ( $changeset_post_id ) {
			$changeset_post = get_post( $changeset_post_id );
		}

		// Determine initial date to be at present or future, not past.
		$current_time = current_time( 'mysql', false );
		$initial_date = $current_time;
		if ( $changeset_post ) {
			$initial_date = get_the_time( 'Y-m-d H:i:s', $changeset_post->ID );
			if ( $initial_date < $current_time ) {
				$initial_date = $current_time;
			}
		}

		$lock_user_id = false;
		if ( $this->changeset_post_id() ) {
			$lock_user_id = wp_check_post_lock( $this->changeset_post_id() );
		}

		$settings = array(
			'changeset'              => array(
				'uuid'                  => $this->changeset_uuid(),
				'branching'             => $this->branching(),
				'autosaved'             => $this->autosaved(),
				'hasAutosaveRevision'   => ! empty( $autosave_revision_post ),
				'latestAutoDraftUuid'   => $autosave_autodraft_post ? $autosave_autodraft_post->post_name : null,
				'status'                => $changeset_post ? $changeset_post->post_status : '',
				'currentUserCanPublish' => $current_user_can_publish,
				'publishDate'           => $initial_date,
				'statusChoices'         => $status_choices,
				'lockUser'              => $lock_user_id ? $this->get_lock_user_data( $lock_user_id ) : null,
			),
			'initialServerDate'      => $current_time,
			'dateFormat'             => get_option( 'date_format' ),
			'timeFormat'             => get_option( 'time_format' ),
			'initialServerTimestamp' => floor( microtime( true ) * 1000 ),
			'initialClientTimestamp' => -1, // To be set with JS below.
			'timeouts'               => array(
				'windowRefresh'           => 250,
				'changesetAutoSave'       => AUTOSAVE_INTERVAL * 1000,
				'keepAliveCheck'          => 2500,
				'reflowPaneContents'      => 100,
				'previewFrameSensitivity' => 2000,
			),
			'theme'                  => array(
				'stylesheet'  => $this->get_stylesheet(),
				'active'      => $this->is_theme_active(),
				'_canInstall' => current_user_can( 'install_themes' ),
			),
			'url'                    => array(
				'preview'       => esc_url_raw( $this->get_preview_url() ),
				'return'        => esc_url_raw( $this->get_return_url() ),
				'parent'        => esc_url_raw( admin_url() ),
				'activated'     => esc_url_raw( home_url( '/' ) ),
				'ajax'          => esc_url_raw( admin_url( 'admin-ajax.php', 'relative' ) ),
				'allowed'       => array_map( 'esc_url_raw', $this->get_allowed_urls() ),
				'isCrossDomain' => $this->is_cross_domain(),
				'home'          => esc_url_raw( home_url( '/' ) ),
				'login'         => esc_url_raw( $login_url ),
			),
			'browser'                => array(
				'mobile' => wp_is_mobile(),
				'ios'    => $this->is_ios(),
			),
			'panels'                 => array(),
			'sections'               => array(),
			'nonce'                  => $this->get_nonces(),
			'autofocus'              => $this->get_autofocus(),
			'documentTitleTmpl'      => $this->get_document_title_template(),
			'previewableDevices'     => $this->get_previewable_devices(),
			'l10n'                   => array(
				'confirmDeleteTheme'   => __( 'Are you sure you want to delete this theme?' ),
				/* translators: %d: Number of theme search results, which cannot currently consider singular vs. plural forms. */
				'themeSearchResults'   => __( '%d themes found' ),
				/* translators: %d: Number of themes being displayed, which cannot currently consider singular vs. plural forms. */
				'announceThemeCount'   => __( 'Displaying %d themes' ),
				/* translators: %s: Theme name. */
				'announceThemeDetails' => __( 'Showing details for theme: %s' ),
			),
		);

		// Temporarily disable installation in Customizer. See #42184.
		$filesystem_method = get_filesystem_method();
		ob_start();
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
		ob_end_clean();
		if ( 'direct' !== $filesystem_method && ! $filesystem_credentials_are_stored ) {
			$settings['theme']['_filesystemCredentialsNeeded'] = true;
		}

		// Prepare Customize Section objects to pass to JavaScript.
		foreach ( $this->sections() as $id => $section ) {
			if ( $section->check_capabilities() ) {
				$settings['sections'][ $id ] = $section->json();
			}
		}

		// Prepare Customize Panel objects to pass to JavaScript.
		foreach ( $this->panels() as $panel_id => $panel ) {
			if ( $panel->check_capabilities() ) {
				$settings['panels'][ $panel_id ] = $panel->json();
				foreach ( $panel->sections as $section_id => $section ) {
					if ( $section->check_capabilities() ) {
						$settings['sections'][ $section_id ] = $section->json();
					}
				}
			}
		}

		?>
		<script type="text/javascript">
			var _wpCustomizeSettings = <?php echo wp_json_encode( $settings ); ?>;
			_wpCustomizeSettings.initialClientTimestamp = _.now();
			_wpCustomizeSettings.controls = {};
			_wpCustomizeSettings.settings = {};
			<?php

			// Serialize settings one by one to improve memory usage.
			echo "(function ( s ){\n";
			foreach ( $this->settings() as $setting ) {
				if ( $setting->check_capabilities() ) {
					printf(
						"s[%s] = %s;\n",
						wp_json_encode( $setting->id ),
						wp_json_encode( $setting->json() )
					);
				}
			}
			echo "})( _wpCustomizeSettings.settings );\n";

			// Serialize controls one by one to improve memory usage.
			echo "(function ( c ){\n";
			foreach ( $this->controls() as $control ) {
				if ( $control->check_capabilities() ) {
					printf(
						"c[%s] = %s;\n",
						wp_json_encode( $control->id ),
						wp_json_encode( $control->json() )
					);
				}
			}
			echo "})( _wpCustomizeSettings.controls );\n";
			?>
		</script>
		<?php
	}

Uses

Uses	Description
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_lock_user_data()	Get lock user data.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_changeset_posts()	Get changeset posts.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::branching()	Whether the changeset branching is allowed.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::autosaved()	Gets whether data from a changeset’s autosaved revision should be loaded if it exists.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_allowed_urls()	Get URLs allowed to be previewed.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::is_cross_domain()	Determines whether the admin and the frontend are on different domains.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::changeset_post_id()	Get the changeset post ID for the loaded changeset.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::changeset_uuid()	Get the changeset UUID.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_nonces()	Get nonces for the Customizer.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_previewable_devices()	Returns a list of devices to allow previewing.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_preview_url()	Get the initial URL to be previewed.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_return_url()	Get URL to link the user to when closing the Customizer.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_autofocus()	Get the autofocused constructs.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::is_ios()	Determine whether the user agent is iOS.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_document_title_template()	Get the template string for the Customizer pane document title.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::unsanitized_post_values()	Get dirty pre-sanitized setting values in the current customized state.
wp-includes/functions.php: wp_json_encode()	Encode a variable into JSON, with some sanity checks.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::panels()	Get the registered panels.
wp-admin/includes/post.php: wp_check_post_lock()	Check to see if the post is currently being edited by another user.
wp-admin/includes/file.php: get_filesystem_method()	Determines which method to use for reading, writing, modifying, or deleting files on the filesystem.
wp-admin/includes/file.php: request_filesystem_credentials()	Displays a form to the user to request for their FTP/SSH details in order to connect to the filesystem.
wp-includes/capabilities.php: current_user_can()	Returns whether the current user has the specified capability.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_setting()	Retrieve a customize setting.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_stylesheet()	Retrieve the stylesheet name of the previewed theme.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::is_theme_active()	Checks if the current theme is active.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::sections()	Get the registered sections.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::settings()	Get the registered settings.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::controls()	Get the registered controls.
wp-includes/l10n.php: __()	Retrieve the translation of $text.
wp-includes/l10n.php: _x()	Retrieve translated string with gettext context.
wp-includes/formatting.php: esc_url_raw()	Performs esc_url() for database usage.
wp-includes/pluggable.php: is_user_logged_in()	Determines whether the current visitor is a logged in user.
wp-includes/general-template.php: get_the_time()	Retrieve the time at which the post was written.
wp-includes/general-template.php: wp_login_url()	Retrieves the login URL.
wp-includes/vars.php: wp_is_mobile()	Test if the current browser runs on a mobile device (smart phone, tablet, etc.)
wp-includes/functions.php: add_query_arg()	Retrieves a modified URL query string.
wp-includes/functions.php: current_time()	Retrieves the current time based on specified type.
wp-includes/link-template.php: self_admin_url()	Retrieves the URL to the admin area for either the current site or the network depending on context.
wp-includes/link-template.php: admin_url()	Retrieves the URL to the admin area for the current site.
wp-includes/link-template.php: home_url()	Retrieves the URL for the current site where the front end is accessible.
wp-includes/option.php: get_option()	Retrieves an option value based on an option name.
wp-includes/user.php: get_current_user_id()	Get the current user’s ID
wp-includes/post.php: get_post_type_object()	Retrieves a post type object by name.
wp-includes/post.php: get_post()	Retrieves post data given a post ID or post object.
wp-includes/revision.php: wp_get_post_autosave()	Retrieve the autosaved data of the specified post.

Changelog

Version	Description
4.4.0	Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_customize_manager/customize_pane_settings

WP_Customize_Manager::customize_pane_settings()

Source

Related

Uses

Changelog