You are here

Home » API reference » Custom Formatters 6

DEVELOPERS.txt in Custom Formatters 6 

Custom Formatters
--------------------------------------------------------------------------------

Custom Formatters provides two API hooks to help developers improve support for
their defined CCK fields with Custom Formatters,
hook_custom_formatters_field_prepare() and hook_custom_formatters_field_tokens()
and a third hook to provide your own modules default custom formatters,
hook_custom_formatters_defaults().

These hooks are completely optional and further information on their use can be
found in custom_formatters.api.php.


Devel Generate and Token
--------------------------------------------------------------------------------

Two of the core features of Custom Formatters rely on support for external
contrib APIs, the 'Preview' feature utilizing the Devel Generate modules
hook_content_generate() to provide a temporary CCK field for use in the preview
and 'Simple Editor' mode utilizing tokens provided by the Token modules
hook_token_list() and hook_token_values().

It is highly recommended that a module wishing to support Custom Formatters
makes use of these external APIs.

More information regarding these hooks can be found at:

* Devel Generate - No documentation available (recommend looking at examples in
                   CCK: includes/content.devel.inc).
* Token          - http://drupal.org/node/307140

File

DEVELOPERS.txt
View source 
  1. Custom Formatters

  2. --------------------------------------------------------------------------------

  3. 

  4. Custom Formatters provides two API hooks to help developers improve support for

  5. their defined CCK fields with Custom Formatters,

  6. hook_custom_formatters_field_prepare() and hook_custom_formatters_field_tokens()

  7. and a third hook to provide your own modules default custom formatters,

  8. hook_custom_formatters_defaults().

  9. 

  10. These hooks are completely optional and further information on their use can be

  11. found in custom_formatters.api.php.

  12. 

  13. 

  14. Devel Generate and Token

  15. --------------------------------------------------------------------------------

  16. 

  17. Two of the core features of Custom Formatters rely on support for external

  18. contrib APIs, the 'Preview' feature utilizing the Devel Generate modules

  19. hook_content_generate() to provide a temporary CCK field for use in the preview

  20. and 'Simple Editor' mode utilizing tokens provided by the Token modules

  21. hook_token_list() and hook_token_values().

  22. 

  23. It is highly recommended that a module wishing to support Custom Formatters

  24. makes use of these external APIs.

  25. 

  26. More information regarding these hooks can be found at:

  27. 

  28. * Devel Generate - No documentation available (recommend looking at examples in

  29.                    CCK: includes/content.devel.inc).

  30. * Token          - http://drupal.org/node/307140