Document your code
Every project on GitHub comes with a version-controlled wiki to give your documentation the high level of care it deserves. It’s easy to create well-maintained, Markdown or rich text documentation alongside your code.
Sign up for free See pricing for teams and enterprisesPeriscope On Air Button
The Twitter plugin for WordPress supports adding a Periscope On Air button to your site through a WordPress widget, pasting a Periscope profile URL into post content, or through the periscope_on_air WordPress shortcode. Add a Follow button to a WordPress post by
including the shortcode in your post content area or by evaluating a shortcode in PHP using the do_shortcode WordPress function.
Display a Periscope On Air button for a Periscope profile URL
Add a Periscope On Air button to a WordPress post by copy-and-pasting a Periscope profile URL on its own line in the post content area.
I broadcast on Periscope. https://www.periscope.tv/TwitterDev Follow my account to view new broadcasts.
Customize a Periscope On Air button using a shortcode
Example:
I broadcast on Periscope. [periscope_on_air username="TwitterDev" size="large"] Follow my account to view new broadcasts.
Supported shortcode parameters
| Attribute | Description | Example |
|---|---|---|
| username | Periscope username of the account to display.
The plugin will automatically set an omitted username parameter to the stored Periscope username of the current post author when the shortcode is called inside the loop. |
TwitterDev |
| size | Set to large to display a larger version of the Periscope On Air button. |
large |
Site-wide customization using a filter
A website may set site-wide preferences for Periscope On Air buttons by acting on the associative array passed to the shortcode_atts_periscope_on_air WordPress filter.
Example:
/**
* Always show large button
*
* @param array $options parsed options with defaults applied
* @param array $defaults default values of a Periscope On Air button
* @param array $attributes user-defined shortcode attributes
*
* @return array options array with our customization applied
*/
function periscope_on_air_custom_options( $options, $defaults, $attributes )
{
$options['size'] = 'large';
return $options;
}
add_filter( 'shortcode_atts_periscope_on_air', 'periscope_on_air_custom_options', 10, 3 );