You are here

API.txt in Nodewords: D6 Meta Tags 6.3

Same filename and directory in other branches
  1. 6 API.txt
  2. 6.2 API.txt
# This file contains a log of changes to the version.

API version 2.7
* The function nodewords_load_tags() has been changed from
  nodewords_load_tags($type = NODEWORDS_TYPE_DEFAULT, $id = '') to
  nodewords_load_tags($type = NODEWORDS_TYPE_DEFAULT, $id = '', $language = '').
* The function nodewords_metatag_from_teaser() has been changed from
  nodewords_metatag_from_teaser($text, $format, $alt_attribute, $size = 0) to
  nodewords_metatag_from_teaser($text, $format, $options = array()).
* The function nodewords_output_tags() has been changed from
  nodewords_output_tags($tags) to
  nodewords_output_tags($tags, $output_type = 'head').
* The function nodewords_replace_tokens($type, $id, $content) has been added.
* The function nodewords_save_tags() has been changed from
  nodewords_save_tags($type, $id, $tags, $log_message = FALSE) to
  nodewords_save_tags($type, $id, $tags, $options = array()).

API version 2.8
* Changed the name of the constants from NODEWORDS_MT_TYPE_* to
  NODEWORDS_TYPE_*.
* The function nodewords_delete_tags() has been changed from
  nodewords_delete_tags($type, $id) to
  nodewords_delete_tags($type, $id, $options = array()).
* The function nodewords_get_tags() has been changed from
  nodewords_get_tags($type, $ids = array(''), $filtered = TRUE) to
  nodewords_get_tags($type, $id = '', $options = array()).
* The function nodewords_load_tags() has been changed from
  nodewords_load_tags($type = NODEWORDS_TYPE_DEFAULT, $id = '', $language = '')
  to
  nodewords_load_tags($type = NODEWORDS_TYPE_DEFAULT, $id = '', $options = array()).
* The function nodewords_replace_tokens() has been changed from
  nodewords_replace_tokens($type, $id, $content) to
  nodewords_replace_tokens($content, $type, $id, $sid = 0).
* The function nodewords_save_tags() has been changed from
  nodewords_save_tags($type, $id, $tags, $options = array()) to
  nodewords_save_tags($tags, $type, $id, $options = array()).
* The function nodewords_tags_form() has been changed from
  nodewords_tags_form(&$form_state, $type = NODEWORDS_TYPE_DEFAULT, $id = 0) to
  nodewords_tags_form(&$form_state, $type = NODEWORDS_TYPE_DEFAULT, $id = '', $options = array()).
* The function nodewords_unique() has been changed from
  nodewords_unique($text, $separator = ',', $max_items = -1) to
  nodewords_unique_values($text, $options =  array()).
* The identifier passed to <meta_tag_hander>_settings_form() for the meta tags
  settings form is now the form identifier as used by Drupal
  (nodewords_settings_form).
* The module uses hook_nodewords_tags_output_alter().

API version 2.9
* The function nodewords_form() uses the option 'description' that allows
  to set a description for the fieldset.
* The function nodewords_form() uses the options 'first fields', and
  'last fields' that allows to add form fields before, and after the ones used
  for the meta tags content.

API version 2.10
* The arguments for hook_nodewords_type_id() has been changed from
  hook_nodewords_type_id($arg) to
  hook_nodewords_type_id($arg, &$result).
* The function nodewords_delete_tags() has been changed from
  nodewords_delete_tags($type, $id, $options = array()) to
  nodewords_delete_tags(array $options = array()).
* The function nodewords_form() has been renamed nodewords_tags_edit_fields().
* The function nodewords_get_tags() has been removed.
* The function nodewords_load_tags() has been changed from
  nodewords_load_tags($type, $id, $options) to
  nodewords_load_tags($options).
* The function nodewords_replace_tokens() has been changed from
  nodewords_replace_tokens($content, $type, $id, $sid = 0) to
  nodewords_replace_tokens($content, array $options = array()).
* The function nodewords_save_tags() has been changed from
  nodewords_save_tags($tags, $type, $id, $options = array()) to
  nodewords_save_tags($tags, array $options = array()).
* The function nodewords_tags_form() has been renamed nodewords_tags_edit_form().
* The function nodewords_tags_form_reset() has been renamed
  nodewords_tags_edit_form_reset().
