W3cubDocs

/WordPress

Custom_Background::ajax_background_add()

Ajax handler for adding custom background context to an attachment.

Description

Triggers when the user adds a new background image from the Media Manager.

Source

File: wp-admin/includes/class-custom-background.php 

public function ajax_background_add() {
		check_ajax_referer( 'background-add', 'nonce' );

		if ( ! current_user_can( 'edit_theme_options' ) ) {
			wp_send_json_error();
		}

		$attachment_id = absint( $_POST['attachment_id'] );
		if ( $attachment_id < 1 ) {
			wp_send_json_error();
		}

		update_post_meta( $attachment_id, '_wp_attachment_is_custom_background', get_stylesheet() );

		wp_send_json_success();
	}

Uses

Uses Description
wp-includes/capabilities.php: current_user_can()

Returns whether the current user has the specified capability.
wp-includes/theme.php: get_stylesheet()

Retrieves name of the current stylesheet.
wp-includes/pluggable.php: check_ajax_referer()

Verifies the Ajax request to prevent processing requests external of the blog.
wp-includes/functions.php: wp_send_json_error()

Send a JSON response back to an Ajax request, indicating failure.
wp-includes/functions.php: absint()

Convert a value to non-negative integer.
wp-includes/functions.php: wp_send_json_success()

Send a JSON response back to an Ajax request, indicating success.
wp-includes/post.php: update_post_meta()

Updates a post meta field based on the given post ID.

Changelog

Version Description
4.1.0 Introduced.

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