【PHP8.x】formatメソッドの使い方

formatメソッドは、DateIntervalオブジェクトが表す期間を文字列としてフォーマットするメソッドです。このメソッドを使用することで、期間を年、月、日、時間、分、秒などの単位で表現した文字列を取得できます。

formatメソッドは、%記号で始まるフォーマット指定子を使用して、出力される文字列の形式を制御します。例えば、%yは年数を、%mは月数を、%dは日数を表します。複数のフォーマット指定子を組み合わせることで、複雑な期間の表現も可能です。

formatメソッドの引数には、フォーマット文字列を指定します。フォーマット文字列には、出力したい単位に対応するフォーマット指定子を含めます。例えば、%y年%mヶ月%d日というフォーマット文字列を指定すると、「X年Yヶ月Z日」のような形式で期間が出力されます。

formatメソッドは、DateIntervalオブジェクトが表す期間に基づいて、指定されたフォーマットに従って文字列を生成し、その文字列を返します。DateIntervalオブジェクトが負の期間を表す場合、結果の文字列には負の記号が含まれることがあります。

例えば、$interval = new DateInterval('P1Y2M3D');というDateIntervalオブジェクトがあり、$interval->format('%y年%mヶ月%d日');を実行すると、1年2ヶ月3日という文字列が返されます。システム開発において、期間をユーザーにわかりやすく表示したり、ログに出力したりする場合に、このformatメソッドは非常に役立ちます。DateIntervalオブジェクトが表す期間を、必要な形式で文字列に変換するために利用できます。

Copy
1DateInterval::format(string $format): string

string $format

• string $format: 日付や時刻のフォーマットを指定する文字列

string

指定されたフォーマット文字列に従って、日付と時刻の期間を文字列として返します。