Download the PHP package tehwave/laravel-shortcodes without Composer
On this page you can find all versions of the php package tehwave/laravel-shortcodes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tehwave/laravel-shortcodes
More information about tehwave/laravel-shortcodes
Files in tehwave/laravel-shortcodes
Package laravel-shortcodes
Short Description Simple, elegant WordPress-like Shortcodes the Laravel way
License MIT
Homepage https://github.com/tehwave/laravel-shortcodes
Informations about the package laravel-shortcodes
Laravel Shortcodes
Simple, elegant WordPress-like Shortcodes the Laravel way.
Requirements
The package has been developed and tested to work with the latest versions of PHP and Laravel as well as the following minimum requirements:
- Laravel 6
- PHP 7.2
Installation
Install the package via Composer.
Usage
Laravel Shortcodes
work much like Wordpress' Shortcode API.
Creating Shortcodes
Run the following command to place a fresh Shortcode
class in your new app/Shortcodes
directory.
Output
Each Shortcode
class contains a handle
method, that you may use to output into the compiling content.
Within the handle
method, you may access the attributes
and body
properties.
Note: All values in the
attributes
array are casted tostring
type when parsed.
Naming
The shortcode's tag is derived from the class name to snake_case.
You may specify a custom tag using the tag
property or by overwriting the getTag
method.
Shortcode tags must be alpha-numeric characters and may include underscores.
Compiling Shortcodes
Run a string through the compiler to parse all shortcodes.
You may specify a list of instantiated Shortcode
classes to limit what shortcodes are parsed.
Example
I developed Laravel Shortcodes
for use with user provided content on gm48.net.
The content is parsed using a Markdown converter called Parsedown, and because users can't be trusted, the content has to be escaped.
Unfortunately, this escapes the attribute syntax with double quotes, but singular quotes can still be used as well as just omitting any quotes.
Note: Quotes are required for any attribute values that contain whitespace.
Let's take a look at the following content with some basic Row
, Column
and Image
shortcodes.
When running the content through the following code:
We can expect to see the following output:
You should still escape any user input within your shortcodes' handle
.
Tests
Run the following command to test the package.
Security
For any security related issues, send a mail to peterchrjoergensen+shortcodes@gmail.com instead of using the issue tracker.
Changelog
See CHANGELOG for details on what has changed.
Contributions
See CONTRIBUTING for details on how to contribute.
Credits
- Peter Jørgensen
- All Contributors
Inspired by https://github.com/webwizo/laravel-shortcodes and https://github.com/spatie/laravel-blade-x
About
I work as a Web Developer in Denmark on Laravel and WordPress websites.
Follow me @tehwave on Twitter!
License
MIT License
All versions of laravel-shortcodes with dependencies
illuminate/console Version ^6.0|^7.0|^8.0|^9.0|^10.0
illuminate/support Version ^6.0|^7.0|^8.0|^9.0|^10.0