simple_sitemap.api.php 3.45 KB
Newer Older
1
<?php
Pawel G's avatar
Pawel G committed
2

3 4
/**
 * @file
5
 * Hooks provided by the Simple XML Sitemap module.
6 7 8 9 10 11 12 13 14 15 16 17
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * Alter the generated link data before the sitemap is saved.
 * This hook gets invoked for every sitemap chunk generated.
 *
 * @param array &$links
18 19
 *   Array containing multilingual links generated for each path to be indexed
 *
Pawel G's avatar
Pawel G committed
20
 * @param string $sitemap_variant
21
 */
22
function hook_simple_sitemap_links_alter(array &$links, $sitemap_variant) {
23 24

  // Remove German URL for a certain path in the hreflang sitemap.
25
  foreach ($links as $key => $link) {
26
    if ($link['meta']['path'] === 'node/1') {
Pawel G's avatar
Pawel G committed
27

28
      // Remove 'loc' URL if it points to a german site.
29
      if ($link['langcode'] === 'de') {
30
        unset($links[$key]);
31
      }
Pawel G's avatar
Pawel G committed
32

33 34 35
      // If this 'loc' URL points to a non-german site, make sure to remove
      // its german alternate URL.
      else {
Pawel G's avatar
Pawel G committed
36
        unset($links[$key]['alternate_urls']['de']);
37 38
      }
    }
39 40 41
  }
}

42
/**
Pawel G's avatar
Pawel G committed
43
 * Add arbitrary links to the sitemap.
44 45
 *
 * @param array &$arbitrary_links
Pawel G's avatar
Pawel G committed
46
 * @param string $sitemap_variant
47
 */
48
function hook_simple_sitemap_arbitrary_links_alter(array &$arbitrary_links, $sitemap_variant) {
49

50
  // Add an arbitrary link to all sitemap variants.
51
  $arbitrary_links[] = [
52
    'url' => 'http://some-arbitrary-link/',
53
    'priority' => '0.5',
Pawel G's avatar
Pawel G committed
54 55

    // An ISO8601 formatted date.
56
    'lastmod' => '2012-10-12T17:40:30+02:00',
Pawel G's avatar
Pawel G committed
57

58
    'changefreq' => 'weekly',
Pawel G's avatar
Pawel G committed
59
    'images' => [
Pawel G's avatar
Pawel G committed
60
      ['path' => 'http://path-to-image.png']
Pawel G's avatar
Pawel G committed
61 62 63 64 65 66 67
    ],

    // Add alternate URLs for every language of a multilingual site.
    // Not necessary for monolingual sites.
    'alternate_urls' => [
      'en' => 'http://this-is-your-life.net/de/tyler',
      'de' => 'http://this-is-your-life.net/en/tyler',
Pawel G's avatar
Pawel G committed
68
    ]
69
  ];
70 71 72 73 74 75 76 77 78

  // Add an arbitrary link to the 'fight_club' sitemap variant only.
  switch ($sitemap_variant) {
    case 'fight_club':
      $arbitrary_links[] = [
        'url' => 'http://this-is-your-life.net/tyler',
      ];
      break;
  }
79 80 81 82 83 84 85
}

/**
 * Alters the sitemap attributes shortly before XML document generation.
 * Attributes can be added, changed and removed.
 *
 * @param array &$attributes
Pawel G's avatar
Pawel G committed
86
 * @param string $sitemap_variant
87
 */
88
function hook_simple_sitemap_attributes_alter(array &$attributes, $sitemap_variant) {
89 90 91 92 93 94

  // Remove the xhtml attribute e.g. if no xhtml sitemap elements are present.
  unset($attributes['xmlns:xhtml']);
}

/**
Pawel G's avatar
Pawel G committed
95
 * Alters attributes of the sitemap index shortly before XML document generation.
96 97 98
 * Attributes can be added, changed and removed.
 *
 * @param array &$index_attributes
Pawel G's avatar
Pawel G committed
99
 * @param string $sitemap_variant
100
 */
101
function hook_simple_sitemap_index_attributes_alter(array &$index_attributes, $sitemap_variant) {
102 103 104 105 106

  // Add some attribute to the sitemap index.
  $index_attributes['name'] = 'value';
}

Pawel G's avatar
Pawel G committed
107
/**
Pawel G's avatar
Pawel G committed
108
 * Alter properties of and remove URL generator plugins.
Pawel G's avatar
Pawel G committed
109
 *
110
 * @param array $url_generators
Pawel G's avatar
Pawel G committed
111
 */
112
function hook_simple_sitemap_url_generators_alter(array &$url_generators) {
Pawel G's avatar
Pawel G committed
113

Pawel G's avatar
Pawel G committed
114
  // Remove the entity generator.
115 116 117 118
  unset($url_generators['entity']);
}

/**
Pawel G's avatar
Pawel G committed
119
 * Alter properties of and remove sitemap generator plugins.
120 121 122 123 124 125 126 127 128 129
 *
 * @param array $sitemap_generators
 */
function hook_simple_sitemap_sitemap_generators_alter(array &$sitemap_generators) {

  // Remove the default generator.
  unset($sitemap_generators['default']);
}

/**
130 131
 * Alter properties of and remove sitemap type plugins.
 *
132 133
 * @param array $sitemap_types
 */
134 135
function hook_simple_sitemap_sitemap_types_alter(array &$sitemap_types) {

136 137
}

138 139 140
/**
 * @} End of "addtogroup hooks".
 */