function hook_commerce_addressbook_labels_alter in Commerce Addressbook 7.3

Same name and namespace in other branches

1. 7.2 commerce_addressbook.api.php \hook_commerce_addressbook_labels_alter()

Allows modules to alter the list of customer profile labels.

During checkout the user selects the "address on file" from a dropdown list of customer profiles. The label used to represent each customer profile is the "thoroughfare" column of the addressfield. By altering the list of labels, a module can use additional data to represent each customer profile. Note that the list should always be keyed by customer profile id.

Parameters

$labels: An array of labels, keyed by customer profile id.

$profiles: An array of customer profile entities.

1 invocation of hook_commerce_addressbook_labels_alter()

commerce_addressbook_pane_checkout_form in ./commerce_addressbook.checkout_pane.inc

Checkout pane callback: returns a customer profile edit form.

File

./commerce_addressbook.api.php, line 24

This file contains no working PHP code; it exists to provide additional documentation for doxygen as well as to document hooks in the standard Drupal manner.

Code

function hook_commerce_addressbook_labels_alter(&$labels, $profiles) {

  // No example.
}