Installation
Use one of these methods to install the plugin:
- composer (recommended):
composer require mauricerenck/bloggerrolle
- zip file: unzip main.zip as folder
site/plugins/bloggerrolle
Usage
After installing the plugin, it will ping bloggerrolle.de and/or uberblogr.de whenever you publish a page.
If you are not a member of the uberblogr webring, you first have to register your site at bloggerrolle.de. If you are a member of the uberblogr webring, you don't have to register your site at bloggerrolle.de again. Read more about this here
In both cases you at least have to set the URL your registered with in your config.php
file:
<?php
return [
"mauricerenck.bloggerrolle" => [
'url' => 'https://YOUR-BLOG-URL',
],
];
Use the full URL. So if you registered with https://example.com/en/blog
you also need to use that URL in your config.php
file.
Uberblogger members
In case your blog is a member of uberblogr you don't need to register at bloggerrolle.de again. This plugin will automatically ping both sites. In this case go to your config and set:
<?php
"mauricerenck.bloggerrolle" => [
'url' => 'https://YOUR-BLOG-URL',
'uberblogr' => true,
],
Restricting templates
You may not want to ping the pages with every page you publish. For example a new legal page should not result in a ping, but a new blog post should.
You have two options:
- Allow specific templates to ping
- Block specific templates from pinging
Setting templates.allowed
will allow only the templates listed in the array to ping, no other template will send a ping.
<?php
'mauricerenck.bloggerrolle.templates.allowed' => ['post', 'note'],
Setting templates.blocked
will allow all templates except the ones listed in the array to ping.
<?php
'mauricerenck.bloggerrolle.templates.blocked' => ['legal'],
Leave both options away if you don't want any restrictions.
Options
Please make sure to prefix all options with mauricerenck.bloggerrolle
or use the array notation.
Option | Default | Description |
---|---|---|
url |
'' |
The URL of your blog |
uberblogr |
false |
set to true if you are a uberblogr member |
templates.allowed |
[] |
A list of template/blueprint names which should send a ping |
templates.blocked |
[] |
A list of template/blueprint names which should not send a ping |
Write a comment