WordPress at a glance

get_theme_mod() WP 1.0

Retrieve theme modification value for the current theme.

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.

Works based on: get_theme_mods()
1 time = 0.000035s = very fast | 50000 times = 0.58s = 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(string/false)
Theme modification default value.
Default: false

Changelog

Since 2.1.0 Introduced.

Code of get_theme_mod() WP 5.5.1

<?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 );
}

From tag: Theme Modification API (theme mods options settings)

More from category: Other Theme Functions

No comments
    Log In . Register