/wp-content/plugins/wordpress-seo/inc/sitemaps/interface-sitemap-provider.php

https://bitbucket.org/carloskikea/helpet · PHP · 41 lines · 6 code · 4 blank · 31 comment · 0 complexity · c604532f09b4230695f1afb357b8c224 MD5 · raw file

  1. <?php
  2. /**
  3. * WPSEO plugin file.
  4. *
  5. * @package WPSEO\XML_Sitemaps
  6. */
  7. /**
  8. * Sitemap Provider interface
  9. */
  10. interface WPSEO_Sitemap_Provider {
  11. /**
  12. * Check if provider supports given item type.
  13. *
  14. * @param string $type Type string to check for.
  15. *
  16. * @return boolean
  17. */
  18. public function handles_type( $type );
  19. /**
  20. * Get set of sitemaps index link data.
  21. *
  22. * @param int $max_entries Entries per sitemap.
  23. *
  24. * @return array
  25. */
  26. public function get_index_links( $max_entries );
  27. /**
  28. * Get set of sitemap link data.
  29. *
  30. * @param string $type Sitemap type.
  31. * @param int $max_entries Entries per sitemap.
  32. * @param int $current_page Current page of the sitemap.
  33. *
  34. * @return array
  35. */
  36. public function get_sitemap_links( $type, $max_entries, $current_page );
  37. }