wppaste
WordPress

WP_Customize_Manager::branching(): bool

Since
4.9.0
Source
wp-includes/class-wp-customize-manager.php:784
Whether the changeset branching is allowed.

Compatibility

WordPress
since 4.9.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Return value

bool
Is changeset branching.

Performance profile

How much work a call to WP_Customize_Manager::branching() 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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
12

Executed per call on PHP 8.5. The body compiles to 12.

Plugin surface
1 hook

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

Called by
3

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

What it touches

  • hookthird-party callbacksapply_filters()called directly

What one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
always12apply_filters()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 12 instructions, 12 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 1

One hook fires while WP_Customize_Manager::branching() runs, in this order:

  1. apply_filters( customize_changeset_branching )filterline 811 (+27 into the body)

    Filters whether or not changeset branching is allowed.

Uses · 1

  • apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 3

Source code

	public function branching() { 		/**		 * Filters whether or not changeset branching is allowed.		 *		 * By default in core, when changeset branching is not allowed, changesets will operate		 * linearly in that only one saved changeset will exist at a time (with a 'draft' or		 * 'future' status). This makes the Customizer operate in a way that is similar to going to		 * "edit" to one existing post: all users will be making changes to the same post, and autosave		 * revisions will be made for that post.		 *		 * By contrast, when changeset branching is allowed, then the model is like users going		 * to "add new" for a page and each user makes changes independently of each other since		 * they are all operating on their own separate pages, each getting their own separate		 * initial auto-drafts and then once initially saved, autosave revisions on top of that		 * user's specific post.		 *		 * Since linear changesets are deemed to be more suitable for the majority of WordPress users,		 * they are the default. For WordPress sites that have heavy site management in the Customizer		 * by multiple users then branching changesets should be enabled by means of this filter.		 *		 * @since 4.9.0		 *		 * @param bool                 $allow_branching Whether branching is allowed. If `false`, the default,		 *                                              then only one saved changeset exists at a time.		 * @param WP_Customize_Manager $wp_customize    Manager instance.		 */		$this->branching = apply_filters( 'customize_changeset_branching', $this->branching, $this ); 		return $this->branching;	}

Changelog

Introduced in 4.9.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 7.0.4 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.