wirelab / shares-plugin

Shares module for PyroCMS3

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Shares plugin

⚠️ This repository has been deprecated ⚠️

Plugin which provides users with a quick way of adding customizable share links with GA tracking. Works with any module that sets a meta_title and meta_description.

Installation

composer require wirelab/shares-plugin

Usage

  1. Set your facebook app key in settings > plugins > shares plugin (optional)
  2. Selects the networks that are enabled by default settings > plugins > shares plugin (optional)
  3. put {{ shares_scripts()|raw }} in your theme to load all javascript files
  4. call {{ shares({title: '', url: '', description: '', networks: ['']|raw }} in any twig file.

All parameters are optional

Parameters

Name Description Optional Default value Type
title The title used in the shares yes template.meta_title String
description The description used in the shares yes template.meta_description String
url The url that gets shares yes the current url String
networks List of social media networks to return yes all (configurable in the settings) Array

Enable facebook shares

Set the following cookie: cconsent=isAccepted using javascript. Then call callCbIfConsentGiven(callback).

Examples

{{ shares() }} {# Guessing all data #}

{{ shares({'networks':['twitter','facebook']}) }} {# Limiting to certain networks #}

{# Manually setting data #}
{{
	shares({
		'title': 'Wirelab',
		'description': 'The website of Wirelab',
		'url': 'http:://www.wirelab.nl'
	})
}}

{{ shares_data() }} {# Get an array of all data instead of views #}

Adding google analytics

Add the following code near the top of the <head> tag. Replace UA-XXXXX-Y with the property ID (also called the "tracking ID") of the Google Analytics property you wish to track.

<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-XXXXX-Y', 'auto');
ga('send', 'pageview');
</script>

For the most recent snippet please check Google's documentation

About

Shares module for PyroCMS3

License:MIT License


Languages

Language:PHP 68.1%Language:Twig 31.9%