addressfield.api.php 836 B

1234567891011121314151617181920212223242526272829
  1. <?php
  2. /**
  3. * @file
  4. * API documentation for Addressfield.
  5. */
  6. /**
  7. * Format generation callback.
  8. *
  9. * @param $format
  10. * The address format being generated.
  11. * @param $address
  12. * The address this format is generated for.
  13. * @param $context
  14. * An array of context arguments:
  15. * - 'mode': can be either 'form' or 'render'
  16. * - (optional) 'field': when generated for a field, the field
  17. * - (optional) 'instance': when generated for a field, the field instance
  18. * - (optional) 'langcode': when generated for a field, the langcode
  19. * this field is being rendered in.
  20. * - (optional) 'delta': when generated for a field, the delta of the
  21. * currently handled address.
  22. *
  23. * @ingroup addressfield_format
  24. */
  25. function CALLBACK_addressfield_format_callback(&$format, $address, $context = array()) {
  26. }