goblindegook/shorthand

A WordPress shortcode pack, from my site to yours.

Installs: 27

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:wordpress-plugin

1.2.0 2015-08-02 00:30 UTC

This package is not auto-updated.

Last update: 2024-02-17 14:22:25 UTC


README

Packagist Scrutinizer Code Quality

A bunch of shortcodes developed for my site, now offered to the public. Shortcake is supported because, honestly, who doesn't love cake?

Installation

This plugin is not (yet?) available in the repository, Composer is the recommended way to install it:

$ composer require goblindegook/shorthand

If you want to know more about using Composer with WordPress, there's a good introduction at the Roots project site.

Shortcodes

Pull Quote

Renders a pull quote aside block with pull-quote and pull-quote--<center|left|right> classes. Integrates with Shortcake.

Usage: [pull-quote align="<center|left|right>"]CONTENT[/pull-quote]

Small Caps

Renders an inline element with a small-caps class.

Usage: [small-caps]CONTENT[/small-caps]

Underline

Renders an inline element with an underline class.

Usage: [u]CONTENT[/u]

Hooks

Filter: shorthand_scripts

Allows plugin and theme developers to filter or turn off the scripts bundled with Shorthand.

The quickest way to disable them completely is by calling add_filter( 'shorthand_scripts', '__return_empty_array' ); at the init step.

It's up to developers to enqueue their own replacement scripts for the frontend as well as Shortcake's live preview.

Parameters

$scripts : (array) Script URLs as (handle, URL) pairs.

$tag : (string) Shortcode tag name.

Filter: shorthand_styles

Allows plugin and theme developers to filter or turn off the stylesheets bundled with Shorthand.

The quickest way to disable them completely is by calling add_filter( 'shorthand_styles', '__return_empty_array' ); at the init step.

It's up to developers to enqueue their own replacement styles for the frontend as well as Shortcake's live preview.

Parameters

$styles : (array) Stylesheet URLs as (handle, URL) pairs.

$tag : (string) Shortcode tag name.

Filter: shorthand_shortcode

Allows plugin and theme developers to filter the output of a shortcode.

Parameters

$output : (string) Shortcode output to filter.

$atts : (array) Shortcode attributes.

$content : (string) Original inner content (for closing shortcodes).

$tag : (string) Shortcode tag.