【PHP8.x】date_sub関数の使い方

<?php

/**
 * 現在の日時から1日を減算し、結果を表示するサンプルコード。
 *
 * date_sub() 関数は、指定されたDateTimeオブジェクトから指定された期間を減算します。
 * この関数は、最初の引数として渡されたDateTimeオブジェクト自体を更新し、
 * 更新されたDateTimeオブジェクトを返します。
 */

// 1. 現在の日時を表すDateTimeオブジェクトを作成します。
$currentDate = new DateTime();
echo "現在の年月日と時間: " . $currentDate->format('Y-m-d H:i:s') . "\n";

// 2. 1日を表すDateIntervalオブジェクトを作成します。
//    'P1D' は 'Period 1 Day' を意味します。
$oneDayInterval = new DateInterval('P1D');

// 3. date_sub() 関数を使用して、現在の日時から1日を減算します。
//    $currentDateオブジェクト自体が更新されます。
$modifiedDate = date_sub($currentDate, $oneDayInterval);

// 4. 1日減算された日時を表示します。
//    $currentDateと$modifiedDateは、同じ更新されたDateTimeオブジェクトを参照しています。
echo "1日減算後の年月日と時間: " . $modifiedDate->format('Y-m-d H:i:s') . "\n";

?>

PHPのdate_sub関数は、指定した日時から特定の期間を減算するために使用されます。この関数は、最初の引数であるDateTimeオブジェクト（減算の基準となる日時）から、2番目の引数であるDateIntervalオブジェクト（減算したい期間）を差し引きます。この関数の非常に重要な挙動として、渡されたDateTimeオブジェクト自体が更新される点が挙げられます。そして、更新されたDateTimeオブジェクトを戻り値として返します。

サンプルコードでは、まずnew DateTime()で現在の日時を表すオブジェクトを作成し、現在の年月日と時間を表示しています。次に、new DateInterval('P1D')を使って「1日」という期間を表すオブジェクトを作成します。ここで使われる'P1D'は「Period 1 Day」の略で、1日を意味します。その後、date_sub()関数に現在の日時オブジェクトと1日の期間オブジェクトを渡すことで、現在の日時から1日を減算します。この操作によって、元の現在の日時オブジェクトは1日前の日付に更新されます。最終的に、更新された日時オブジェクトの値を表示し、1日減算された結果を確認することができます。このようにdate_sub関数を使うと、日付や時刻の計算を効率的に行えます。

<?php

/**
 * 現在の日時から1ヶ月前の日時を計算して表示する関数。
 *
 * date_sub関数を使用して、指定されたDateTimeオブジェクトから
 * DateIntervalオブジェクトで定義された期間を減算します。
 */
function calculateOneMonthAgo(): void
{
    // 現在の日時を表すDateTimeオブジェクトを作成します。
    // PHP 8.0以降では、DateTimeImmutableを推奨されるケースもありますが、
    // ここではdate_sub関数の引数型に合わせてDateTimeを使用します。
    $currentDateTime = new DateTime();

    // 1ヶ月間隔を表すDateIntervalオブジェクトを作成します。
    // 'P1M' は「期間1ヶ月」を意味します。
    $oneMonthInterval = new DateInterval('P1M');

    // date_sub関数を使用して、現在の日時から1ヶ月を減算します。
    // date_subはDateTimeオブジェクト自体を変更し、そのオブジェクトを返します。
    $oneMonthAgo = date_sub($currentDateTime, $oneMonthInterval);

    // 結果の日時を分かりやすい形式で表示します。
    echo "現在の日時: " . (new DateTime())->format('Y-m-d H:i:s') . "\n";
    echo "1ヶ月前の日時: " . $oneMonthAgo->format('Y-m-d H:i:s') . "\n";
}

// 関数を実行し、結果を出力します。
calculateOneMonthAgo();

このサンプルコードは、PHPのdate_sub関数を使用して、現在の日時から指定した期間（この場合は1ヶ月）を減算し、過去の日時を計算する方法を示しています。date_sub関数は、あるDateTimeオブジェクトから、別のDateIntervalオブジェクトで定義された期間を減算するために使われます。

まず、new DateTime()で現在の年月日と時刻を表すDateTimeオブジェクトを作成します。次に、new DateInterval('P1M')を使って「1ヶ月」という期間を定義するDateIntervalオブジェクトを作成します。このP1Mは「期間（Period）1ヶ月」を意味するISO 8601形式の表記です。

そして、date_sub関数にこれら二つのオブジェクトを渡して呼び出します。第一引数$objectには基準となるDateTimeオブジェクト（現在の時刻）、第二引数$intervalには減算したい期間を表すDateIntervalオブジェクトを指定します。date_sub関数は、第一引数で渡されたDateTimeオブジェクト自体を直接変更し、その変更後のDateTimeオブジェクトを戻り値として返します。このため、元の$currentDateTime変数の値が1ヶ月前の日時になります。最後に、変更されたDateTimeオブジェクトをformat('Y-m-d H:i:s')で読みやすい形式に整形して表示し、現在の日時と1ヶ月前の日時を比較して確認することができます。