hook_gsitemap
Definition
hook_gsitemap($type = NULL, $excludes = array())
gsitemap/docs/gsitemap.php, line 41
Description
Define additional links to add to the site map.
This hook allows modules to add additional links to the site map. Links may be associated with nodes, terms, or users, as shown in the example.
Parameters
$type: If set, a string specifying the type of additional links to return.
- node: Links associated with nodes
- term: Links associated with terms
- user: Links associated with users
- xml: An XML site map (for including site maps from other modules)
Return value
If $type is xml, return an XML site map. Otherwise, return an array of links or an empty array. Each link should be an array with the following keys:
- nid, tid, or uid: ID to associate with this link (if $type is set)
- #loc: The URL of the page
- #lastmod: Timestamp of last modification
- #changefreq: Number of seconds between changes
- #priority: A number between 1.0 and 0.0 indicating the link's priority
Related topics
Name | Description |
|---|---|
| Hooks | Allow modules to interact with the Drupal core. |
Code
<?php
function hook_gsitemap($type = NULL, $excludes = array()) {
$additional = array();
switch ($type) {
case 'node':
// Add pages created by the node paging module.
foreach (node_get_types() as $type => $name) {
$node_types[$type] = db_escape_string($type);
}
$excludes = array_merge($excludes, array_diff($node_types, variable_get('paging_node_types_enabled', array())));
if (module_exists('comment')) {
$result = db_query("
SELECT p.pages, n.nid, n.type, n.promote, s.comment_count, n.changed, g.previously_changed, s.last_comment_timestamp, g.previous_comment, g.priority_override, u.dst AS alias
FROM {node} n
INNER JOIN {paging} p
ON n.nid = p.nid
LEFT JOIN {node_comment_statistics} s
ON n.nid = s.nid
LEFT JOIN {gsitemap} g
ON n.nid = g.nid
LEFT JOIN {url_alias} u
ON g.pid = u.pid
WHERE n.status > 0
AND (g.priority_override >= 0 OR g.priority_override IS NULL)
AND n.type NOT IN ('". implode("', '", $excludes) ."')
");
$maxcomments = db_result(db_query('SELECT MAX(comment_count) FROM {node_comment_statistics}'));
}
else {
$result = db_query("
SELECT p.pages, n.nid, n.type, n.promote, n.changed, g.previously_changed, g.priority_override, u.dst AS alias
FROM {node} n
INNER JOIN {paging} p
ON n.nid = p.nid
LEFT JOIN {gsitemap} g
ON n.nid = g.nid
LEFT JOIN {url_alias} u
ON g.pid = u.pid
WHERE n.status > 0
AND (g.priority_override >= 0 OR g.priority_override IS NULL)
AND n.type NOT IN ('". implode("', '", $excludes) ."')
");
$maxcomments = 0;
}
while ($node = db_fetch_object($result)) {
$pri = gsitemap_calc_priority($node, $maxcomments);
if ($pri < 0) {
continue;
}
$age = time() - $node->changed;
if (!empty($node->previously_changed)) {
$interval = $node->changed - $node->previously_changed;
}
else {
$interval = 0;
}
for ($count = 1; $count < $node->pages; ++ $count) {
$entry = array(
'nid' => $node->nid,
'#loc' => gsitemap_url('node/'. $node->nid, $node->alias, "page=0,$count", NULL, TRUE),
'#lastmod' => $node->changed,
'#changefreq' => max($age, $interval),
'#priority' => $pri,
);
$additional[] = $entry;
}
}
break;
case 'term':
case 'user':
break;
case 'xml':
$additional = example_sitemap();
break;
default:
// Add arbitrary additional links.
$result = db_query('SELECT g.*, u.dst AS alias FROM {gsitemap_additional} g LEFT JOIN {url_alias} u ON g.pid = u.pid');
while ($link = db_fetch_object($result)) {
$age = time() - $link->last_changed;
if (!empty($link->previously_changed)) {
$interval = $link->last_changed - $link->previously_changed;
}
else {
$interval = 0;
}
$entry = array(
'#loc' => gsitemap_url($link->path, $link->alias, NULL, NULL, TRUE),
'#lastmod' => $link->last_changed,
'#changefreq' => max($age, $interval),
'#priority' => $link->priority,
);
$additional[] = $entry;
}
}
return $additional;
}
?>