get_background_image()

Retrieves background image for custom background.

Return

(string)

Source

File: wp-includes/theme.php 

function get_background_image() {
	return get_theme_mod( 'background_image', get_theme_support( 'custom-background', 'default-image' ) );
}

Uses

Uses Description
wp-includes/theme.php: get_theme_support()

Gets the theme support arguments passed when registering that support.
wp-includes/theme.php: get_theme_mod()

Retrieves theme modification value for the current theme.

Used By

Used By Description
wp-admin/includes/template.php: get_media_states()

Retrieves an array of media states from an attachment.
wp-admin/includes/class-custom-background.php: Custom_Background::admin_page()

Display the custom background page.
wp-includes/theme.php: background_image()

Displays background image path.
wp-includes/theme.php: _custom_background_cb()

Default custom background callback.
wp-includes/theme.php: _delete_attachment_theme_mod()

Checks an attachment being deleted to see if it’s a header or background image.
wp-includes/post-template.php: get_body_class()

Retrieves an array of the class names for the body element.

Changelog

Version Description
3.0.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_background_image