metatag.tokens.inc 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  1. <?php
  2. /**
  3. * @file
  4. * Custom tokens for Metatag.
  5. */
  6. /**
  7. * Implements hook_token_info().
  8. */
  9. function metatag_token_info() {
  10. $info = array();
  11. $info['types']['metatag'] = array(
  12. 'name' => t('Meta tags'),
  13. 'description' => t('Generated by the Metatag module, may not be used to fill in other meta tags.'),
  14. );
  15. $metatag_info = metatag_get_info();
  16. foreach($metatag_info['tags'] as $value) {
  17. $info['tokens']['metatag'][$value['name']] = array(
  18. 'name' => $value['label'],
  19. 'description' => $value['description']
  20. );
  21. }
  22. if (module_exists('taxonomy')) {
  23. $info['tokens']['term']['metatag'] = array(
  24. 'name' => t('Metatag.'),
  25. 'description' => t('Metatag.'),
  26. 'type' => 'metatag'
  27. );
  28. }
  29. if (module_exists('node')) {
  30. $info['tokens']['node']['metatag'] = array(
  31. 'name' => t('Metatag.'),
  32. 'description' => t('Metatag.'),
  33. 'type' => 'metatag'
  34. );
  35. }
  36. return $info;
  37. }
  38. /**
  39. * Implements hook_tokens().
  40. */
  41. function metatag_tokens($type, $tokens, array $data = array(), array $options = array()) {
  42. $replacements = array();
  43. $sanitize = !empty($options['sanitize']);
  44. // Metatag tokens.
  45. if ($type == 'metatag' && !empty($data['metatag'])) {
  46. $metatag = $data['metatag'];
  47. foreach ($tokens as $name => $original) {
  48. if(isset($metatag[$name])){
  49. $replacements[$original] = $sanitize ? filter_xss($metatag[$name]) : $metatag[$name];
  50. }
  51. }
  52. }
  53. // Token tokens.
  54. if ($type == 'term' && !empty($data['term'])) {
  55. $term = $data['term'];
  56. if ($metatag_tokens = token_find_with_prefix($tokens, 'metatag')) {
  57. $result = metatag_token_generate_array($term, 'taxonomy_term', $term->vocabulary_machine_name);
  58. $replacements += token_generate('metatag', $metatag_tokens, array('metatag' => $result), $options);
  59. }
  60. }
  61. // Node tokens.
  62. if ($type == 'node' && !empty($data['node'])) {
  63. $node = $data['node'];
  64. if ($metatag_tokens = token_find_with_prefix($tokens, 'metatag')) {
  65. $result = metatag_token_generate_array($node, 'node', $node->type);
  66. $replacements += token_generate('metatag', $metatag_tokens, array('metatag' => $result), $options);
  67. }
  68. }
  69. return $replacements;
  70. }
  71. /**
  72. * Generate an array of meta tags for a given entity.
  73. */
  74. function metatag_token_generate_array($entity, $entity_type, $bundle) {
  75. if (metatag_entity_supports_metatags($entity_type, $bundle)) {
  76. $token_type = token_get_entity_mapping('entity', $entity_type);
  77. $instance = "{$entity_type}:{$bundle}";
  78. $options = array();
  79. $options['token data'][$token_type] = $entity;
  80. $options['entity'] = $entity;
  81. $metatags = array();
  82. if (!empty($entity->metatags)) {
  83. $language = metatag_entity_get_language($entity_type, $entity);
  84. if (!empty($entity->metatags[$language])) {
  85. $metatags = $entity->metatags[$language];
  86. }
  87. }
  88. $metatags += metatag_config_load_with_defaults($instance);
  89. // Process it for entity metatag replacement to avoid infinite recursion.
  90. $metatags = _metatag_token_process_metatag($metatags, $token_type);
  91. $result = array();
  92. foreach ($metatags as $metatag => $data) {
  93. if ($metatag_instance = metatag_get_instance($metatag, $data)) {
  94. $result[$metatag] = $metatag_instance->getValue($options);
  95. }
  96. }
  97. return $result;
  98. }
  99. return NULL;
  100. }
  101. /**
  102. * Loop through metatags to avoid recursion on entity tokens. It will replace
  103. * entity metatag token to its actual entity metatag field value.
  104. *
  105. * @param array $metatags
  106. * An array of entity metatag tokens.
  107. * @param string $token_type
  108. * The entity token type, such as 'node' or 'term'.
  109. *
  110. * @return array
  111. * Return metatags array with entity metatag tokens replaced.
  112. */
  113. function _metatag_token_process_metatag($metatags, $token_type) {
  114. foreach ($metatags as $metatag => $data) {
  115. // Explode all metatag token in field.
  116. $data_tokens = token_scan($data['value']);
  117. if (isset($data_tokens[$token_type])) {
  118. foreach($data_tokens[$token_type] as $key => $value) {
  119. $metatag_parts = explode(':', $key);
  120. // Check entity metatag token. Like [<entity_token_type>:metatag:<xyz>].
  121. if ($metatag_parts[0] == 'metatag') {
  122. $entity_field = implode(':', array_slice($metatag_parts, 1));
  123. // Entity metatag field may contain other entity metatag token
  124. // that need to be replaced too.
  125. $replaced_value = metatag_token_entitymetatagtoken_replace($metatags, $metatags[$entity_field]['value'], $token_type);
  126. $metatags[$metatag]['value'] = str_replace($value, $replaced_value, $metatags[$metatag]['value']);
  127. }
  128. }
  129. }
  130. }
  131. return $metatags;
  132. }
  133. /**
  134. * Replace entity metatag token with actual entity metatag field value.
  135. *
  136. * @param array $metatags
  137. * An array entity metatag tokens.
  138. * @param string $token
  139. * A token to be replaced.
  140. * @param string $token_type
  141. * The entity token type, such as 'node' or 'term'.
  142. * @param array $search_tokens
  143. * An array of tokens to search for.
  144. * @param array $replace_tokens
  145. * An array of tokens to be replaced.
  146. *
  147. * @return string
  148. * The replaced value of $token.
  149. */
  150. function metatag_token_entitymetatagtoken_replace($metatags, $token, $token_type, $search_tokens = array(), $replace_tokens = array()) {
  151. $data_tokens = token_scan($token);
  152. // Check field has tokens.
  153. if (isset($data_tokens[$token_type])) {
  154. // Go through each token in field and find entity metatag tokens.
  155. foreach($data_tokens[$token_type] as $key => $value) {
  156. $metatag_parts = explode(':', $key);
  157. if ($metatag_parts[0] == 'metatag' && !in_array($value, $search_tokens)) {
  158. // Entity metatag field value.
  159. $entity_field = implode(':', array_slice($metatag_parts, 1));
  160. $replaced_value = metatag_token_entitymetatagtoken_replace($metatags, $metatags[$entity_field]['value'], $token_type, $replace_tokens, $search_tokens);
  161. $replace_tokens[] = $replaced_value;
  162. $search_tokens[] = $value;
  163. }
  164. }
  165. return str_replace($search_tokens, $replace_tokens, $token);
  166. }
  167. else {
  168. return $token;
  169. }
  170. }