Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/melbahja/seo
🐘 Simple PHP library to help developers 🍻 do better on-page SEO optimization 🤖
https://github.com/melbahja/seo
hacktoberfest metatags php php71 php8 php80 php81 schema-org search-engine-optimization seo seo-meta seo-metadata seo-optimization seo-tools seotools sitemap sitemap-builder sitemap-generator sitemap-xml
Last synced: 2 days ago
JSON representation
🐘 Simple PHP library to help developers 🍻 do better on-page SEO optimization 🤖
- Host: GitHub
- URL: https://github.com/melbahja/seo
- Owner: melbahja
- License: mit
- Created: 2019-03-02T13:18:29.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-11T11:22:38.000Z (over 2 years ago)
- Last Synced: 2025-01-13T02:04:06.438Z (9 days ago)
- Topics: hacktoberfest, metatags, php, php71, php8, php80, php81, schema-org, search-engine-optimization, seo, seo-meta, seo-metadata, seo-optimization, seo-tools, seotools, sitemap, sitemap-builder, sitemap-generator, sitemap-xml
- Language: PHP
- Homepage: https://git.io/phpseo
- Size: 67.4 KB
- Stars: 320
- Watchers: 8
- Forks: 50
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP SEO
[](https://github.com/melbahja/seo/actions?query=workflow%3ATest) [](https://github.com/melbahja/seo/blob/master/LICENSE)   [](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fmelbahja%2Fseo)
Simple PHP library to help developers 🍻 do better on-page SEO optimization
### PHP SEO features:
- [[👷]](#-generate-schemaorg) **Generate schema.org ld+json**
- [[🛀]](#-meta-tags) **Generate meta tags with twitter and open graph support**
- [[🌐]](#-sitemaps) **Generate sitemaps xml and indexes (supports: 🖺 news, 🖼 images, 📽 videos)**
- [[📤]](#-send-sitemaps-to-search-engines) **Submit new sitemaps to search engines**
- [[📤]](#-indexing-api) **Indexing API**
- [[🙈]](https://github.com/melbahja/seo/blob/master/composer.json) **No dependencies**
## Installation:
```bash
composer require melbahja/seo
```
## Usage:
Check this simple examples. (of course the composer autoload.php file is required)
#### 👷 Generate schema.org
```php
use Melbahja\Seo\Schema;
use Melbahja\Seo\Schema\Thing;
$schema = new Schema(
new Thing('Organization', [
'url' => 'https://example.com',
'logo' => 'https://example.com/logo.png',
'contactPoint' => new Thing('ContactPoint', [
'telephone' => '+1-000-555-1212',
'contactType' => 'customer service'
])
])
);
echo $schema;
```
**Results:** (formatted)
```html
{
"@context": "https://schema.org",
"@graph": [
{
"url": "https://example.com",
"logo": "https://example.com/logo.png",
"contactPoint": {
"telephone": "+1-000-555-1212",
"contactType": "customer service",
"@type": "ContactPoint",
"@context": "https://schema.org/"
},
"@type": "Organization",
"@context": "https://schema.org/"
}
]
}
```
```php
use Melbahja\Seo\Schema;
use Melbahja\Seo\Schema\Thing;
$product = new Thing('Product');
$product->name = "Foo Bar";
$product->sku = "sk12";
$product->image = "/image.jpeg";
$product->description = "testing";
$product->offers = new Thing('Offer', [
'availability' => 'https://schema.org/InStock',
'priceCurrency' => 'USD',
"price" => "119.99",
'url' => 'https://gool.com',
]);
$webpage = new Thing("WebPage", [
'@id' => "https://example.com/product/#webpage",
'url' => "https://example.com/product",
'name' => 'Foo Bar',
]);
$schema = new Schema(
$product,
$webpage,
);
echo json_encode($schema, JSON_PRETTY_PRINT);
```
**Results:**
```json
{
"@context": "https://schema.org",
"@graph": [
{
"name": "Foo Bar",
"sku": "sk12",
"image": "/image.jpeg",
"description": "testing",
"offers": {
"availability": "https://schema.org/InStock",
"priceCurrency": "USD",
"price": "119.99",
"url": "https://gool.com",
"@type": "Offer",
"@context": "https://schema.org/"
},
"@type": "Product",
"@context": "https://schema.org/"
},
{
"@id": "https://example.com/product/#webpage",
"url": "https://example.com/product",
"name": "Foo Bar",
"@type": "WebPage",
"@context": "https://schema.org/"
}
]
}
```
#### 🛀 Meta Tags
```php
use Melbahja\Seo\MetaTags;
$metatags = new MetaTags();
$metatags
->title('PHP SEO')
->description('This is my description')
->meta('author', 'Mohamed Elabhja')
->image('https://avatars3.githubusercontent.com/u/8259014')
->mobile('https://m.example.com')
->canonical('https://example.com')
->shortlink('https://git.io/phpseo')
->amp('https://apm.example.com');
echo $metatags;
```
**Results:**
```html
PHP SEO
```
#### 🗺 Sitemaps
```php
$yourmap = new Sitemap(string $url, array $options = []): SitemapIndexInterface
```
| Option name | Description | Required ? | Default |
| ------------- | ------------- | --------- | -------- |
| save_path | Generated sitemaps storage path | YES | |
| sitemaps_url | Sitemap index custom url for generated sitemaps | NO | $url |
| index_name | Custom sitemap index name | NO | sitemap.xml |
##### Simple Example
```php
use Melbahja\Seo\Sitemap;
$sitemap = new Sitemap('https://example.com', ['save_path' => '/path/to_save/files']);
$sitemap->links('blog.xml', function($map)
{
$map->loc('/blog')->freq('daily')->priority('0.8')
->loc('/blog/my-new-article')->freq('weekly')->lastMod('2019-03-01')
->loc('/اهلا-بالعالم')->freq('weekly');
$map->loc('/blog/hello')->freq('monthly');
});
// return bool
// throws SitemapException if save_path options not exists
$sitemap->save();
```
**Results:** (📂 in: /path/to_save/files/)
📁: sitemap.xml (formatted)
```xml
https://example.com/blog.xml
2019-03-01T14:38:02+01:00
```
📁: blog.xml (formatted)
```xml
https://example.com/blog
daily
0.8
https://example.com/blog/my-new-article
weekly
2019-03-01T00:00:00+01:00
https://example.com/%D8%A7%D9%87%D9%84%D8%A7-%D8%A8%D8%A7%D9%84%D8%B9%D8%A7%D9%84%D9%85
weekly
https://example.com/blog/hello
monthly
```
##### Multipe Sitemaps && Images
```php
use Melbahja\Seo\Sitemap;
$sitemap = new Sitemap('https://example.com');
// Instead of passing save_path to the factory you can set it later via setSavePath
// also $sitemap->getSavePath() method to get the current save_path
$sitemap->setSavePath('your_save/path');
// changing sitemap index name
$sitemap->setIndexName('index.xml');
// For images you need to pass a option images => true
$sitemap->links(['name' => 'blog.xml', 'images' => true], function($map)
{
$map->loc('/blog')->freq('daily')->priority('0.8')
->loc('/blog/my-new-article')
->freq('weekly')
->lastMod('2019-03-01')
->image('/uploads/image.jpeg', ['caption' => 'My caption'])
->loc('/اهلا-بالعالم')->freq('weekly');
// image(string $url, array $options = []), image options: caption, geo_location, title, license
// see References -> images
$map->loc('/blog/hello')->freq('monthly')->image('https://cdn.example.com/image.jpeg');
});
// another file
$sitemap->links('blog_2.xml', function($map)
{
// Mabye you need to loop through posts form your database ?
foreach (range(0, 4) as $i)
{
$map->loc("/posts/{$i}")->freq('weekly')->priority('0.7');
}
});
$sitemap->save();
```
**Results**
📁: index.xml
```xml
https://example.com/blog.xml
2019-03-01T15:13:22+01:00
https://example.com/blog_2.xml
2019-03-01T15:13:22+01:00
```
📁: blog.xml
```xml
https://example.com/blog
daily
0.8
https://example.com/blog/my-new-article
weekly
2019-03-01T00:00:00+01:00
My caption
https://example.com/uploads/image.jpeg
https://example.com/%D8%A7%D9%87%D9%84%D8%A7-%D8%A8%D8%A7%D9%84%D8%B9%D8%A7%D9%84%D9%85
weekly
https://example.com/blog/hello
monthly
https://cdn.example.com/image.jpeg
```
📁: blog_2.xml
```xml
https://example.com/posts/0
weekly
0.7
https://example.com/posts/1
weekly
0.7
https://example.com/posts/2
weekly
0.7
https://example.com/posts/3
weekly
0.7
https://example.com/posts/4
weekly
0.7
```
##### Sitemap with videos
```php
$sitemap = (new Sitemap('https://example.com'))
->setSavePath('./storage/sitemaps')
->setSitemapsUrl('https://example.com/sitemaps')
->setIndexName('index.xml');
$sitemap->links(['name' => 'posts.xml', 'videos' => true], function($map)
{
$map->loc('/posts/clickbait-video')->video('My Clickbait Video title',
[
// or thumbnail_loc
'thumbnail' => 'https://example.com/thumbnail.jpeg',
'description' => 'My description',
// player_loc or content_loc one of them is required
'player_loc' => 'https://example.com/embed/81287127'
// for all available options see References -> videos
]);
$map->loc('posts/bla-bla');
});
$sitemap->save();
```
**Results**
📁: index.xml
```xml
https://example.com/sitemaps/posts.xml
2019-03-01T15:30:02+01:00
```
**Note:** lastmod in sitemap index files are generated automatically
📁: posts.xml
```xml
https://example.com/posts/clickbait-video
My description
https://example.com/embed/81287127
My Clickbait Video title
https://example.com/thumbnail.jpeg
https://example.com/posts/bla-bla
```
##### News Sitemaps
```php
use Melbahja\Seo\Factory;
$sitemap = Factory::sitemap('https://example.com',
[
// You can also customize your options by passing array to the factory like this
'save_path' => './path',
'sitemaps_url' => 'https://example.com/maps',
'index_name' => 'news_index.xml'
]);
$sitemap->news('my_news.xml', function($map)
{
// publication: name, language
// Google quote about the name: "It must exactly match the name as
// it appears on your articles on news.google.com"
$map->setPublication('PHP NEWS', 'en');
$map->loc('/news/12')->news(
[
'title' => 'PHP 8 Released',
'publication_date' => '2019-03-01T15:30:02+01:00',
]);
$map->loc('/news/13')->news(
[
'title' => 'PHP 8 And High Performance',
'publication_date' => '2019-04-01T15:30:02+01:00'
]);
});
$sitemap->save();
```
**Results**
📁: news_index.xml
```xml
https://example.com/maps/my_news.xml
2019-03-01T15:57:10+01:00
```
📁: my_news.xml
```xml
https://example.com/news/12
PHP NEWS
en
PHP 8 Released
2019-03-01T15:30:02+01:00
https://example.com/news/13
PHP NEWS
en
PHP 8 And High Performance
2019-04-01T15:30:02+01:00
```
**Google quote:** ⚠ "If you submit your News sitemap before your site has been reviewed and approved by our team, you may receive errors." ⚠
#### 🤖 Send Sitemaps To Search Engines
According to the sitemaps protocol, search engines should have a url that allow you to inform them about your new sitemap files. like: /ping?sitemap=sitemap_url
```php
use Melbahja\Seo\Ping;
$ping = new Ping;
// the void method send() will inform via CURL: google, bing and yandex about your new file
$ping->send('https://example.com/sitemap_file.xml');
```
### Indexing API
This is the first PHP library to support the new search engines indexing API (aka indexnow.org).
```php
use Melbahja\Seo\Indexing;
$indexer = new Indexing('www.example.cpm', [
'bing.com' => 'your_api_key_here',
'yandex.com' => 'your_api_key_here',
]);
// index single url.
$indexer->indexUrl('https://www.example.com/page');
// index multi urls.
$indexer->indexUrls(['https://www.example.com/page']);
```
## Sponsors
Special thanks to friends who support this work financially:
[](https://www.evoludata.com)
## References
- [Sitemaps protocol (https://www.sitemaps.org/protocol.html)](https://www.sitemaps.org/protocol.html)
- [Build Sitemaps (https://support.google.com/webmasters/answer/183668?hl=en)](https://support.google.com/webmasters/answer/183668?hl=en)
- [News Sitemaps (https://support.google.com/webmasters/answer/74288)](https://support.google.com/webmasters/answer/74288)
- [Image Sitemaps (https://support.google.com/webmasters/answer/178636)](https://support.google.com/webmasters/answer/178636)
- [Video Sitemaps (https://support.google.com/webmasters/answer/80471)](https://support.google.com/webmasters/answer/80471)
- [Mobile (https://developers.google.com/search/mobile-sites/mobile-seo/other-devices)](https://developers.google.com/search/mobile-sites/mobile-seo/other-devices)
## License
[MIT](https://github.com/melbahja/seo/blob/master/LICENSE) Copyright (c) 2019-present Mohamed Elbahja