SEOTools - SEO Tools for Laravel and Lumen

SEOTools is a package for Laravel 5.8+ and Lumen that provides helpers for some common SEO techniques.

Current Build Status

Statistics

For license information check the LICENSE-file.

Features

• Friendly simple interface
• Easy of set titles and meta tags
• Easy of set metas for Twitter Cards and Open Graph
• Easy of set for JSON Linked Data

Installation

1 - Dependency

The first step is using composer to install the package and automatically update your composer.json file, you can do this by running:

Note: If you are using Laravel 5.5, the steps 2 and 3, for providers and aliases, are unnecessaries. SEOTools supports Laravel new Package Discovery.

2 - Provider

You need to update your application configuration in order to register the package so it can be loaded by Laravel, just update your config/app.php file adding the following code at the end of your 'providers' section:

config/app.php

Lumen

Go to /bootstrap/app.php file and add this line:

3 - Facades

Note: facades are not supported in Lumen.

You may get access to the SEO tool services using following facades:

• Artesaos\SEOTools\Facades\SEOMeta
• Artesaos\SEOTools\Facades\OpenGraph
• Artesaos\SEOTools\Facades\TwitterCard
• Artesaos\SEOTools\Facades\JsonLd
• Artesaos\SEOTools\Facades\JsonLdMulti
• Artesaos\SEOTools\Facades\SEOTools

You can setup a short-version aliases for these facades in your config/app.php file. For example:

4 Configuration

Publish config

In your terminal type

or

Lumen does not support this command, for it you should copy the file src/resources/config/seotools.php to config/seotools.php of your project

In seotools.php configuration file you can determine the properties of the default values and some behaviors.

seotools.php

• meta
  • defaults - What values are displayed if not specified any value for the page display. If the value is false, nothing is displayed.
  • webmaster - Are the settings of tags values for major webmaster tools. If you are null nothing is displayed.
• opengraph
  • defaults - Are the properties that will always be displayed and when no other value is set instead. You can add additional tags that are not included in the original configuration file.
• twitter
  • defaults - Are the properties that will always be displayed and when no other value is set instead. You can add additional tags that are not included in the original configuration file.
• json-ld
  • defaults - Are the properties that will always be displayed and when no other value is set instead. You can add additional tags that are not included in the original configuration file.

Usage

Lumen Usage

Note: facades are not supported in Lumen.

Meta tags Generator

With SEOMeta you can create meta tags to the head

Opengraph tags Generator

With OpenGraph you can create OpenGraph tags to the head

Twitter for Twitter Cards tags Generator

With Twitter you can create OpenGraph tags to the head

In your controller

SEOTrait

In Your View

Pro Tip: Pass the parameter true to get minified code and reduce filesize.

Using Macro

Using the same code in multiple places can be tedious, which is why this package includes a Macroable trait. This trait allows additional functionality to be added to a class that was not defined in the class definition, using a simple trait.

For example, imagine that you need to add meta titles and descriptions for your pages. You can add your Macroable functions in the AppServiceProvider or create a dedicated file for this purpose, and define your function as shown in the code snippet:

In your controller, you can use the following code to utilize the function:

API (SEOMeta)

API (OpenGraph)

API (TwitterCard)

API (JsonLd)

API (JsonLdMulti)

API (SEO)

Facilitates access to all the SEO Providers

Missing Features

There are many SEO-related features, which you may need for your project. While this package provides support for the basic ones, other are out of its scope. You'll have to use separate packages for their integration.

SiteMap

This package does not support sitemap files generation. Please consider usage one of the following packages for it:

• laravelium/sitemap

• spatie/laravel-sitemap

URL Trailing Slash

This package does not handle URL consistency regardless absence or presence of the slash symbol at its end. Please consider usage one of the following packages if you need it:

• illuminatech/url-trailing-slash

• fsasvari/laravel-trailing-slash

Microdata Markup

This package does provide generation of the microdata HTML markup. If you need to create HTML like the following one:

you will need to handle it yourself.

Note: nowadays microdata markup is considered to be outdated. It is recommened to use JSON Linked Data instead, which is supported by this extension.

RSS

This package does not support RSS feed generation or related meta data composition. Please consider usage one of the following packages for it:

• spatie/laravel-feed