wp-kit/shortcodes

A wp-kit component that handles shortcodes

2.0.4 2020-09-21 19:44 UTC

Requires

• php: >=7.2
• illuminate/view: ^8.0
• wp-kit/integrations: 2.*
• wp-kit/utils: 2.*

MIT

• Creative Little Dots

• wordpress
• OOP
• shortcodes
• themosis
• assely
• wp-kit

README

This is a wp-kit component that handles shortcodes.

This component was built to run within an Illuminate\Container\Container so is perfect for frameworks such as Themosis, Assely and wp-kit/theme.

Often, WordPress developers want an OOP approach to shortcodes, this is exactly what this repo delivers.

Installation

If you're using Themosis, install via Composer in the root of your Themosis installation, otherwise install in your Composer driven theme folder:

composer require "wp-kit/shortcodes"

Setup

Add Service Provider

Just register the service provider and facade in the providers config and theme config:

//inside themosis-theme/resources/config/providers.config.php

return [
    WPKit\Shortcodes\ShortcodeServiceProvider::class
];

Add PRS4 Class Reference (Themosis Only)

Just add the following line to resources/config/loading.config.php in the Themosis theme folder:

'Theme\\Shortcodes\\' => themosis_path('theme.resources').'shortcodes',

Add Config & View File

The recommended method of installing config files for wp-kit components is via wp kit vendor:publish command.

First, install WP CLI, and then install this component, wp kit vendor:publish will automatically be installed with wp-kit/utils, once installed you can run:

wp kit vendor:publish

For more information, please visit wp-kit/utils.

Alternatively, you can place the config file(s), shortcode file(s) and view file(s) in your theme/resources/config, theme/resources/shortcodes and theme/resources/views directories manually.

Usage

Adding Classes

wp-kit\shortcodes comes with a class WPKit\Shortcodes\Shortcode which can be extended by your own shortcode classes which should be added inside resources/shortcodes within the namespace Theme\Shortcodes.

Here is an example Shortcode class.

Adding Views

When you add a shortcode class, be sure to add a template view file within resources\views\shortcodes with the same name as the $tag you have set in the shortcode class.

You may use whatever either twig or php file types. We always recommend twig.

Here is an example view files.

Get Involved

To learn more about how to use wp-kit check out the docs:

View the Docs

Any help is appreciated. The project is open-source and we encourage you to participate. You can contribute to the project in multiple ways by:

• Reporting a bug issue
• Suggesting features
• Sending a pull request with code fix or feature
• Following the project on GitHub
• Sharing the project around your community

For details about contributing to the framework, please check the contribution guide.

Requirements

Wordpress 4+

PHP 5.6+

License

wp-kit/shortcodes is open-sourced software licensed under the MIT License.