get_theme_mods() – Function | Developer.WordPress.org

Retrieves all theme modifications.

Return

array Theme modifications.

More Information

This function will update the options for theme mods which were created in older WordPress versions that used the deprecated mods_$theme_name option key to now use theme_mod_$name.

Source

function get_theme_mods() {
	$theme_slug = get_option( 'stylesheet' );
	$mods       = get_option( "theme_mods_$theme_slug" );

	if ( false === $mods ) {
		$theme_name = get_option( 'current_theme' );
		if ( false === $theme_name ) {
			$theme_name = wp_get_theme()->get( 'Name' );
		}

		$mods = get_option( "mods_$theme_name" ); // Deprecated location.
		if ( is_admin() && false !== $mods ) {
			update_option( "theme_mods_$theme_slug", $mods );
			delete_option( "mods_$theme_name" );
		}
	}

	if ( ! is_array( $mods ) ) {
		$mods = array();
	}

	return $mods;
}

View all references View on Trac View on GitHub

Uses	Description
wp_get_theme()`wp-includes/theme.php`	Gets a WP_Theme object for a theme.
WP_Theme::get()`wp-includes/class-wp-theme.php`	Gets a raw, unformatted theme header.
delete_option()`wp-includes/option.php`	Removes an option by name. Prevents removal of protected WordPress options.
is_admin()`wp-includes/load.php`	Determines whether the current request is for an administrative interface page.
update_option()`wp-includes/option.php`	Updates the value of an option that was already added.
get_option()`wp-includes/option.php`	Retrieves an option value based on an option name.

Show 3 more Show less

Used by	Description
get_media_states()`wp-admin/includes/template.php`	Retrieves an array of media states from an attachment.
set_theme_mod()`wp-includes/theme.php`	Updates theme modification value for the active theme.
remove_theme_mod()`wp-includes/theme.php`	Removes theme modification name from active theme list.
get_theme_mod()`wp-includes/theme.php`	Retrieves theme modification value for the active theme.

Changelog

Version	Description
5.9.0	The return value is always an array.
3.1.0	Introduced.

User Contributed Notes

Codex 9 years ago

Example

$mods = get_theme_mods();

var_dump( $mods );
// output example:
//    array(2) { ["header_textcolor"]=> string(3) "333" ["header_image"]=> string(20) "random-default-image" }

var_dump( $mods['header_textcolor'] );
// output example:
//    string(3) "333"

get_theme_mods(): array

In this article

Return

More Information

Source

Changelog

User Contributed Notes

get_theme_mods(): array

In this article

Return

More Information

Source

Related

Changelog

User Contributed Notes