* The function nodewords_tags_form_submit() has been renamed
  nodewords_tags_edit_form_submit().
* The function nodewords_tags_edit_form() has been changed from
  nodewords_tags_edit_form(&$form_state, $type = NODEWORDS_TYPE_DEFAULT, $id = '', $options = array()) to
  nodewords_tags_edit_form(&$form_state, $options = array()).

API version 2.11
* The implementations of hook_nodewords_tags_info() use the array index
  'labels:list', instead of 'widget:label'.

API version 2.12
* Added the function nodewords_url() that returns an absolute URL basing on the
  module settings.

API version 2.13
* The arguments for hook_nodewords_type_id() has been changed from
  hook_nodewords_type_id($arg, &$result) to
  hook_nodewords_type_id(&$result, $arg).
* The function nodewords_output_tags() is now a private function.
* The parameters for the function nodewords_get_term() have been changed from
  nodewords_get_term($tid) to nodewords_get_term($tid, $account = NULL).
* Changed the function nodewords_url() from
  nodewords_url($path) to nodewords_url($path, array $options = array()).
* The value expected from hook_nodewords_tags_info() has been changed.
* New functions have been added: nodewords_check_version_api(),
  nodewords_load_include(), nodewords_load_all_includes().
* The module uses hook_nodewords_tags_info_alter(),
  hook_nodewords_delete_tags(), hook_nodewords_tag_permission_alter(), and
  hook_nodewords_default_values_alter().
* The first parameter of nodewords_tags_edit_fields() has been changed.

API version 2.14
* Changed the name of the custom hooks used by the module.

API version 2.15
* Changed the arguments of hook_metatags_permission_alter() to
  hook_metatags_permission_alter($permission, $object, $tag_name, $tag_info).

API version 2.16
* Corrected an array index name of the array returned by hook_metatags_api().
* Renamed _nodewords_detect_type_id() as
  nodewords_detect_type_id().
* Added the function nodewords_add_tokens_help(&$form, $type).

File

