Download the PHP package wpsmith/shortcode without Composer
On this page you can find all versions of the php package wpsmith/shortcode. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download wpsmith/shortcode
More information about wpsmith/shortcode
Files in wpsmith/shortcode
Package shortcode
Short Description WordPress shortcode.
License GPL-2.0+
Homepage https://github.com/wpsmith/Shortcode
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package shortcode
WordPress Shortcode Class
This library provides a skeleton to build shortcodes for WordPress.
Description
This library provides the skeleton for:
- Registering the shortcode. If a shortcode exists with the same name, it will automatically remove the shortcode before adding this shortcode.
- Ensuring that scripts/styles are only printed when the shortcode is being used.
- Merging shortcode attributes with default attributes.
The Shortcode Base Class
The shortcode is registered at plugins_loaded hook or immediately upon class instantiation via singleton implementation: MyShortcode::get_instance().
This class checks the following to determine whether a shortcode exists on a page:
- The title
- The content
- The excerpt
- The Widget Title
- The Custom HTML Widget Content
- The Text Widget
- The Text Widget Content
- The Text Widget Content
- The Navigation Menu Link Attributes
- The Navigation Menu Title
Additionally, the class provides a filter wps_shortcode_{}_is_active to further extend checks to determine whether the shortcode exists on a page.
The AjaxShortcode Class
This class extends the Shortcode base class providing additional features:
- Skeleton for registering AJAX calls with checking the ajax refer nonce.
doing_ajax()static function.get_random_string()static function.
Installation
To install via composer:
Otherwise copy the Shortcode (and AjaxShortcode) class(es) to your folder.
Usage
This library is easy to use in two simple steps:
- Extend the class implementing the method
public function shortcode( $atts, $content = null ){}. Note:- Your defaults as defined in
get_defaults()method will already be merged (and also available via$this->atts) - Your script(s)/style(s) as enqueued in
enqueue_scripts()method will already be printed or enqueued.
- Your defaults as defined in
- Instantiate the singleton in your theme/plugin:
MyShortcode::get_instance().
Optionally, you can do the following:
- Implement
register_scripts()method to register your script differently from enqueing your script. This is highly recommended if you are using this within a distributed theme or plugin. - Implement
init()method to do some more initializing when the shortcode is instantiated. - Implement
get_defaults()to set some default parameters to be merged and thus always present.
Examples
You can find these and more examples at Shortcodes.
