You are here

Home » API reference » Ridiculously Responsive Social Sharing Buttons 7 » rrssb.api.php

function hook_rrssb_buttons in Ridiculously Responsive Social Sharing Buttons 7

Same name and namespace in other branches
  1. 8.2 rrssb.api.php \hook_rrssb_buttons()
  2. 7.2 rrssb.api.php \hook_rrssb_buttons()

Provide configuration for social share buttons.

Return value

Array of button configuration. The key is an identifier for the button. The value is an associative array that may contain the following key-value pairs. You must pass at least one of share_url and follow_url, and you may pass both.

  • "svg": Required. SVG definition, in the form of an <svg> tag and contained paths. The SVG should be minified, without any width/height/fill/etc.
  • "share_url": URL for users to share your page using this social media site. Placeholders {{param}} will be replaced with values from the current page: url; title; image.
  • "follow_url": URL for users to follow you using this social media site. Placeholder {{username}} will be replaced with the user name you configured for this social media site.
  • "color": Background color to use for this button.
  • "color_hover": Background color to use for this button on hover.
  • "text": Text to use for this button. Defaults to the identifier used as a key for this button.
  • "popup": Whether to use the popup class for this button. Defaults to TRUE.

See also

rrssb_rrssb_buttons

1 function implements hook_rrssb_buttons()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

rrssb_rrssb_buttons in ./rrssb.config.inc
Implements hook_rrssb_buttons().
1 invocation of hook_rrssb_buttons()
rrssb_settings in ./rrssb.module
Fetch buttons settings.

File

./rrssb.api.php, line 27
Hooks provided by the Ridiculously Responsive Social Share Buttons module.

Code

function hook_rrssb_buttons() {
}