Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/f9webltd/laravel-meta
Laravel Meta Tags - Render meta tags within your Laravel application
https://github.com/f9webltd/laravel-meta
header-meta-tags laravel laravel-meta-tags laravel-seo meta meta-tags open-graph
Last synced: about 2 months ago
JSON representation
Laravel Meta Tags - Render meta tags within your Laravel application
- Host: GitHub
- URL: https://github.com/f9webltd/laravel-meta
- Owner: f9webltd
- License: mit
- Created: 2020-05-18T15:16:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-18T10:23:25.000Z (9 months ago)
- Last Synced: 2024-09-19T03:21:40.115Z (3 months ago)
- Topics: header-meta-tags, laravel, laravel-meta-tags, laravel-seo, meta, meta-tags, open-graph
- Language: PHP
- Homepage:
- Size: 132 KB
- Stars: 40
- Watchers: 4
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://packagist.org/packages/f9webltd/laravel-meta)
[](https://github.com/f9webltd/laravel-meta/actions/workflows/run-tests.yml)
[](https://github.styleci.io/repos/264978205)
[](https://packagist.org/packages/f9webltd/laravel-meta)
# Laravel Meta Tags
Easily render meta tags within your Laravel application, using a fluent API
## Features
- Simple API
- Render named, property, raw, Twitter card and OpenGraph type meta tags
- [Optionally, render default tags on every request](#default-tags)
- [Conditionally set tags](#conditionally-setting-tags)
- [Macroable](#macroable-support)
- There is no need to set meta titles for every controller method. The package can [optionally guess titles based on uri](#meta-title) segments or the current named route
- Well documented
- Tested, with 100% code coverage
## Requirements
- PHP `^8.0`
- Laravel `^8.12`, `^9.0`, `^10.0` or `^11.0`
### Legacy Support / Upgrading
For PHP `<8.0` and Laravel `<8.12` / support, use package version [`^1.7.7`](https://github.com/f9webltd/laravel-meta/tree/1.7.7)
If upgrading from `^1.0`, see [UPGRADING](UPGRADING.md) for details.
## Installation
``` bash
composer require f9webltd/laravel-meta
```
The package will automatically register itself.
Optionally publish the configuration file by running:
```bash
php artisan vendor:publish --provider="F9Web\Meta\MetaServiceProvider" --tag="config"
```
## Documentation
This package aims to make adding common meta tags to your Laravel application a breeze.
### Usage
Within a controller:
```php
meta()
->set('title', 'Buy widgets today')
->set('canonical', '/users/name')
->set('description', 'My meta description')
->set('theme-color', '#fafafa')
->noIndex();
```
To output metadata add the following within a Blade layout file:
```php
{!! meta()->toHtml() !!}
```
```html
Buy widgets today - Meta Title Append
```
Optionally, the `Meta` facade can be used as an alternative to `meta()` helper, generating the same output:
```php
Meta::set('title', 'Buy widgets today')
->set('canonical', '/users/name')
->set('description', 'My meta description')
->set('theme-color', '#fafafa')
->noIndex();
```
### Conditionally Setting Tags
The `when()` method can be used to conditionally set tags. A boolean condition (indicating if the closure should be executed) and a closure. The closure parameter is full instance of the meta class, meaning all methods are callable.
```php
$noIndex = true;
meta()->when($noIndex, function ($meta) {
$meta->noIndex();
});
```
The `when()` is fluent and can be called multiple times:
```php
meta()
->set('title', 'the title')
-when(true, fn ($meta) => $meta->set('og:description', 'og description'))
-when(false, fn ($meta) => $meta->set('referrer', 'no-referrer-when-downgrade'))
->noIndex();
```
### Blade Directives
Blade directives are available, as an alternative to using PHP function within templates.
To render all metadata:
```html
@meta
```
Render a specific meta tag by name:
```html
@meta('title')
```
### Additional tag types
The package supports multiple tag types.
#### Property type tags
To create property type tags, append `property:` before the tag name.
```php
meta()->set('property:fb:app_id', '1234567890');
```
```html
```
#### Twitter card tags
To create twitter card tags, append `twitter:` before the tag name.
```php
meta()->set('twitter:site', '@twitter_user');
```
```html
```
#### Open Graph tags
To create Open Graph (or Facebook) tags, append `og:` before the tag name:
```php
meta()
->set('og:title', 'My new site')
->set('og:url', 'http://site.co.uk/posts/hello.html');
```
```html
```
#### Other tag types
To create other tag types, use the `raw()` method:
```php
meta()
->setRawTag('')
->setRawTag('');
```
```html
```
### Default tags
It may be desirable to render static meta tags application wide. Optionally define common tags within `f9web-laravel-meta.defaults`.
For example, defining the below defaults
```php
'defaults' => [
'robots' => 'all',
'referrer' => 'no-referrer-when-downgrade',
'',
],
```
will render the following on every page:
```html
```
### Helper methods
#### `get()`
Fetch a specific tag value by name.
```php
meta()->set('title', 'meta title');
meta()->get('title'); // meta title
```
`null` is returned for none existent tags.
#### `render()`
Render all defined tags. `render()` is called when rendering tags within Blade files.
The below calls are identical.
```php
{!! meta()->toHtml() !!}
{!! meta()->render() !!}
```
Passing a tag title to `render()` will render that tag.
```php
meta()->set('title', 'meta title');
meta()->render('title'); // meta title
```
#### `fromArray()`
Generate multiple tags from an array of tags.
```php
meta()
->fromArray([
'viewport' => 'width=device-width, initial-scale=1.0',
'author' => 'John Joe',
'og:title' => 'When Great Minds Dont Think Alike',
'twitter:title' => 'Using Laravel 7',
]);
```
```html
Users - Edit - Meta Title Append
```
#### `setRawTags()`
Generate multiple raw tags from an array.
```php
meta()
->setRawTags([
'',
'',
''
]);
```
```html
```
#### `tags()`
Fetch all tags as an array.
```php
meta()
->set('title', 'meta title')
->set('og:title', 'og title');
$tags = meta()->tags();
/*
[
"title" => "meta title"
"og:title" => "og title"
];
*/
```
#### `purge()`
Remove all previously set tags.
#### `forget()`
Remove a previously set tag by title.
```php
meta()
->set('title', 'meta title')
->set('og:title', 'og title');
meta()->forget('title');
$tags = meta()->tags();
// ["og:title" => "og title"];
```
#### `noIndex()`
Generate the necessary tags to exclude the url from search engines.
```php
meta()->noIndex();
```
```html
```
#### `favIcon()`
Generate the necessary tags for a basic favicon. The favicon path can be specified within the `f9web-laravel-meta.favicon-path` configuration value.
```php
meta()->favIcon();
```
```html
```
### Dynamic Calls
For improved readability, it is possible to make dynamic method calls. The below codes blocks would render identical HTML:
```php
meta()
->title('meta title')
->description('meta description')
->canonical('/users/me');
```
```php
meta()
->set('title', 'meta title')
->set('description', 'meta description')
->set('canonical', '/users/me');
```
### Macroable Support
The package implements Laravel's `Macroable` trait, meaning additional methods can be added the main Meta service class at run time. For example, [Laravel's collection class is macroable](For furtherinformatioin see the following samples
).
The `noIndex` and `favIcon` helpers are defined as macros within the [package service provider](src/MetaServiceProvider.php).
Sample macro to set arbitrary defaults tags for SEO:
```php
// within a service provider
Meta::macro('seoDefaults', function () {
return Meta::favIcon()
->set('title', $title = 'Widgets, Best Widgets')
->set('og:title', $title)
->set('description', $description = 'Buy the best widgets from Acme Co.')
->set('og:description', $description)
->fromarray([
'twitter:card' => 'summary',
'twitter:site' => '@roballport',
]);
});
```
To call the newly defined macro:
```php
meta()->seoDefaults();
```
Macros can also accept arguments.
```php
Meta::macro('setPaginationTags', function (array $data) {
$page = $data['page'] ?? 1;
if ($page > 1) {
Meta::setRawTag('');
}
if (!empty($data['next'])) {
return Meta::setRawTag('');
}
return Meta::instance();
});
```
```php
meta()->setPaginationTags([
'page' => 7,
'next' => '/users/page/8',
'prev' => '/users/page/6',
]);
```
To allow for fluent method calls ensure the macro returns an instance of the class.
### Special tags
#### Meta title
The package ensures a meta tag is always present. Omitting a title will force the package to guess one based upon the current named route or uri.
The set the preferred method, edit the `f9web-laravel-meta.title-guessor.method` configuration value.
##### `uri` method sample
- if the uri is `/orders/create` thr guessed title is "Orders - Create"
- if the uri is `/orders/9999/edit` thr guessed title is "Orders - 9999 - Edit"
##### `route` method sample
- current named route is `users.create`, guessed title 'Users - Create'
- current named route is `users.index`, guessed title 'Users'
This behaviour can be disabled via editing the `f9web-laravel-meta.title-guessor.enabled` configuration value.
This automatic resolution is useful in large applications, where it would be otherwise cumbersome to set metadata for every controller method.
##### Appending text to the meta title
Typically, common data such as the company name is appended to meta titles.
The `f9web-laravel-meta.meta-title-append` configuration value can be set to append the given string automatically to every meta title.
To disable this behaviour set `f9web-laravel-meta.meta-title-append` to `null`.
##### Limiting the meta title length
For SEO reasons, the meta title length should be restricted. This package, by default, limits the title to 60 characters.
To change this behaviour update the configuration value of `f9web-laravel-meta.title-limit`. Set to `null` to stop limiting.
#### Meta description
For SEO reasons, the meta description should typically remain less than ~160 characters. This package, by default, does not limit the length.
To change the limit adjust the configuration value `f9web-laravel-meta.description-limit`. Set to `null` to stop limiting.
#### Canonical
It is important to set a sensible [canonical](https://ahrefs.com/blog/canonical-tags/). Optionally, the package can automatically replace user defined strings when generating a canonical.
Due to incorrect setup some Laravel installations allow `public` and/or `index.php` within the url.
For instance, `/users/create`, `/public/users/create` and `/public/index.php/users/create` would both be visitable, crawlable and ultimately indexable urls.
By editing the array of removable url strings within `f9web-laravel-meta.removable-uri-segments`, this behaviour can be controlled.
The package will strip `public` and `index.php` from canonical urls automatically, as a default.
## Contribution
Any ideas are welcome. Feel free to submit any issues or pull requests.
## Testing
``` bash
composer test
```
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Rob Allport](https://github.com/ultrono)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.