Item.php
48 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\API\REST\V3\Support; |
| 4 | |
| 5 | use DateTime; |
| 6 | |
| 7 | /** |
| 8 | * Item utilities for WordPress REST API V3 |
| 9 | * |
| 10 | * Formats DateTime objects for API responses using WordPress-compatible format. |
| 11 | * Date formatting uses WordPress mysql_to_rfc3339() function for full compatibility. |
| 12 | * Only DateTime objects are supported for date formatting. |
| 13 | * |
| 14 | * @since 4.9.0 |
| 15 | */ |
| 16 | class Item |
| 17 | { |
| 18 | /** |
| 19 | * @since 4.9.0 |
| 20 | */ |
| 21 | public static function formatDatesForResponse(array $item, array $dateFields): array |
| 22 | { |
| 23 | foreach ($dateFields as $field) { |
| 24 | if (isset($item[$field]) && self::isDateTimeObject($item[$field])) { |
| 25 | // Convert DateTime to WordPress-compatible ISO 8601 format. |
| 26 | // PHP's DateTime::format('c') includes timezone (e.g., "2025-09-02T20:27:02+00:00"), |
| 27 | // but WordPress removes the timezone for consistency across all endpoints. |
| 28 | // WordPress format: "2025-09-02T20:27:02" (without timezone) |
| 29 | // Using mysql_to_rfc3339() ensures compatibility with WordPress date formatting standards. |
| 30 | |
| 31 | // phpcs:disable -- WordPress core function mysql_to_rfc3339 is intentionally used for compatibility |
| 32 | $item[$field] = mysql_to_rfc3339($item[$field]->format('c')); |
| 33 | // phpcs:enable |
| 34 | } |
| 35 | } |
| 36 | |
| 37 | return $item; |
| 38 | } |
| 39 | |
| 40 | /** |
| 41 | * @since 4.9.0 |
| 42 | */ |
| 43 | private static function isDateTimeObject($value): bool |
| 44 | { |
| 45 | return $value instanceof DateTime; |
| 46 | } |
| 47 | } |
| 48 |