Never worry about SEO in Laravel again!
Currently there aren't that many SEO-packages for Laravel and the available ones are quite complex to set up and very decoupled from the database. They only provided you with helpers to generate the tags, but you still had to use those helpers: nothing was generated automatically and they almost do not work out of the box.
This package generates valid and useful meta tags straight out-of-the-box, with limited initial configuration, whilst still providing a simple, but powerful API to work with. It can generate:
- Robots tag
- Title tag (with sitewide suffix)
- Meta tags (author, description, image, etc.)
- OpenGraph Tags (Facebook, LinkedIn, etc.)
- Twitter Tags
- Structured data (Article and Breadcrumbs)
- Favicon
If you're familiar with Spatie's media-library package, this package works in almost the same way, only then for SEO. I'm sure it will be very helpful for you, as it's usually best to SEO attention right from the beginning.
Here are a few examples of what you can do:
$post = Post::find(1);
$post->addSEO();
$post->seo->update([
'title' => 'My great post',
'description' => 'This great post will enhance your live.',
]);
It will render the SEO tags directly on your page:
<!DOCTYPE html>
<html>
<head>
{!! seo()->for($page) !!}
{{-- No need to separately render a <title> tag or any other meta tags! --}}
</head>
It even allows you to dynamically retrieve SEO data from your model, without having to save it manually to the SEO model. The below code will require zero additional work from you or from your users:
class Post extends Model
{
use HasSEO;
public function getDynamicSEOData(): SEOData
{
// Override only the properties you want:
return new SEOData(
title: $this->title,
description: $this->excerpt,
image: $this->getMedia('featured_image')->first()->getPath(),
);
}
}
Installation
Run the following command to install the package:
composer require ralphjsmit/laravel-seo
Publish the migration and configuration file:
php artisan vendor:publish --tag="seo-migrations"
php artisan vendor:publish --tag="seo-config"
Next, go to the newly published config file in config/seo.php and make sure that all the settings are correct. Those settings are all sort of default values:
<?php
return [
/**
* Use this setting to specify the site name that will be used in OpenGraph tags.
*/
'site_name' => null,
/**
* Use this setting to specify the path to the favicon for your website. The url to it will be generated using the `secure_url()` function,
* so make sure to make the favicon accessibly from the `public` folder.
*
* You can use the following file-types: ico, png, gif, jpeg, svg.
*/
'favicon' => null,
'title' => [
/**
* Use this setting to let the package automatically infer a title from the url, if no other title
* was given. This will be very useful on pages where you don't have an Eloquent model for, or where you
* don't want to hardcode the title.
*
* For example, if you have a with the url '/foo/about-me', we'll automatically set the title to 'About me' and append the site suffix.
*/
'infer_title_from_url' => true,
/**
* Use this setting to provide a suffix that will be added after the title on each page.
* If you don't want a suffix, you should specify an empty string.
*/
'suffix' => '',
],
'description' => [
/**
* Use this setting to specify a fallback description, which will be used on places
* where we don't have a description set via an associated ->seo model or via
* the ->getDynamicSEOData() method.
*/
'fallback' => null,
],
'image' => [
/**
* Use this setting to specify a fallback image, which will be used on places where you
* don't have an image set via an associated ->seo model or via the ->getDynamicSEOData() method.
* This should be a path to an image. The url to the path is generated using the `secure_url()` function (`secure_url($yourProvidedPath)`).
*/
'fallback' => null,
],
'author' => [
/**
* Use this setting to specify a fallback author, which will be used on places where you
* don't have an author set via an associated ->seo model or via the ->getDynamicSEOData() method.
*/
'fallback' => null,
],
'twitter' => [
/**
* Use this setting to enter your username and include that with the Twitter Card tags.
* Enter the username like 'yourUserName', so without the '@'.
*/
'@username' => null,
],
];
Now, add the following Blade-code on every page where you want the SEO-tags to appear:
{!! seo() !!}
This will render a lot of sensible tags by default, already greatly improving your SEO. It will also render things like the <title> tag, so you don't have to render that manually.
To really profit from this package, you can associate an Eloquent model with a SEO-model. This will allow you to dynamically fetch SEO data from your model and this package will generate as much tags as possible for you, based on that data.
To associate an Eloquent model with a SEO-model, add the HasSEO trait to your model:
use RalphJSmit\Laravel\SEO\Support\HasSEO;
class Post extends Model
{
use HasSEO;
// ...
This will automatically create and associate a SEO-model for you when a Post is created. You can also manually create a SEO-model for a Post, use the ->addSEO() method for that ($post->addSEO()).
You'll be able to retrieve the SEO-model via the Eloquent seo relationship:
$post = Post::find(1);
$seo = $post->seo;
On the SEO model, you may update the following properties:
title: this will be used for the<title>tag and all the related tags (OpenGraph, Twitter, etc.)description: this will be used for the<meta>description tag and all the related tags (OpenGraph, Twitter, etc.)author: this should be the name of the author and it will be used for the<meta>author tag and all the related tags (OpenGraph, Twitter, etc.)image: this should be the path to the image you want to use for the<meta>image tag and all the related tags (OpenGraph, Twitter, etc.). The url to the image is generated via thesecure_url()function, so be sure to check that the image is publicly available and that you provide the right path.
$post = Post::find(1);
$post->seo->update([
'title' => 'My title for the SEO tag',
'image' => 'images/posts/1.jpg', // Will point to `/public/images/posts/1.jpg
]);
However, it can be a bit cumbersome to manually update the SEO-model every time you make a change. That's why I provided the getDynamicSEOData() method, which you can use to dynamically fetch the correct data from your own model and pass it to the SEO model:
public function getDynamicSEOData(): SEOData
{
return new SEOData(
title: $this->title,
description: $this->excerpt,
author: $this->author->fullName,
);
}
You are allowed to only override the properties you want and omit the other properties (or pass null to them). You can use the following properties:
titledescriptionauthor(should be the author's name)image(should be the image path)url(by default it will beurl()->current())enableTitleSuffix(should betrueorfalse, this allows you to set a suffix in theconfig/seo.phpfile, which will be appended to every title)site_namepublished_time(should be aCarboninstance with the published time. By default this will be thecreated_atproperty of your model)modified_time(should be aCarboninstance with the published time. By default this will be theupdated_atproperty of your model)section(should be the name of the section of your content. It is used for OpenGraph article tags and it could be something like the category of the post)tags(should be an array with tags. It is used for the OpenGraph article tags)- 'schema' (this should be a SchemaCollection instance, where you can configure the JSON-LD structured data schema tags)
Finally, you should update your Blade file, so that it can receive your model when generating the tags:
{!! seo()->for($page) !!}
{{-- Or pass it directly to the `seo()` method: --}}
{!! seo($page ?? null) !!}
The following order is used when generating the tags (higher overwrites the lower):
- Any overwrites from the
SEOManager::SEODataTransformer($closure)(see below) - Data from the
getDynamicSEOData()method - Data from the associated SEO model (
$post->seo) - Default data from the
config/seo.phpfile
Generating JSON-LD structured data
This package can also generate structured data for you (also called schema markup). At the moment we support the following types:
ArticleBreadcrumbList
However, you can easily send me a (draft) PR with your requested types and I'll (most probably) add them to the package.
Article schema markup
To enable structured data, you need to use the schema property of the SEOData class. To generate Article schema markup, use the ->addArticle() method:
use RalphJSmit\Laravel\SEO\SchemaCollection;
public function getDynamicSEOData(): SEOData
{
return new SEOData(
// ...
schema: SchemaCollection::initialize()->addArticle(),
);
}
You can pass a closure the the ->addArticle() method to customize the individual schema markup. This closure will receive an instance of ArticleSchema as its argument. You can an additional author by using the ->addAuthor() method:
SchemaCollection::initialize()->addArticle(
fn (ArticleSchema $article): ArticleSchema => $article->addAuthor('Second author')
);
You can completely customize the schema markup by using the ->markup() method on the ArticleSchema instance:
use Illuminate\Support\Collection;
SchemaCollection::initialize()->addArticle(function(ArticleSchema $article): ArticleSchema {
return $article->markup(function(Collection $markup): Collection {
return $markup->put('alternativeHeadline', $this->tagline);
});
});
At this point, I'm just unable to fluently support every possible version of the structured, so this is the perfect way to add an additional property to the output!
BreadcrumbList schema markup
You can also add BreadcrumbList schema markup by using the ->addBreadcrumbs() function on the SchemaCollection:
SchemaCollection::initialize()->addBreadcrumbs(
function(BreadcrumbListSchema $breadcrumbs): BreadcrumbListSchema {
return $breadcrumbs->prependBreadcrumbs([
'Homepage' => 'https://example.com',
'Category' => 'https://example.com/test',
])->appendBreadcrumbs([
'Subarticle' => 'https://example.com/test/article/2',
])->markup(function(Collection $markup): Collection {
// ...
});
}
);
This code will generate BreadcrumbList JSON-LD structured data with the following four pages:
- Homepage
- Category
- [Current page]
- Subarticle
Advanced usage
Sometimes you may have advanced needs, that require you to apply your own logic to the SEOData class, just before it is used to generate the tags.
To accomplish this, you can use the SEODataTransformer() function on the SEOManager facade to register one or multiple closures that will be able to modify the SEOData instance at the last moment:
// In the `boot()` method of a service provider somewhere
use RalphJSmit\Laravel\SEO\Facades\SEOManager;
SEOManager::SEODataTransformer(function (SEOData $SEOData): void {
// This will change the title on *EVERY* page. Do any logic you want here, e.g. based on the current request.
$SEOData->title = 'Transformed Title';
});
Modifying tags before they are rendered
You can also register closures that can modify the final collection of generated tags, right before they are rendered. This is useful if you want to add custom tags to the output, or if you want to modify the output of the tags.
SEOManager::tagTransformer(function (TagCollection $tags): TagCollection {
$tags = $tags->reject(fn(Tag $tag) => $tag instanceof OpenGraphTag);
$tags->push(new MetaTag(name: 'custom-tag', content: 'My custom content'));
// Will render: <meta name="custom-tag" content="My custom content">
return $tags;
});
Roadmap
I hope this package will be usefull to you! If you have any ideas or suggestions on how to make it more useful, please let me know ([email protected]) or via the issues.
PRs are welcome, so feel free to fork and submit a pull request. I'll be happy to review your changes, think along and add them to the package.
General
130 Dec 23, 2022
301 Nov 25, 2022
3 Jan 6, 2022
205 Dec 23, 2022
39 Dec 21, 2022
51 Sep 21, 2022
66 Sep 19, 2022
269 Jan 1, 2023
375 Oct 28, 2022
2.7k Dec 31, 2022
7 Dec 9, 2022
173 Dec 23, 2022
4 May 12, 2022
127 Oct 11, 2022
73 Jun 1, 2022
18 Apr 2, 2022