wordpress / latest / classes / wp_theme / translate_header.html

WP_Theme::translate_header( string $header, string|array $value ): string|array

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Translates a theme header.

Parameters

$header string Required
Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
$value string|array Required
Value to translate. An array for Tags header, string otherwise.

Return

string|array Translated value. An array for Tags header, string otherwise.

Source

File: wp-includes/class-wp-theme.php. View all references

private function translate_header( $header, $value ) {
	switch ( $header ) {
		case 'Name':
			// Cached for sorting reasons.
			if ( isset( $this->name_translated ) ) {
				return $this->name_translated;
			}

			// phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText,WordPress.WP.I18n.NonSingularStringLiteralDomain
			$this->name_translated = translate( $value, $this->get( 'TextDomain' ) );

			return $this->name_translated;
		case 'Tags':
			if ( empty( $value ) || ! function_exists( 'get_theme_feature_list' ) ) {
				return $value;
			}

			static $tags_list;
			if ( ! isset( $tags_list ) ) {
				$tags_list = array(
					// As of 4.6, deprecated tags which are only used to provide translation for older themes.
					'black'             => __( 'Black' ),
					'blue'              => __( 'Blue' ),
					'brown'             => __( 'Brown' ),
					'gray'              => __( 'Gray' ),
					'green'             => __( 'Green' ),
					'orange'            => __( 'Orange' ),
					'pink'              => __( 'Pink' ),
					'purple'            => __( 'Purple' ),
					'red'               => __( 'Red' ),
					'silver'            => __( 'Silver' ),
					'tan'               => __( 'Tan' ),
					'white'             => __( 'White' ),
					'yellow'            => __( 'Yellow' ),
					'dark'              => _x( 'Dark', 'color scheme' ),
					'light'             => _x( 'Light', 'color scheme' ),
					'fixed-layout'      => __( 'Fixed Layout' ),
					'fluid-layout'      => __( 'Fluid Layout' ),
					'responsive-layout' => __( 'Responsive Layout' ),
					'blavatar'          => __( 'Blavatar' ),
					'photoblogging'     => __( 'Photoblogging' ),
					'seasonal'          => __( 'Seasonal' ),
				);

				$feature_list = get_theme_feature_list( false ); // No API.

				foreach ( $feature_list as $tags ) {
					$tags_list += $tags;
				}
			}

			foreach ( $value as &$tag ) {
				if ( isset( $tags_list[ $tag ] ) ) {
					$tag = $tags_list[ $tag ];
				} elseif ( isset( self::$tag_map[ $tag ] ) ) {
					$tag = $tags_list[ self::$tag_map[ $tag ] ];
				}
			}

			return $value;

		default:
			// phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText,WordPress.WP.I18n.NonSingularStringLiteralDomain
			$value = translate( $value, $this->get( 'TextDomain' ) );
	}
	return $value;
}

Uses

Uses Description

Changelog

Version Description
3.4.0 Introduced.

© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_theme/translate_header