You are here

function hook_commerce_checkout_first_checkout_page in Commerce Core 7

Allows modules to define the first page for a new order entering checkout.

The default first checkout page is whatever the first page is after the checkout pages array is sorted by weight. This hook allows modules to provide an alternate page ID or default page ID without having to build the checkout page and pane info arrays, providing a noticeable performance improvement.

If more than one module implements this hook, the first returned value will be used.

Return value

string The new first checkout page ID.

1 invocation of hook_commerce_checkout_first_checkout_page()
commerce_checkout_first_checkout_page in modules/checkout/commerce_checkout.module
Returns the page ID of the first checkout page to be used.

File

modules/checkout/commerce_checkout.api.php, line 312
Hooks provided by the Checkout module.

Code

function hook_commerce_checkout_first_checkout_page() {
  return 'checkout';
}