WP_Customize_Manager::_publish_changeset_values( int $changeset_post_id ): true|WP_Error

Description

Parameters

$changeset_post_idint

ID for customize_changeset post. Defaults to the changeset for the current manager instance.

Return

true|WP_Error

True or error info.

Hooks fired · 2

2 hooks fire while WP_Customize_Manager::_publish_changeset_values() runs, in this order:

1. 1
   do_action( customize_save )actionline 3553 (+74 into the body)

   Fires once the theme has switched in the Customizer, but before settings have been saved.

2. 2
   do_action( customize_save_after )actionline 3606 (+127 into the body)

   Fires after Customize settings have been saved.

Uses · 16

• is_wp_error()Checks whether the given variable is a WordPress Error.
• get_post()Retrieves post data given a post ID or post object.
• do_action()Calls the callback functions that have been added to an action hook.
• get_current_user_id()Gets the current user's ID.
• wp_set_current_user()Changes the current user by ID or name.
• did_action()Retrieves the number of times an action has been fired during the current request.
• wp_get_post_revisions()Returns all revisions of specified post.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• wp_generate_uuid4()Generates a random UUID (version 4).
• clean_post_cache()Will clean the post in the cache.
• WP_Customize_Manager::get_changeset_post_data()Gets the data stored in a changeset post.
• WP_Customize_Manager::get_stylesheet()Retrieves the stylesheet name of the previewed theme.

Source

View on Trac ↗View on GitHub ↗

3479	public function _publish_changeset_values( $changeset_post_id ) {3480		global $wpdb;3481 3482		$publishing_changeset_data = $this->get_changeset_post_data( $changeset_post_id );3483		if ( is_wp_error( $publishing_changeset_data ) ) {3484			return $publishing_changeset_data;3485		}3486 3487		$changeset_post = get_post( $changeset_post_id );3488 3489		/*3490		 * Temporarily override the changeset context so that it will be read3491		 * in calls to unsanitized_post_values() and so that it will be available3492		 * on the $wp_customize object passed to hooks during the save logic.3493		 */3494		$previous_changeset_post_id = $this->_changeset_post_id;3495		$this->_changeset_post_id   = $changeset_post_id;3496		$previous_changeset_uuid    = $this->_changeset_uuid;3497		$this->_changeset_uuid      = $changeset_post->post_name;3498		$previous_changeset_data    = $this->_changeset_data;3499		$this->_changeset_data      = $publishing_changeset_data;3500 3501		// Parse changeset data to identify theme mod settings and user IDs associated with settings to be saved.3502		$setting_user_ids   = array();3503		$theme_mod_settings = array();3504		$namespace_pattern  = '/^(?P<stylesheet>.+?)::(?P<setting_id>.+)$/';3505		$matches            = array();3506		foreach ( $this->_changeset_data as $raw_setting_id => $setting_params ) {3507			$actual_setting_id    = null;3508			$is_theme_mod_setting = (3509				isset( $setting_params['value'] )3510				&&3511				isset( $setting_params['type'] )3512				&&3513				'theme_mod' === $setting_params['type']3514				&&3515				preg_match( $namespace_pattern, $raw_setting_id, $matches )3516			);3517			if ( $is_theme_mod_setting ) {3518				if ( ! isset( $theme_mod_settings[ $matches['stylesheet'] ] ) ) {3519					$theme_mod_settings[ $matches['stylesheet'] ] = array();3520				}3521				$theme_mod_settings[ $matches['stylesheet'] ][ $matches['setting_id'] ] = $setting_params;3522 3523				if ( $this->get_stylesheet() === $matches['stylesheet'] ) {3524					$actual_setting_id = $matches['setting_id'];3525				}3526			} else {3527				$actual_setting_id = $raw_setting_id;3528			}3529 3530			// Keep track of the user IDs for settings actually for this theme.3531			if ( $actual_setting_id && isset( $setting_params['user_id'] ) ) {3532				$setting_user_ids[ $actual_setting_id ] = $setting_params['user_id'];3533			}3534		}3535 3536		$changeset_setting_values = $this->unsanitized_post_values(3537			array(3538				'exclude_post_data' => true,3539				'exclude_changeset' => false,3540			)3541		);3542		$changeset_setting_ids    = array_keys( $changeset_setting_values );3543		$this->add_dynamic_settings( $changeset_setting_ids );3544 3545		/**3546		 * Fires once the theme has switched in the Customizer, but before settings3547		 * have been saved.3548		 *3549		 * @since 3.4.03550		 *3551		 * @param WP_Customize_Manager $manager WP_Customize_Manager instance.3552		 */3553		do_action( 'customize_save', $this );3554 3555		/*3556		 * Ensure that all settings will allow themselves to be saved. Note that3557		 * this is safe because the setting would have checked the capability3558		 * when the setting value was written into the changeset. So this is why

History

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/class-wp-customize-manager.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.