You are viewing an older version of the Social Share documentation (1.x). View the latest version (2.x) →
Template Guides

Available Variables

The following methods are available to call in your Twig templates:

craft.socialShare.getProviders()

Returns a collection of all Provider objects.

craft.socialShare.getProvider(handle)

Returns a Provider for the provided handle.

craft.socialShare.getFollowersCountProviders()

Returns a collection of all Provider objects that support Follower Counts.

craft.socialShare.getSharesCountProviders()

Returns a collection of all Provider objects that support Share Counts.

craft.socialShare.getShareButtonProviders()

Returns a collection of all Provider objects that support Share Buttons.

craft.socialShare.getFollowers(handle, account, options)

Returns a the number of followers for a given provider and identifier (username, ID, etc).

craft.socialShare.getShares(handle, url, options)

Returns a the number of shares for a given provider and url.

craft.socialShare.getShareButton(handle, options)

Returns a Share Button for a given provider.

craft.socialShare.renderShareButton(handle, options)

Returns a rendered Share Button for a given provider.

craft.socialShare.getButton(handle, options)

Returns a Button for a given provider.

craft.socialShare.renderButton(handle, options)

Returns a rendered Button for a given provider.