wp_xmlrpc_server::_toggle_sticky( array $post_data, bool $update = false ): void|IXR_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

$post_dataarray

$updatebooloptional

Default: false

Return value

void|IXR_Error

Performance profile

How much work a call to wp_xmlrpc_server::_toggle_sticky() 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

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

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

Instructions

15–35

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

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

What it touches

• optionoption read or writeget_option()one call below wp_xmlrpc_server::_toggle_sticky()
• hookthird-party callbacksdo_action()one call below wp_xmlrpc_server::_toggle_sticky()

Further down the call graph this can also reach cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

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

Uses · 7

• get_post_type_object()Retrieves a post type object by name.
• __()Retrieves the translation of $text.
• unstick_post()Un-sticks a post.
• current_user_can()Returns whether the current user has the specified capability.
• wp_validate_boolean()Filters/validates a variable as a boolean.
• stick_post()Makes a post sticky.
• IXR_Error::__construct()PHP5 constructor.

Used by · 3

• wp_xmlrpc_server::_insert_post()Helper method for wp_newPost() and wp_editPost(), containing shared logic.
• wp_xmlrpc_server::mw_editPost()Edits a post.
• wp_xmlrpc_server::mw_newPost()Creates a new post.

Source code

View on Trac ↗View on GitHub ↗

1376	private function _toggle_sticky( $post_data, $update = false ) {1377		$post_type = get_post_type_object( $post_data['post_type'] );1378 1379		// Private and password-protected posts cannot be stickied.1380		if ( 'private' === $post_data['post_status'] || ! empty( $post_data['post_password'] ) ) {1381			// Error if the client tried to stick the post, otherwise, silently unstick.1382			if ( ! empty( $post_data['sticky'] ) ) {1383				return new IXR_Error( 401, __( 'Sorry, you cannot stick a private post.' ) );1384			}1385 1386			if ( $update ) {1387				unstick_post( $post_data['ID'] );1388			}1389		} elseif ( isset( $post_data['sticky'] ) ) {1390			if ( ! current_user_can( $post_type->cap->edit_others_posts ) ) {1391				return new IXR_Error( 401, __( 'Sorry, you are not allowed to make posts sticky.' ) );1392			}1393 1394			$sticky = wp_validate_boolean( $post_data['sticky'] );1395			if ( $sticky ) {1396				stick_post( $post_data['ID'] );1397			} else {1398				unstick_post( $post_data['ID'] );1399			}1400		}1401	}

Changelog

Introduced in 4.3.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-xmlrpc-server.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.