W3cubDocs

/WordPress

get_theme_mod( string $name, string|false $default = false )

Retrieves theme modification value for the current theme.

Description

If the modification name does not exist, then the $default will be passed through sprintf() PHP function with the template directory URI as the first string and the stylesheet directory URI as the second string.

Parameters

$name

(string) (Required) Theme modification name.

$default

(string|false) (Optional) Theme modification default value.

Default value: false

Return

(mixed) Theme modification value.

Source

File: wp-includes/theme.php 

function get_theme_mod( $name, $default = false ) {
	$mods = get_theme_mods();

	if ( isset( $mods[ $name ] ) ) {
		/**
		 * Filters the theme modification, or 'theme_mod', value.
		 *
		 * The dynamic portion of the hook name, `$name`, refers to the key name
		 * of the modification array. For example, 'header_textcolor', 'header_image',
		 * and so on depending on the theme options.
		 *
		 * @since 2.2.0
		 *
		 * @param string $current_mod The value of the current theme modification.
		 */
		return apply_filters( "theme_mod_{$name}", $mods[ $name ] );
	}

	if ( is_string( $default ) ) {
		// Only run the replacement if an sprintf() string format pattern was found.
		if ( preg_match( '#(?<!%)%(?:\d+\$?)?s#', $default ) ) {
			$default = sprintf( $default, get_template_directory_uri(), get_stylesheet_directory_uri() );
		}
	}

	/** This filter is documented in wp-includes/theme.php */
	return apply_filters( "theme_mod_{$name}", $default );
}

Uses

Uses Description
wp-includes/theme.php: theme_mod_{$name}

Filters the theme modification, or ‘theme_mod’, value.
wp-includes/theme.php: get_theme_mods()

Retrieves all theme modifications.
wp-includes/theme.php: get_template_directory_uri()

Retrieves template directory URI for current theme.
wp-includes/theme.php: get_stylesheet_directory_uri()

Retrieves stylesheet directory URI for current theme.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.

Used By

Used By Description
wp-includes/widgets.php: wp_map_sidebars_widgets()

Compares a list of sidebars with their widgets against an allowed list.
wp-includes/theme.php: wp_get_custom_css_post()

Fetches the custom_css post for a given theme.
wp-includes/theme.php: get_header_video_url()

Retrieves header video URL for custom header.
wp-includes/theme.php: _custom_logo_header_styles()

Adds CSS to hide header text for custom logo, based on Customizer setting.
wp-includes/general-template.php: has_custom_logo()

Determines whether the site has a custom logo.
wp-includes/general-template.php: get_custom_logo()

Returns a custom logo, linked to home unless the theme supports removing the link on the home page.
wp-includes/class-wp-customize-setting.php: WP_Customize_Setting::get_root_value()

Get the root value for a setting, especially for multidimensional ones.
wp-admin/includes/template.php: _media_states()

Outputs the attachment media states as HTML.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::show_header_selector()

Display UI for selecting one of several default headers.
wp-admin/includes/class-custom-background.php: Custom_Background::admin_page()

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

Retrieves value for custom background color.
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/theme.php: get_header_textcolor()

Retrieves the custom header text color in 3- or 6-digit hexadecimal form.
wp-includes/theme.php: display_header_text()

Whether to display the header text.
wp-includes/theme.php: get_header_image()

Retrieves header image for custom header.
wp-includes/theme.php: _get_random_header_data()

Gets random header image data from registered images in theme.
wp-includes/theme.php: is_random_header_image()

Checks if random header image is in use.
wp-includes/theme.php: get_custom_header()

Gets the header image data.
wp-includes/theme.php: get_background_image()

Retrieves background image for custom background.
wp-includes/theme.php: switch_theme()

Switches the theme.
wp-includes/nav-menu.php: get_nav_menu_locations()

Retrieves all registered navigation menu locations and the menus assigned to them.
wp-includes/widgets.php: retrieve_widgets()

Look for “lost” widgets, this has to run at least on each theme change.

Changelog

Version Description
2.1.0 Introduced.

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