【PHP8.x】idate関数の使い方
idate関数は、指定されたUnixタイムスタンプを基に、日付や時刻の各要素を整数値として取得する関数です。この関数は、現在の時刻や任意の過去・未来の時刻から、年、月、日、時、分、秒などの情報を個別に数値として取り出したい場合に非常に有用です。
関数の最初の引数には、取得したい情報の形式を指定する『フォーマット文字』を指定します。例えば、「Y」を指定すれば西暦の年、「m」を指定すれば月、「d」を指定すれば日といった具体的な整数値が返されます。これらのフォーマット文字は、PHPのdate関数で利用されるものと共通しています。
二番目の引数には、日付や時刻の基準となる『Unixタイムスタンプ』を指定します。これは、1970年1月1日00:00:00 UTCからの経過秒数を表す整数値です。この引数を省略した場合は、関数が実行された時点のローカルな現在時刻が自動的に使用されます。
idate関数の大きな特徴は、date関数が日付や時刻の要素を文字列として返すのに対し、idate関数は常に整数値を返す点にあります。これにより、取得した日付や時刻の要素をそのまま数値として計算したり、他の数値と比較したりする処理が容易になります。例えば、今年の年数を数値で取得して計算に利用するような場面で、型変換の手間なく直接扱うことが可能です。システム内で日付関連の計算を行う際などに、この関数は効率的なデータ処理をサポートします。
基本的な使い方
構文(syntax)
idate(string $format, int $timestamp = time()): int|string|false
引数(parameters)
string $format, ?int $timestamp = null
- string $format: 取得したい日付/時刻のフォーマットを指定する文字列。例えば 'Y'（年）、'm'（月）、'd'（日）、'H'（時）、'i'（分）、's'（秒）など。
- ?int $timestamp = null: フォーマットする Unix タイムスタンプ。省略した場合、現在のローカル時刻が使用されます。
戻り値(return)
int|false
idate 関数は、指定されたフォーマット文字列に基づき、日付や時刻を表す整数を返します。フォーマットが無効な場合や、指定された値が有効な日付・時刻を表さない場合は false を返します。