W3cubDocs

/WordPress

Custom_Background::wp_set_background_image()

This method has been deprecated.

Source

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

public function wp_set_background_image() {
		if ( ! current_user_can( 'edit_theme_options' ) || ! isset( $_POST['attachment_id'] ) ) {
			exit;
		}

		$attachment_id = absint( $_POST['attachment_id'] );

		$sizes = array_keys(
			/** This filter is documented in wp-admin/includes/media.php */
			apply_filters(
				'image_size_names_choose',
				array(
					'thumbnail' => __( 'Thumbnail' ),
					'medium'    => __( 'Medium' ),
					'large'     => __( 'Large' ),
					'full'      => __( 'Full Size' ),
				)
			)
		);

		$size = 'thumbnail';
		if ( in_array( $_POST['size'], $sizes, true ) ) {
			$size = esc_attr( $_POST['size'] );
		}

		update_post_meta( $attachment_id, '_wp_attachment_is_custom_background', get_option( 'stylesheet' ) );

		$url       = wp_get_attachment_image_src( $attachment_id, $size );
		$thumbnail = wp_get_attachment_image_src( $attachment_id, 'thumbnail' );
		set_theme_mod( 'background_image', esc_url_raw( $url[0] ) );
		set_theme_mod( 'background_image_thumb', esc_url_raw( $thumbnail[0] ) );
		exit;
	}

Uses

Uses Description
wp-admin/includes/media.php: image_size_names_choose

Filters the names and labels of the default image sizes.
wp-includes/capabilities.php: current_user_can()

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

Updates theme modification value for the current theme.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/formatting.php: esc_attr()

Escaping for HTML attributes.
wp-includes/formatting.php: esc_url_raw()

Performs esc_url() for database usage.
wp-includes/functions.php: absint()

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

Calls the callback functions that have been added to a filter hook.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/media.php: wp_get_attachment_image_src()

Retrieves an image to represent an attachment.
wp-includes/post.php: update_post_meta()

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

Changelog

Version Description
3.5.0 This method has been deprecated.
3.4.0 Introduced.

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