wp_maybe_decline_date() │ WP 4.4.0

Determines if the date should be declined.

If the locale specifies that month names require a genitive case in certain formats (like 'j F Y'), the month name will be replaced with a correct form.

Uses: WP_Locale()
1 time — 0.000227 sec (fast) | 50000 times — 0.51 sec (very fast) | PHP 7.2.16, WP 5.2

No Hooks.

Return

String. The date, declined if locale specifies it.

Usage

wp_maybe_decline_date( $date, $format );
$date(string) (required)
Formatted date string.
$format(string)
Date format to check.
Default: empty string

Examples

0

#1 Date conversion examples

This will work only if site language date parts can be declined. This option is set in translation string 'on' === _x( 'off', 'decline months names: on or off' ).

For example, suppose our site is running in the Russian language, where months could be declined, then:

echo wp_maybe_decline_date( '15 Май 2019' ); //> 15 мая 2019

The date has the right format, but the month is already written in it correctly - the function does not change anything, although it does all the same operations to find a replacement.

echo wp_maybe_decline_date( '15 Мая 2019' ); //> 15 Мая 2019
echo wp_maybe_decline_date( '15 мая 2019' ); //> 15 мая 2019

The date has the wrong format, the function just returns it without any attempt to change anything.

echo wp_maybe_decline_date( 'Май 2019 года' ); //> Май 2019 года

Notes

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

Changelog

Since 4.4.0 Introduced.
Since 5.4.0 The $format parameter was added.

wp_maybe_decline_date() code WP 6.8

wp-includes/functions.php 
function wp_maybe_decline_date( $date, $format = '' ) {
	global $wp_locale;

	// i18n functions are not available in SHORTINIT mode.
	if ( ! function_exists( '_x' ) ) {
		return $date;
	}

	/*
	 * translators: If months in your language require a genitive case,
	 * translate this to 'on'. Do not translate into your own language.
	 */
	if ( 'on' === _x( 'off', 'decline months names: on or off' ) ) {

		$months          = $wp_locale->month;
		$months_genitive = $wp_locale->month_genitive;

		/*
		 * Match a format like 'j F Y' or 'j. F' (day of the month, followed by month name)
		 * and decline the month.
		 */
		if ( $format ) {
			$decline = preg_match( '#[dj]\.? F#', $format );
		} else {
			// If the format is not passed, try to guess it from the date string.
			$decline = preg_match( '#\b\d{1,2}\.? [^\d ]+\b#u', $date );
		}

		if ( $decline ) {
			foreach ( $months as $key => $month ) {
				$months[ $key ] = '# ' . preg_quote( $month, '#' ) . '\b#u';
			}

			foreach ( $months_genitive as $key => $month ) {
				$months_genitive[ $key ] = ' ' . $month;
			}

			$date = preg_replace( $months, $months_genitive, $date );
		}

		/*
		 * Match a format like 'F jS' or 'F j' (month name, followed by day with an optional ordinal suffix)
		 * and change it to declined 'j F'.
		 */
		if ( $format ) {
			$decline = preg_match( '#F [dj]#', $format );
		} else {
			// If the format is not passed, try to guess it from the date string.
			$decline = preg_match( '#\b[^\d ]+ \d{1,2}(st|nd|rd|th)?\b#u', trim( $date ) );
		}

		if ( $decline ) {
			foreach ( $months as $key => $month ) {
				$months[ $key ] = '#\b' . preg_quote( $month, '#' ) . ' (\d{1,2})(st|nd|rd|th)?([-–]\d{1,2})?(st|nd|rd|th)?\b#u';
			}

			foreach ( $months_genitive as $key => $month ) {
				$months_genitive[ $key ] = '$1$3 ' . $month;
			}

			$date = preg_replace( $months, $months_genitive, $date );
		}
	}

	// Used for locale-specific rules.
	$locale = get_locale();

	if ( 'ca' === $locale ) {
		// " de abril| de agost| de octubre..." -> " d'abril| d'agost| d'octubre..."
		$date = preg_replace( '# de ([ao])#i', " d'\\1", $date );
	}

	return $date;
}

date time