https://github.com/asika32764/php-sitemap
PHP Simple Sitemap Generator
https://github.com/asika32764/php-sitemap
php-sitemap sitemap sitemap-generator sitemap-php
Last synced: 6 months ago
JSON representation
PHP Simple Sitemap Generator
- Host: GitHub
- URL: https://github.com/asika32764/php-sitemap
- Owner: asika32764
- License: mit
- Created: 2015-06-07T14:39:19.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-08-08T13:33:32.000Z (10 months ago)
- Last Synced: 2024-12-10T02:20:30.180Z (6 months ago)
- Topics: php-sitemap, sitemap, sitemap-generator, sitemap-php
- Language: PHP
- Homepage: https://packagist.org/packages/asika/sitemap
- Size: 40 KB
- Stars: 19
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PHP Sitemap
PHP Simple Sitemap Generator. Follows the [W3C Sitemap Protocol](http://www.sitemaps.org/protocol.html)
* [PHP Sitemap](#php-sitemap)
* [Installation via Composer](#installation-via-composer)
* [Getting Started](#getting-started)
* [Render it to XML:](#render-it-to-xml)
* [Arguments](#arguments)
* [loc](#loc)
* [changefreq](#changefreq)
* [priority](#priority)
* [lastmod](#lastmod)
* [Google News Sitemap](#google-news-sitemap)
* [Using Sitemap index files (to group multiple sitemap files)](#using-sitemap-index-files-to-group-multiple-sitemap-files)
* [More](#more)
## Installation via Composer
```shell
composer require asika/sitemap
```
## Getting Started
Create a sitemap object:
```php
use Asika\Sitemap\Sitemap;
$sitemap = new Sitemap();
```
Add items to sitemap:
```php
$sitemap->addItem($url);
$sitemap->addItem($url);
$sitemap->addItem($url);
```
You can add some optional params.
```php
use Asika\Sitemap\ChangeFreq;
$sitemap->addItem($url, '1.0', ChangeFreq::DAILY, '2015-06-07 10:51:20');
$sitemap->addItem($url, '0.7', ChangeFreq::WEEKLY, new \DateTime('2015-06-03 11:24:20'));
```
The arguments are `loc`, `priority`, `changefreq` and `lastmod`. See this table:
| Params | Required | Description |
|--------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `loc` | required | URL of the page. This URL must begin with the protocol (such as http) and end with a trailing slash, if your web server requires it. This value must be less than 2,048 characters. |
| `priority` | optional | The priority of this URL relative to other URLs on your site. Valid values range from 0.0 to 1.0. This value does not affect how your pages are compared to pages on other sites—it only lets the search engines know which pages you deem most important for the crawlers. |
| `changefreq` | optional | How frequently the page is likely to change. This value provides general information to search engines and may not correlate exactly to how often they crawl the page. |
| `lastmod` | optional | The date of last modification of the file. This date should be in [W3C Datetime format](http://www.w3.org/TR/NOTE-datetime). This format allows you to omit the time portion, if desired, and use YYYY-MM-DD. |
See: http://www.sitemaps.org/protocol.html#xmlTagDefinitions
### Render it to XML:
```php
echo $sitemap->render();
// OR
(string) $sitemap;
```
This is an example to send it as real sitemap for Google or other search engine:
```php
header('Content-Type: application/xml');
echo $sitemap;
exit();
```
Use `output()` to instantly print header and XML body:
```php
$sitemap->output();
exit();
```
Handle Psr7 Response
```php
$response = new Response();
$response = $sitemap->handleResponse($response);
return $response;
```
The XML output in browser:
```xml
http://sitemap.io
http://sitemap.io/foo/bar/?flower=sakura&fly=bird
daily
1.0
2015-06-07T10:51:20+02:00
```
## Arguments
### loc
The URL will be auto escaped. For example, the `&`, `>` will convert to `&`, `>`.
If you want to escape it yourself, set auto escape off:
```php
$sitemap->setAutoEscape(false);
```
See: http://www.sitemaps.org/protocol.html#escaping
### changefreq
Valid values are:
```php
ChangeFreq::ALWAYS;
ChangeFreq::HOURLY;
ChangeFreq::DAILY;
ChangeFreq::WEEKLY;
ChangeFreq::MONTHLY;
ChangeFreq::YEARLY;
ChangeFreq::NEVER;
```
The value `always` should be used to describe documents that change each time they are accessed.
The value `never` should be used to describe archived URLs.
Please note that the value of this tag is considered a hint and not a command. Even though search engine crawlers may consider this information when making decisions,
they may crawl pages marked `hourly` less frequently than that, and they may crawl pages marked `yearly` more frequently than that.
Crawlers may periodically crawl pages marked `never` so that they can handle unexpected changes to those pages.
### priority
The default priority of a page is `0.5`.
Please note that the priority you assign to a page is not likely to influence the position of your URLs in a search engine's result pages. Search engines may use this information when selecting between URLs on the same site, so you can use this tag to increase the likelihood that your most important pages are present in a search index.
Also, please note that assigning a high priority to all of the URLs on your site is not likely to help you. Since the priority is relative, it is only used to select between URLs on your site.
### lastmod
Your date format will auto convert to [W3c Datetime format](http://www.w3.org/TR/NOTE-datetime). for example, if you send
a string look like: `2015-06-07 10:51:20`, Sitemap object will auto convert it to `2015-06-07T10:51:20+02:00`.
You can set the format you want:
```php
$sitemap->setDateFormat(\DateTimeInterface::ISO8601);
// OR
$sitemap->setDateFormat('Y-m-d');
```
## Google News Sitemap
Please see [Google News Sitemap](https://developers.google.com/search/docs/crawling-indexing/sitemaps/news-sitemap?visit_id=637247859078479568-4208069007&rd=3) document.
```php
$sitemap = new \Asika\Sitemap\NewsSitemap();
$sitemap->addItem(
$url,
$newsTitle,
'Publication Name',
'en-us',
$publishedDate
);
```
The format:
```xml
http://www.example.org/business/article55.html
The Example Times
en
2008-12-23
Companies A, B in Merger Talks
```
## Using Sitemap index files (to group multiple sitemap files)
```php
use Asika\Sitemap\SitemapIndex;
$index = new SitemapIndex();
$index->addItem('http://domain.com/sitemap1.xml', $lastmod1);
$index->addItem('http://domain.com/sitemap2.xml', $lastmod2);
echo $index->render();
```
Output:
```xml
http://domain.com/sitemap1.xml
2015-06-07T10:51:20+02:00
http://domain.com/sitemap2.xml
2015-06-07T10:51:20+02:00
```
See: http://www.sitemaps.org/protocol.html#index
## More
- [Extending the Sitemaps protocol](http://www.sitemaps.org/protocol.html#extending)