wp_date() │ WP 5.3.0

Получает локализованную дату (переведенную на текущий язык) из переданной метки времени unix.

Эта функция является оберткой для PHP функции date().

Если в выводимой дате используется формат с месяцем или неделей в виде строки, то функция попытается перевести их на текущий язык. В остальных случаях - это аналог date() в PHP.

Это новая функция, предназначенная для замены date_i18n().

Имейте в виду, что эта функция возвращает дату, а не выводит её на экран.

Этой функции, в отличии от date_i18n(), нужно передавать метку времени Unix, без добавления к ней сдвижки временной зоны сайта.

Сдвижка временной зоны добавляется автоматически внутри функции на основе третьего параметра $timezone, в котором можно указать произвольную сдвижку временной зоны.

В связи с введением в версии 5.3 нового API для работы со временем:

Не рекомендуется:

  • НЕ получайте время как метка WP timestamps (метка времени + сдвижка времени сайта):

  • НЕ локализуйте время/дату функцией:

  • НЕ сохраняйте на постоянной основе WP timestamps.

  • НЕ сравнивайте WP timestamp'ы.

  • НЕ изменяйте временную зону PHP через date_default_timezone_set() - это важное требование для правильной работы ядра. По умолчанию в ВП устанавливается date_default_timezone_set( 'UTC' ) и эта установка не должна никогда меняться!

Рекомендуется:

Ниже указаны форматы DATE_RFC3339.

  • Получайте время как Unix timestamp (метка времени Unix без сдвижки) или как объект DateTimeImmutable:

  • Локализуйте время/дату базируясь на Unix timestamp:

  • Сохраняйте Unix timestamps или форматы, которые точно указывают момент времени, например DATE_RFC3339.

  • Сравнивайте метки времени Unix, объекты DateTimeImmutable или строковые даты в единой временной зоне.

  • Используйте объекты: DateTimeZone и DateTimeImmutable с функцией wp_date(), когда нужно обработать время во временной зоне отличной от зоны сайта).

Читайте также: Date/Time в WordPress.

Работает на основе: WP_Locale(), wp_timezone()
Основа для: date_i18n(), mysql2date()
Хуки из функции

Возвращает

Строку|false. Переведенную дату. False когда введена неправильная метка времени.

Использование

wp_date( $format, $timestamp, $timezone );
$format(строка) (обязательный)
Формат в котором выводить дату, пример: F j, Y - Ноябрь 6, 2010. Полный список форматов. В качестве формата можно использовать опцию get_option( 'date_format' ), которая задаётся в разделе "Настройки".
$timestamp(число)
Метка времени Unix из которой будет получена дата в указанном формате. По умолчанию используется текущая метка time().
По умолчанию: null - (time() - current UNIX time)
$timezone(DateTimeZone)
Временная зона, которая будет наложена на указанную метку времени. По умолчанию: wp_timezone().
По умолчанию: null (текущая временная зона из опций сайта)

Примеры

0

#1 Локализация php функции date() в WordPress

Текущее время:

$format = 'j F Y H:i:s';

echo wp_date( $format );   // 24 марта 2021 08:12:07 (время сайта = +5 часов)
echo date_i18n( $format ); // 24 марта 2021 08:12:07 (время сайта = +5 часов)
echo date( $format );      // 24 March 2021 03:12:07 (UTC время)

Указанное время:

echo wp_date( 'j F Y H:i:s', 0 );
// 1 января 1970 06:00:00

echo wp_date( 'j M Y H:i:s', strtotime('1999-11-15') );
// 15 Ноя 1999 05:00:00 (время сайта = +5 часов)

echo wp_date( 'j M Y H:i:s', strtotime('1999-11-15'), new DateTimeZone('UTC') );
// 15 Ноя 1999 00:00:00 (UTC время)
0

#2 Get a translatable the_date() equivalent

To do this you will need:

echo wp_date( get_option( 'date_format' ), get_post_timestamp() );

Полезная информация: https://make.wordpress.org/core/2019/09/23/date-time-improvements-wp-5-3/

Заметки

  • Global. WP_Locale. $wp_locale WordPress date and time locale object.

Список изменений

С версии 5.3.0 Введена.

Код wp_date() WP 6.5.2

wp-includes/functions.php 
function wp_date( $format, $timestamp = null, $timezone = null ) {
	global $wp_locale;

	if ( null === $timestamp ) {
		$timestamp = time();
	} elseif ( ! is_numeric( $timestamp ) ) {
		return false;
	}

	if ( ! $timezone ) {
		$timezone = wp_timezone();
	}

	$datetime = date_create( '@' . $timestamp );
	$datetime->setTimezone( $timezone );

	if ( empty( $wp_locale->month ) || empty( $wp_locale->weekday ) ) {
		$date = $datetime->format( $format );
	} else {
		// We need to unpack shorthand `r` format because it has parts that might be localized.
		$format = preg_replace( '/(?<!\\\\)r/', DATE_RFC2822, $format );

		$new_format    = '';
		$format_length = strlen( $format );
		$month         = $wp_locale->get_month( $datetime->format( 'm' ) );
		$weekday       = $wp_locale->get_weekday( $datetime->format( 'w' ) );

		for ( $i = 0; $i < $format_length; $i++ ) {
			switch ( $format[ $i ] ) {
				case 'D':
					$new_format .= addcslashes( $wp_locale->get_weekday_abbrev( $weekday ), '\\A..Za..z' );
					break;
				case 'F':
					$new_format .= addcslashes( $month, '\\A..Za..z' );
					break;
				case 'l':
					$new_format .= addcslashes( $weekday, '\\A..Za..z' );
					break;
				case 'M':
					$new_format .= addcslashes( $wp_locale->get_month_abbrev( $month ), '\\A..Za..z' );
					break;
				case 'a':
					$new_format .= addcslashes( $wp_locale->get_meridiem( $datetime->format( 'a' ) ), '\\A..Za..z' );
					break;
				case 'A':
					$new_format .= addcslashes( $wp_locale->get_meridiem( $datetime->format( 'A' ) ), '\\A..Za..z' );
					break;
				case '\\':
					$new_format .= $format[ $i ];

					// If character follows a slash, we add it without translating.
					if ( $i < $format_length ) {
						$new_format .= $format[ ++$i ];
					}
					break;
				default:
					$new_format .= $format[ $i ];
					break;
			}
		}

		$date = $datetime->format( $new_format );
		$date = wp_maybe_decline_date( $date, $format );
	}

	/**
	 * Filters the date formatted based on the locale.
	 *
	 * @since 5.3.0
	 *
	 * @param string       $date      Formatted date string.
	 * @param string       $format    Format to display the date.
	 * @param int          $timestamp Unix timestamp.
	 * @param DateTimeZone $timezone  Timezone.
	 */
	$date = apply_filters( 'wp_date', $date, $format, $timestamp, $timezone );

	return $date;
}

date time (дата время)

Дата/время