Share Care for Silverstripe
When URLs are shared on social media a rich preview of the content may be
generated to give the URL context. The goal of this module is to encourage CMS
users to be aware of how their content will appear when shared, and give them
tools to customise this appearance., (*1)
, (*2)
Requirements
Installation
See the Packagist listing and composer installation instructions., (*3)
$ composer require jonom/silverstripe-share-care- Flush manifests by visiting /dev/build
How to use
View rich share previews in the CMS
With the module installed you should find a Share tab on all pages
which shows you roughly what each page will look like when shared on social
media. The preview is based upon the output of the Opengraph module, so your
configuration of that module will be reflected here., (*4)
To add share previews to other DataObject classes, just add the
ShareCare extension to them. Example:, (*5)
---
Name: mysharecare
After: 'opengraphextensions'
---
MyDataObject:
extensions:
- JonoM\ShareCare\ShareCare
See the Silverstripe documentation for more info on extensions., (*6)
Customise the appearance of content on social media
You can configure the Opengraph module to generate open graph tags however you
like, and this is what controls the appearance of rich previews on social
media (especially Facebook and Twitter). To quickly configure the Opengraph
module to allow CMS users to customise the content and appearance of these
previews, just add the ShareCareFields extension to your Page class (and any
other classes you like)., (*7)
, (*8)
Example configuration:, (*9)
---
Name: mysharecare
After: 'opengraphextensions'
---
Page:
extensions:
- JonoM\ShareCare\ShareCareFields
This allows CMS users to customise the image, title and description that are
shown when a URL is shared on social media. You can further tweak these
behaviours by overriding functions on your classes. For example if each page
on your website already contains a Hero Image, you may want to override
getDefaultOGImage() to use this as the default image:, (*10)
/**
* Provide a better default OG image for pages
*/
public function getDefaultOGImage() {
// Use hero image if available
if ($this->HeroImageID) {
return $this->HeroImage();
}
// Fallback to website's apple-touch-icon
if (file_exists(BASE_PATH . '/apple-touch-icon.png')) {
return Director::absoluteURL('apple-touch-icon.png', true);
}
}
Note that og:image is a required property, so please ensure
that getDefaultOGImage() will always work. If your website includes an
apple-touch-icon.png file in the root you'll be covered., (*11)
Don't need that much control?
As an alternative to the ShareCareFields extension, try taking the
ShareCareSingleSummary extension for a spin. This opinionated extension
lets CMS users choose a single image and a single summary to be used to
represent a page within the website and on search engines and social media.
It puts the fields front and centre above the main content field to encourage
CMS users to actually fill them out. As a bonus it also hides that pesky
'custom meta tags' field away in the Settings tab., (*12)
, (*13)
Example configuration:, (*14)
---
Name: mysharecare
After: 'opengraphextensions'
---
Page:
extensions:
- JonoM\ShareCare\ShareCareSingleSummary
Markup for a large image summary
Twitter card will be included if a large enough image is provided. To attribute
content ownership set a Twitter username in your config.yml file. Example:, (*15)
JonoM\ShareCare\ShareCare:
twitter_username: 'your-username'
Don't want Twitter card markup? Disable it like so:, (*16)
JonoM\ShareCare\ShareCare:
twitter: false
Note that Twitter will still use your open graph tags to produce a rich preview
if this feature is disabled., (*17)
Control Facebook's Cache
Out of the box, this module will attempt to clear Facebook's knowledge of your site
or app, after every page write. You will probably need a Facebook access token for
this functionality to work (it used to be optional but now seems to be required)., (*18)
See the facebook access token docs entry for
instructions on obtaining and using the token., (*19)
Opt out of Facebook cache clearing
You can opt out through the config system or object methods., (*20)
Use the following config to only attempt to purge the Facebook cache on live environments., (*21)
JonoM\ShareCare\ShareCare:
enable_facebook_cache_clear: false
---
Only:
environment:
- live
---
JonoM\ShareCare\ShareCare:
enable_facebook_cache_clear: true
If you need more control you can provide a doClearFacebookCache() method on your Page or DataObject class to return true or false as necessary. You may want to return the value of Config::inst()->get('JonoM\ShareCare\ShareCare', 'enable_facebook_cache_clear') as a fallback., (*22)
Share links
You can use these methods in your templates to get a convenient share URL
for each service, (*23)
$FacebookShareLink$TwitterShareLink$PinterestShareLink$LinkedInShareLink$EmailShareLink
Pinterest CMS integration
If you're making use of the ShareCareFields extension and $PinterestShareLink, you can
include a Pinterest preview in the CMS and allow CMS users to set a different image for
Pinterest, as tall rather than wide images are better suited to this service., (*24)
JonoM\ShareCare\ShareCare:
pinterest: true
Maintainer contact
Jono Menz, (*25)
If you want to boost morale of the maintainer you're welcome to make a small monthly donation through GitHub, or a one time donation through PayPal. ❤️ Thank you!, (*26)
Please also feel free to get in touch if you want to hire the maintainer to develop a new feature, or discuss another opportunity., (*27)
Wallogit.com
