get_theme_mod() │ WP 2.1.0

Retrieve theme modification value for the current theme.

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

Uses: get_theme_mods()
Used By: get_custom_logo(), get_header_image(), get_nav_menu_locations(), get_header_textcolor(), get_header_video_url(), has_custom_logo()
1 time — 0.000035 sec (very fast) | 50000 times — 0.58 sec (very fast) | PHP 7.0.5, WP 4.5
Hooks from the function

Return

Mixed. Theme modification value.

Usage

get_theme_mod( $name, $default );
$name(string) (required)
Theme modification name.
$default(mixed)
Theme modification default value.
Default: false

Changelog

Since 2.1.0 Introduced.

Code of get_theme_mod() WP 5.9.3

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 mixed $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 ) ) {
			// Remove a single trailing percent sign.
			$default = preg_replace( '#(?<!%)%$#', '', $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 );
}

Theme Modification API (theme mods options settings)

Other Theme Functions