Skip to content

Pass Kirby object to config function #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Pass Kirby object to config function #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c600f74
pass kirby object to meta tags config function
deanbot Jul 4, 2020
04c9daa
update readme
deanbot Jul 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The plugin ships with some default meta tags enabled for your convenience:
```php
return [
// other options...
'pedroborges.meta-tags.default' => function ($page, $site) {
'pedroborges.meta-tags.default' => function ($page, $site, $kirby) {
return [
'title' => $site->title(),
'meta' => [
Expand Down Expand Up @@ -82,7 +82,7 @@ Following the flexible spirit of Kirby, you also have the option to add template
```php
return [
// other options...
'pedroborges.meta-tags.templates' => function ($page, $site) {
'pedroborges.meta-tags.templates' => function ($page, $site, $kirby) {
return [
'song' => [
'og' => [
Expand Down Expand Up @@ -114,7 +114,7 @@ Both the `pedroborges.meta-tags.default` and `pedroborges.meta-tags.templates` a
It accepts an array containing any or all of the following keys: `title`, `meta`, `link`, `og`, and `twitter`. With the exception of `title`, all other groups must return an array of key-value pairs. Check out the [tag groups](#tag-groups) section to learn which value types are accepted by each key.

```php
'pedroborges.meta-tags.default' => function ($page, $site) {
'pedroborges.meta-tags.default' => function ($page, $site, $kirby) {
return [
'title' => 'Site Name',
'meta' => [ /* meta tags */ ],
Expand All @@ -130,7 +130,7 @@ It accepts an array containing any or all of the following keys: `title`, `meta`
This option allows you to define a template specific set of meta tags. It must return an array where each key corresponds to the template name you are targeting.

```php
'pedroborges.meta-tags.templates' => function ($page, $site) {
'pedroborges.meta-tags.templates' => function ($page, $site, $kirby) {
return [
'article' => [ /* tags groups */ ],
'about' => [ /* tags groups */ ],
Expand Down Expand Up @@ -244,7 +244,7 @@ Where you can define [Open Graph](http://ogp.me) `<meta>` elements.
Of course you can use Open Graph [structured objects](http://ogp.me/#structured). Let's see a blog post example:

```php
'pedroborges.meta-tags.templates' => function ($page, $site) {
'pedroborges.meta-tags.templates' => function ($page, $site, $kirby) {
return [
'article' => [ // template name
'og' => [ // tags group name
Expand All @@ -257,7 +257,7 @@ Of course you can use Open Graph [structured objects](http://ogp.me/#structured)
],
'namespace:image' => function(Page $page) {
$image = $page->cover()->toFile();

return [
'image' => $image->url(),
'height' => $image->height(),
Expand Down
4 changes: 2 additions & 2 deletions src/MetaTags.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ public function __construct(Page $page)
]);

$this->page = $page;
$this->data = is_callable($default) ? $default($page, site()) : $default;
$templates = is_callable($templates) ? $templates($page, site()) : $templates;
$this->data = is_callable($default) ? $default($page, site(), kirby()) : $default;
$templates = is_callable($templates) ? $templates($page, site(), kirby()) : $templates;

if (! is_array($this->data)) {
throw new Exception('Option "pedroborges.meta-tags.default" must return an array');
Expand Down