wc_rest_prepare_date_response( string|null|WC_DateTime $date, bool $utc = true )

Parses and formats a date for ISO8601/RFC3339.

Contents

Description Description

Required WP 4.4 or later. See https://developer.wordpress.org/reference/functions/mysql_to_rfc3339/

Parameters Parameters

$date

(Required) Date.

$utc

(Optional) Send false to get local/offset time.

Default value: true

Top ↑

Return Return

(string|null) ISO8601/RFC3339 formatted datetime.

Top ↑

Source Source

File: includes/wc-rest-functions.php 

function wc_rest_prepare_date_response( $date, $utc = true ) {
	if ( is_numeric( $date ) ) {
		$date = new WC_DateTime( "@$date", new DateTimeZone( 'UTC' ) );
		$date->setTimezone( new DateTimeZone( wc_timezone_string() ) );
	} elseif ( is_string( $date ) ) {
		$date = new WC_DateTime( $date, new DateTimeZone( 'UTC' ) );
		$date->setTimezone( new DateTimeZone( wc_timezone_string() ) );
	}

	if ( ! is_a( $date, 'WC_DateTime' ) ) {
		return null;
	}

	// Get timestamp before changing timezone to UTC.
	return gmdate( 'Y-m-d\TH:i:s', $utc ? $date->getTimestamp() : $date->getOffsetTimestamp() );
}

Expand full source code Collapse full source code

Top ↑

Changelog Changelog

Changelog
Version Description
2.6.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
includes/wc-formatting-functions.php: wc_timezone_string()

WooCommerce Timezone – helper to retrieve the timezone string for a site until.

Top ↑

Used By Used By

Used By
Used By Description
packages/woocommerce-blocks/src/StoreApi/Schemas/ProductReviewSchema.php: ProductReviewSchema::get_item_response()

Convert a WooCommerce product into an object suitable for the response.
includes/legacy/api/class-wc-rest-legacy-coupons-controller.php: WC_REST_Legacy_Coupons_Controller::prepare_item_for_response()

Prepare a single coupon output for response.
includes/legacy/api/class-wc-rest-legacy-orders-controller.php: WC_REST_Legacy_Orders_Controller::prepare_item_for_response()

Prepare a single order output for response.
packages/woocommerce-admin/src/API/Products.php: Products::prepare_object_for_response()

Add low_stock_amount property to product data
packages/woocommerce-admin/src/API/Orders.php: Orders::get_formatted_item_data()

Get formatted item data.
packages/woocommerce-admin/src/API/Notes.php: Notes::prepare_item_for_response()

Prepare a note object for serialization.
packages/woocommerce-admin/src/API/Reports/Customers/Controller.php: Controller::prepare_item_for_response()

Prepare a report object for serialization.
includes/rest-api/Controllers/Version3/class-wc-rest-product-reviews-controller.php: WC_REST_Product_Reviews_Controller::prepare_item_for_response()

Prepare a single product review output for response.
includes/rest-api/Controllers/Version3/class-wc-rest-order-notes-controller.php: WC_REST_Order_Notes_Controller::prepare_item_for_response()

Prepare a single order note output for response.
includes/rest-api/Controllers/Version3/class-wc-rest-customers-controller.php: WC_REST_Customers_Controller::get_formatted_item_data()

Get formatted item data.
includes/rest-api/Controllers/Version3/class-wc-rest-product-categories-controller.php: WC_REST_Product_Categories_Controller::prepare_item_for_response()

Prepare a single product category output for response.
includes/rest-api/Controllers/Version3/class-wc-rest-products-controller.php: WC_REST_Products_Controller::get_images()

Get the images for a product or product variation.
includes/rest-api/Controllers/Version1/class-wc-rest-customer-downloads-v1-controller.php: WC_REST_Customer_Downloads_V1_Controller::prepare_item_for_response()

Prepare a single download output for response.
includes/rest-api/Controllers/Version3/class-wc-rest-product-variations-controller.php: WC_REST_Product_Variations_Controller::prepare_object_for_response()

Prepare a single variation output for response.
includes/rest-api/Controllers/Version3/class-wc-rest-product-variations-controller.php: WC_REST_Product_Variations_Controller::get_image()

Get the image for a product variation.
includes/rest-api/Controllers/Version1/class-wc-rest-coupons-v1-controller.php: WC_REST_Coupons_V1_Controller::prepare_item_for_response()

