Drupal example source code file (xmlsitemap_engines.api.php)

This example Drupal source code file (xmlsitemap_engines.api.php) is included in the DevDaily.com "Drupal Source Code Warehouse" project. The intent of this project is to help you "Learn Drupal by Example".

PHP - Drupal tags/keywords

array, engines, function, hook_xmlsitemap_engine_info, hook_xmlsitemap_engine_info_alter, name, php, return, search, url

The xmlsitemap_engines.api.php Drupal example source code

<?php
// $Id: xmlsitemap_engines.api.php,v 1.2 2009/12/22 23:38:54 davereid Exp $

/**
 * @file
 * Hooks provided by the XML sitemap engines module.
 */

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

/**
 * Provide a list of supported sitemap engines.
 */
function hook_xmlsitemap_engine_info() {
  $engines['example'] = array(
    'name' => t('Example search engine'),
    'url' => 'http://example.com/ping?sitemap=[sitemap]'
  );
  return $engines;
}

/**
 * Alter the list of sitemap engines.
 */
function hook_xmlsitemap_engine_info_alter(&$engines) {
  $engines['example']['name'] = t('Kitten Search');
  $engines['example']['url'] = 'http://kittens.com/ping?sitemap=[sitemap]';
}

/**
 * @} End of "addtogroup hooks".
 */