DateTime::sub

date_sub

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

DateTime::sub -- date_sub — Subtrai uma quantidade de dias, meses, anos, horas, minutos e segundos de um objeto DateTime

Descrição

Estilo orientado a objetos

public DateTime::sub(DateInterval $interval): DateTime

Estilo procedural

date_sub(DateTime $object, DateInterval $interval): DateTime

Modifica o objeto DateTime especificado, subtraindo o objeto DateInterval especificado.

Equivalente a DateTimeImmutable::sub() mas funciona com DateTime.

A versão procedural usa o objeto DateTime como seu primeiro argumento.

Parâmetros

object

Somente no estilo procedural: Um objeto DateTime retornado por date_create(). A função modifica este objeto.

interval

Um objeto DateInterval

Valor Retornado

Retorna o objeto DateTime modificado para encadeamento de métodos.

Erros/Exceções

Apenas para API orientada a objeto: Se uma operação não suportada for realizada, como o uso de um objeto DateInterval representando especificações de tempo relativo tipo next weekday, uma exceção DateInvalidOperationException é disparada.

Registro de Alterações

Versão Descrição
8.3.0 Agora dispara uma exceção DateInvalidOperationException com DateTime::sub(), em vez de um aviso quando uma operação não suportada é realizada. A função date_sub() não foi modificada.

Veja Também