Prepare a single coupon output for response.
includes/rest-api/Controllers/Version1/class-wc-rest-orders-v1-controller.php: WC_REST_Orders_V1_Controller::prepare_item_for_response()

Prepare a single order output for response.
includes/rest-api/Controllers/Version1/class-wc-rest-product-reviews-v1-controller.php: WC_REST_Product_Reviews_V1_Controller::prepare_item_for_response()

Prepare a single product review output for response.
includes/rest-api/Controllers/Version1/class-wc-rest-product-categories-v1-controller.php: WC_REST_Product_Categories_V1_Controller::prepare_item_for_response()

Prepare a single product category output for response.
includes/rest-api/Controllers/Version1/class-wc-rest-order-refunds-v1-controller.php: WC_REST_Order_Refunds_V1_Controller::prepare_item_for_response()

Prepare a single order refund output for response.
includes/rest-api/Controllers/Version1/class-wc-rest-order-notes-v1-controller.php: WC_REST_Order_Notes_V1_Controller::prepare_item_for_response()

Prepare a single order note output for response.
includes/rest-api/Controllers/Version1/class-wc-rest-webhooks-v1-controller.php: WC_REST_Webhooks_V1_Controller::prepare_item_for_response()

Prepare a single webhook output for response.
includes/rest-api/Controllers/Version1/class-wc-rest-products-v1-controller.php: WC_REST_Products_V1_Controller::get_variation_data()

Get an individual variation’s data.
includes/rest-api/Controllers/Version1/class-wc-rest-products-v1-controller.php: WC_REST_Products_V1_Controller::get_images()

Get the images for a product or product variation.
includes/rest-api/Controllers/Version1/class-wc-rest-products-v1-controller.php: WC_REST_Products_V1_Controller::get_product_data()

Get product data.
includes/rest-api/Controllers/Version1/class-wc-rest-customers-v1-controller.php: WC_REST_Customers_V1_Controller::prepare_item_for_response()

Prepare a single customer output for response.
includes/rest-api/Controllers/Version2/class-wc-rest-customers-v2-controller.php: WC_REST_Customers_V2_Controller::get_formatted_item_data()

Get formatted item data.
includes/rest-api/Controllers/Version2/class-wc-rest-webhooks-v2-controller.php: WC_REST_Webhooks_V2_Controller::prepare_item_for_response()

Prepare a single webhook output for response.
includes/rest-api/Controllers/Version2/class-wc-rest-product-reviews-v2-controller.php: WC_REST_Product_Reviews_V2_Controller::prepare_item_for_response()

Prepare a single product review output for response.
includes/rest-api/Controllers/Version2/class-wc-rest-product-variations-v2-controller.php: WC_REST_Product_Variations_V2_Controller::prepare_object_for_response()

Prepare a single variation output for response.
includes/rest-api/Controllers/Version2/class-wc-rest-product-categories-v2-controller.php: WC_REST_Product_Categories_V2_Controller::prepare_item_for_response()

Prepare a single product category output for response.
includes/rest-api/Controllers/Version2/class-wc-rest-coupons-v2-controller.php: WC_REST_Coupons_V2_Controller::get_formatted_item_data()

Get formatted item data.
includes/rest-api/Controllers/Version2/class-wc-rest-order-notes-v2-controller.php: WC_REST_Order_Notes_V2_Controller::prepare_item_for_response()

Prepare a single order note output for response.
includes/rest-api/Controllers/Version2/class-wc-rest-customer-downloads-v2-controller.php: WC_REST_Customer_Downloads_V2_Controller::prepare_item_for_response()

Prepare a single download output for response.
includes/rest-api/Controllers/Version2/class-wc-rest-order-refunds-v2-controller.php: WC_REST_Order_Refunds_V2_Controller::get_formatted_item_data()

Get formatted item data.
includes/rest-api/Controllers/Version2/class-wc-rest-products-v2-controller.php: WC_REST_Products_V2_Controller::get_product_data()

Get product data.
includes/rest-api/Controllers/Version2/class-wc-rest-products-v2-controller.php: WC_REST_Products_V2_Controller::get_images()

Get the images for a product or product variation.
includes/rest-api/Controllers/Version2/class-wc-rest-orders-v2-controller.php: WC_REST_Orders_V2_Controller::get_formatted_item_data()

Get formatted item data.
Show 33 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.