WP_Customize_Manager::save_changeset_post( array $args = array() ): array|WP_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarrayoptional

Args for changeset post.Default: array()

• $dataarray

  Optional additional changeset data. Values will be merged on top of any existing post values.

• $statusstring

  Post status. Optional. If supplied, the save will be transactional and a post revision will be allowed.

• $titlestring

  Post title. Optional.

• $date_gmtstring

  Date in GMT. Optional.

• $user_idint

  ID for user who is saving the changeset. Optional, defaults to the current user ID.

• $starter_contentbool

  Whether the data is starter content. If false (default), then $starter_content will be cleared for any $data being saved.

• $autosavebool

  Whether this is a request to create an autosave revision.

Return value

array|WP_Error

Returns array on success and WP_Error with array data on error.

Performance profile

How much work a call to WP_Customize_Manager::save_changeset_post() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

200–254

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 632.

Plugin surface

2 hooks

Third-party callbacks on 'customize_save_validation_before', 'customize_changeset_save_data' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksdo_action()called directly
• optionoption read or writeupdate_option()called directly
• serializeserialisationmaybe_serialize()one call below WP_Customize_Manager::save_changeset_post()
• cacheobject cachewp_cache_get()one call below WP_Customize_Manager::save_changeset_post()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 116 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Manager::save_changeset_post() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 2

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

1. 1
   do_action( customize_save_validation_before )actionline 2779 (+140 into the body)

   Fires before save validation happens.

2. 2
   apply_filters( customize_changeset_save_data )filterline 2904 (+265 into the body)

   Filters the settings' data that will be persisted into the changeset.

Uses · 38

• get_current_user_id()Gets the current user's ID.
• get_post_status()Retrieves the post status based on the post ID.
• __()Retrieves the translation of $text.
• wp_generate_uuid4()Generates a random UUID (version 4).
• is_wp_error()Checks whether the given variable is a WordPress Error.
• has_action()Checks if any action has been registered for a hook.
• mysql2date()Converts given MySQL date string into a different format.
• 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.
• _n()Translates and retrieves the singular or plural form based on the supplied number.
• number_format_i18n()Converts float number to format based on the locale.
• current_time()Retrieves the current time based on specified type.

Used by · 2

• WP_Customize_Manager::_save_starter_content_changeset()Saves starter content changeset.
• WP_Customize_Manager::save()Handles customize_save WP Ajax request to save/update a changeset.

Source code

View on Trac ↗View on GitHub ↗

2639	public function save_changeset_post( $args = array() ) {2640 2641		$args = array_merge(2642			array(2643				'status'          => null,2644				'title'           => null,2645				'data'            => array(),2646				'date_gmt'        => null,2647				'user_id'         => get_current_user_id(),2648				'starter_content' => false,2649				'autosave'        => false,2650			),2651			$args2652		);2653 2654		$changeset_post_id       = $this->changeset_post_id();2655		$existing_changeset_data = array();2656		if ( $changeset_post_id ) {2657			$existing_status = get_post_status( $changeset_post_id );2658			if ( 'publish' === $existing_status || 'trash' === $existing_status ) {2659				return new WP_Error(2660					'changeset_already_published',2661					__( 'The previous set of changes has already been published. Please try saving your current set of changes again.' ),2662					array(2663						'next_changeset_uuid' => wp_generate_uuid4(),2664					)2665				);2666			}2667 2668			$existing_changeset_data = $this->get_changeset_post_data( $changeset_post_id );2669			if ( is_wp_error( $existing_changeset_data ) ) {2670				return $existing_changeset_data;2671			}2672		}2673 2674		// Fail if attempting to publish but publish hook is missing.2675		if ( 'publish' === $args['status'] && false === has_action( 'transition_post_status', '_wp_customize_publish_changeset' ) ) {2676			return new WP_Error( 'missing_publish_callback' );2677		}2678 2679		// Validate date.2680		$now = gmdate( 'Y-m-d H:i:59' );2681		if ( $args['date_gmt'] ) {2682			$is_future_dated = ( mysql2date( 'U', $args['date_gmt'], false ) > mysql2date( 'U', $now, false ) );2683			if ( ! $is_future_dated ) {2684				return new WP_Error( 'not_future_date', __( 'You must supply a future date to schedule.' ) ); // Only future dates are allowed.2685			}2686 2687			if ( ! $this->is_theme_active() && ( 'future' === $args['status'] || $is_future_dated ) ) {2688				return new WP_Error( 'cannot_schedule_theme_switches' ); // This should be allowed in the future, when theme is a regular setting.2689			}2690			$will_remain_auto_draft = ( ! $args['status'] && ( ! $changeset_post_id || 'auto-draft' === get_post_status( $changeset_post_id ) ) );2691			if ( $will_remain_auto_draft ) {2692				return new WP_Error( 'cannot_supply_date_for_auto_draft_changeset' );2693			}2694		} elseif ( $changeset_post_id && 'future' === $args['status'] ) {2695 2696			// Fail if the new status is future but the existing post's date is not in the future.2697			$changeset_post = get_post( $changeset_post_id );2698			if ( mysql2date( 'U', $changeset_post->post_date_gmt, false ) <= mysql2date( 'U', $now, false ) ) {2699				return new WP_Error( 'not_future_date', __( 'You must supply a future date to schedule.' ) );2700			}2701		}2702 2703		if ( ! empty( $is_future_dated ) && 'publish' === $args['status'] ) {2704			$args['status'] = 'future';2705		}2706 2707		// Validate autosave param. See _wp_post_revision_fields() for why these fields are disallowed.2708		if ( $args['autosave'] ) {2709			if ( $args['date_gmt'] ) {2710				return new WP_Error( 'illegal_autosave_with_date_gmt' );2711			} elseif ( $args['status'] ) {2712				return new WP_Error( 'illegal_autosave_with_status' );2713			} elseif ( $args['user_id'] && get_current_user_id() !== $args['user_id'] ) {2714				return new WP_Error( 'illegal_autosave_with_non_current_user' );2715			}2716		}2717 2718		// The request was made via wp.customize.previewer.save().

Changelog

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.