函式名稱:DateTimeInterface::format()
適用版本:PHP 5 >= 5.5.0, PHP 7, PHP 8
函式描述: DateTimeInterface::format() 方法用於將日期和時間物件的值格式化為指定的字串格式。
用法: DateTimeInterface::format(string $format): string|false
引數:
- $format: 必需,用於指定日期和時間的輸出格式。
- 返回值:返回格式化後的日期和時間字串。如果出現錯誤,則返回 false。
示例:
// 建立一個 DateTime 物件
$date = new DateTime('2022-01-01 12:30:45');
// 使用 format() 方法將日期格式化為指定格式
$formattedDate = $date->format('Y-m-d H:i:s');
echo $formattedDate; // 輸出:2022-01-01 12:30:45
// 格式化為另一種常用格式
$formattedDate2 = $date->format('F j, Y, g:i a');
echo $formattedDate2; // 輸出:January 1, 2022, 12:30 pm
// 使用 format() 方法獲取日期和時間的部分值
$year = $date->format('Y');
$month = $date->format('m');
$day = $date->format('d');
echo "$year-$month-$day"; // 輸出:2022-01-01
// 使用 format() 方法獲取日期和時間的某些特殊值
$dayOfWeek = $date->format('l'); // 獲取星期幾
$timezone = $date->format('e'); // 獲取時區
echo "Today is $dayOfWeek. Timezone: $timezone"; // 輸出:Today is Saturday. Timezone: UTC
請注意:
- 引數 $format 中的格式程式碼可以根據需求進行組合,具體的格式程式碼可以參考 PHP 官方文件中關於日期和時間格式的部分。
- 如果傳入的日期和時間物件無效,或者格式化失敗,format() 方法會返回 false。
- DateTimeInterface 是 DateTime 類和 DateTimeImmutable 類的父介面,format() 方法在這兩個類中都可以使用。
- 在此示例中,我們使用 DateTime 類進行演示,但 DateTimeImmutable 類也具有相同的 format() 方法用法。