A simple client to retrieve webmentions for your pages.
You can install the package via composer:
composer require astrotomic/laravel-webmentions
At firsts you will have to add your webmention.io API access token to the
services.php config file.
return [ // ... 'webmention' => [ 'token' => env('WEBMENTION_TOKEN'), ], // ... ];
You can retrieve all webmentions for a given URL by calling the
get() method on the packages client.
use Astrotomic\Webmentions\Facades\Webmentions; $records = Webmentions::get('https://gummibeer.dev/blog/2020/human-readable-intervals');
If you omit the url as argument it will automatically use
\Illuminate\Http\Request::url() as default.
The return value will be an instance of
\Astrotomic\Webmentions\Collections\WebmentionsCollection which provides you with predefined filter methods.
You can also use the shorthand methods on the client to retrieve a collection of likes, mentions, replies or reposts.
use Astrotomic\Webmentions\Facades\Webmentions; $likes = Webmentions::likes('https://gummibeer.dev/blog/2020/human-readable-intervals'); $mentions = Webmentions::mentions('https://gummibeer.dev/blog/2020/human-readable-intervals'); $replies = Webmentions::replies('https://gummibeer.dev/blog/2020/human-readable-intervals'); $reposts = Webmentions::reposts('https://gummibeer.dev/blog/2020/human-readable-intervals');
All items will be a corresponding instance of
If you only need the count of items you can use the
use Astrotomic\Webmentions\Facades\Webmentions; $counts = Webmentions::count('https://gummibeer.dev/blog/2020/human-readable-intervals'); [ 'count' => 52, 'type' => [ 'like' => 23, 'mention' => 8, 'reply' => 16, 'repost' => 5, ], ];
The client uses a poor man cache by default - so per runtime every domain is only requested once.
If you want extended caching behavior you should wrap the calls in a
Cache::remember() for example.
To receive webmentions for your page you have to add two
<link/> tags to your head.
This package provides a
<x-webmention-links/> Blade component that makes it easier for you.
<x-webmention-links /> <!-- will use the domain of current request --> <x-webmention-links domain="gummibeer.dev" /> <!-- will use the given domain --> <!-- RESULT --> <link rel="webmention" href="https://webmention.io/gummibeer.dev/webmention" /> <link rel="pingback" href="https://webmention.io/gummibeer.dev/xmlrpc" />
Please see CHANGELOG for more information what has changed recently.
If you discover any security related issues, please check SECURITY for steps to report it.
The MIT License (MIT). Please see License File for more information.
You're free to use this package, but if it makes it to your production environment I would highly appreciate you buying the world a tree.
It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you contribute to my forest you’ll be creating employment for local families and restoring wildlife habitats.
You can buy trees at offset.earth/treeware
Read more about Treeware at treeware.earth