README

This addon provides an easy way to create social profile and sharing links for channels like Facebook, Twitter and more.

Installation

Install the addon using Composer.

composer require aerni/social-links

Supported Channels

This addon supports the following social channels: Facebook, GitHub, Instagram, LinkedIn, Mail, Pinterest, Telegram, Twitter, Vimeo, WhatsApp, Xing, YouTube

Profile Link

Create a link to a social profile by providing the social channel and handle of the profile:

{{ social:profile channel="facebook" handle="michaelaerni" }}

Or using the shorthand:

{{ social:facebook:profile handle="michaelaerni" }}

Sharing Link

Create a sharing link by providing the social channel:

{{ social:share channel="facebook" }}

Or using the shorthand:

{{ social:facebook:share }}

Parameters

There are a number of parameters you may use to customize the sharing links:

Facebook

LinkedIn

Mail

The url will be placed in the body of the email by default. You can customize the email body text by using the body parameter. Note, that this will override the default body text that includes the url. You will have to manually add the url in the body parameter like so:

{{ social:mail:share body="I want to share this great site with you: {permalink}" }}

Pinterest

Telegram

Twitter

WhatsApp

Xing

Channel Name

Get the name of a social channel:

{{ social:name channel="facebook" }}

Or using the shorthand:

{{ social:facebook:name }}

Tag Pair

You may also use a tag pair to get all the data at once:

{{ social channel="facebook" handle="michaelaerni" }}
  {{ profile }}
  {{ share }}
  {{ name }}
{{ /social }}

Or using the shorthand:

{{ social:facebook handle="michaelaerni" }}
  {{ profile }}
  {{ share }}
  {{ name }}
{{ /social:facebook }}`

Extending

You can register your own custom channels in two ways.

Creating a Custom Channel

Create a class that extends BaseChannel. A channel can support profile links, share links, or both. All params passed to the Antlers tag are available in the channel via $this->params->get('param_name').

Profile Channels

To support profile links, set the $profileBaseUrl property. The profile URL is built by appending the handle param to the base URL. The handle param must be provided on the Antlers tag.

use Aerni\SocialLinks\Channels\BaseChannel;

class Mastodon extends BaseChannel
{
    protected string $profileBaseUrl = 'https://mastodon.social';
}

Share Channels

To support share links, set the $shareBaseUrl property and override shareUrlParams() to define the query parameters for the share URL. The url param defaults to the current page URL if not explicitly provided on the Antlers tag.

use Aerni\SocialLinks\Channels\BaseChannel;

class Reddit extends BaseChannel
{
    protected string $shareBaseUrl = 'https://www.reddit.com/submit';

    protected function shareUrlParams(): array
    {
        return [
            'url' => $this->params->get('url'),
            'title' => $this->params->get('title'),
        ];
    }
}

If you need dynamic logic for the base URL, override the profileBaseUrl() or shareBaseUrl() method instead of using the property.

Registering via Config

Publish the config file and add your channel class to the channels array in config/social-links.php:

return [
    'channels' => [
        App\Channels\Mastodon::class,
    ],
];

Registering Programmatically

Register a channel from a service provider's boot() method:

use App\Channels\Mastodon;

public function boot(): void
{
    Mastodon::register();
}