API.txt
View source
  1. # This file contains a log of changes to the version.
  2. API version 2.7
  3. * The function nodewords_load_tags() has been changed from
  4. nodewords_load_tags($type = NODEWORDS_TYPE_DEFAULT, $id = '') to
  5. nodewords_load_tags($type = NODEWORDS_TYPE_DEFAULT, $id = '', $language = '').
  6. * The function nodewords_metatag_from_teaser() has been changed from
  7. nodewords_metatag_from_teaser($text, $format, $alt_attribute, $size = 0) to
  8. nodewords_metatag_from_teaser($text, $format, $options = array()).
  9. * The function nodewords_output_tags() has been changed from
  10. nodewords_output_tags($tags) to
  11. nodewords_output_tags($tags, $output_type = 'head').
  12. * The function nodewords_replace_tokens($type, $id, $content) has been added.
  13. * The function nodewords_save_tags() has been changed from
  14. nodewords_save_tags($type, $id, $tags, $log_message = FALSE) to
  15. nodewords_save_tags($type, $id, $tags, $options = array()).
  16. API version 2.8
  17. * Changed the name of the constants from NODEWORDS_MT_TYPE_* to
  18. NODEWORDS_TYPE_*.
  19. * The function nodewords_delete_tags() has been changed from
  20. nodewords_delete_tags($type, $id) to
  21. nodewords_delete_tags($type, $id, $options = array()).
  22. * The function nodewords_get_tags() has been changed from
  23. nodewords_get_tags($type, $ids = array(''), $filtered = TRUE) to
  24. nodewords_get_tags($type, $id = '', $options = array()).
  25. * The function nodewords_load_tags() has been changed from
  26. nodewords_load_tags($type = NODEWORDS_TYPE_DEFAULT, $id = '', $language = '')
  27. to
  28. nodewords_load_tags($type = NODEWORDS_TYPE_DEFAULT, $id = '', $options = array()).
  29. * The function nodewords_replace_tokens() has been changed from
  30. nodewords_replace_tokens($type, $id, $content) to
  31. nodewords_replace_tokens($content, $type, $id, $sid = 0).
  32. * The function nodewords_save_tags() has been changed from
  33. nodewords_save_tags($type, $id, $tags, $options = array()) to
  34. nodewords_save_tags($tags, $type, $id, $options = array()).
  35. * The function nodewords_tags_form() has been changed from
  36. nodewords_tags_form(&$form_state, $type = NODEWORDS_TYPE_DEFAULT, $id = 0) to
  37. nodewords_tags_form(&$form_state, $type = NODEWORDS_TYPE_DEFAULT, $id = '', $options = array()).
  38. * The function nodewords_unique() has been changed from
  39. nodewords_unique($text, $separator = ',', $max_items = -1) to
  40. nodewords_unique_values($text, $options = array()).
  41. * The identifier passed to _settings_form() for the meta tags
  42. settings form is now the form identifier as used by Drupal
  43. (nodewords_settings_form).
  44. * The module uses hook_nodewords_tags_output_alter().
  45. API version 2.9
  46. * The function nodewords_form() uses the option 'description' that allows
  47. to set a description for the fieldset.
  48. * The function nodewords_form() uses the options 'first fields', and
  49. 'last fields' that allows to add form fields before, and after the ones used
  50. for the meta tags content.
  51. API version 2.10
  52. * The arguments for hook_nodewords_type_id() has been changed from
  53. hook_nodewords_type_id($arg) to
  54. hook_nodewords_type_id($arg, &$result).
  55. * The function nodewords_delete_tags() has been changed from
  56. nodewords_delete_tags($type, $id, $options = array()) to
  57. nodewords_delete_tags(array $options = array()).
  58. * The function nodewords_form() has been renamed nodewords_tags_edit_fields().
  59. * The function nodewords_get_tags() has been removed.
  60. * The function nodewords_load_tags() has been changed from
  61. nodewords_load_tags($type, $id, $options) to
  62. nodewords_load_tags($options).
  63. * The function nodewords_replace_tokens() has been changed from
  64. nodewords_replace_tokens($content, $type, $id, $sid = 0) to
  65. nodewords_replace_tokens($content, array $options = array()).
  66. * The function nodewords_save_tags() has been changed from
  67. nodewords_save_tags($tags, $type, $id, $options = array()) to
  68. nodewords_save_tags($tags, array $options = array()).
  69. * The function nodewords_tags_form() has been renamed nodewords_tags_edit_form().
  70. * The function nodewords_tags_form_reset() has been renamed
  71. nodewords_tags_edit_form_reset().
  72. * The function nodewords_tags_form_submit() has been renamed
  73. nodewords_tags_edit_form_submit().
  74. * The function nodewords_tags_edit_form() has been changed from
  75. nodewords_tags_edit_form(&$form_state, $type = NODEWORDS_TYPE_DEFAULT, $id = '', $options = array()) to
  76. nodewords_tags_edit_form(&$form_state, $options = array()).
  77. API version 2.11
  78. * The implementations of hook_nodewords_tags_info() use the array index
  79. 'labels:list', instead of 'widget:label'.
  80. API version 2.12
  81. * Added the function nodewords_url() that returns an absolute URL basing on the
  82. module settings.
  83. API version 2.13
  84. * The arguments for hook_nodewords_type_id() has been changed from
  85. hook_nodewords_type_id($arg, &$result) to
  86. hook_nodewords_type_id(&$result, $arg).
  87. * The function nodewords_output_tags() is now a private function.
  88. * The parameters for the function nodewords_get_term() have been changed from
  89. nodewords_get_term($tid) to nodewords_get_term($tid, $account = NULL).
  90. * Changed the function nodewords_url() from
  91. nodewords_url($path) to nodewords_url($path, array $options = array()).
  92. * The value expected from hook_nodewords_tags_info() has been changed.
  93. * New functions have been added: nodewords_check_version_api(),
  94. nodewords_load_include(), nodewords_load_all_includes().
  95. * The module uses hook_nodewords_tags_info_alter(),
  96. hook_nodewords_delete_tags(), hook_nodewords_tag_permission_alter(), and
  97. hook_nodewords_default_values_alter().
  98. * The first parameter of nodewords_tags_edit_fields() has been changed.
  99. API version 2.14
  100. * Changed the name of the custom hooks used by the module.
  101. API version 2.15
  102. * Changed the arguments of hook_metatags_permission_alter() to
  103. hook_metatags_permission_alter($permission, $object, $tag_name, $tag_info).
  104. API version 2.16
  105. * Corrected an array index name of the array returned by hook_metatags_api().
  106. * Renamed _nodewords_detect_type_id() as
  107. nodewords_detect_type_id().
  108. * Added the function nodewords_add_tokens_help(&$form, $type).