Oihana PHP

subYears.php

Table of Contents

Functions

subYears()  : DateTimeImmutable
Returns a copy of a date shifted backwards by a number of years, clamping day overflow.

Functions

subYears()

Returns a copy of a date shifted backwards by a number of years, clamping day overflow.

subYears(DateTimeInterface $date, int $years) : DateTimeImmutable

A new DateTimeImmutable is returned ; the source date is never modified. Equivalent to addYears( $date , -$years ) — see addYears() for the day-clamping semantics.

Parameters
$date : DateTimeInterface

The source date.

$years : int

The number of years to subtract.

Tags
example 
use function oihana\core\date\subYears;

subYears( new DateTimeImmutable( '2026-01-15' ) , 1 ) ; // 2025-01-15
subYears( new DateTimeImmutable( '2028-02-29' ) , 1 ) ; // 2027-02-28 (clamped, 2027 is not a leap year)
author

Marc Alcaraz (ekameleon)

since
1.2.0
Return values
DateTimeImmutable —

A new immutable date shifted backwards by $years years, day-clamped.

On this page

Search results