README

This is a simple library for parsing WordPress shortcodes directly exported from the post_content column of a wp_posts table.

// Export of `post_content`
$source = file_get_contents("example.html");

Shortcode::get_shortcodes($source, "et_pb_text");

Installation

composer require vlw/shortcode

use vlw\Shortcode\Shortcode

How to use

This library can be used in two ways. The first is a WordPress shortcode parser that starts at a given string offset, and the other is a WordPress shortcode resolver that finds all shortcodes with a given name.

Get all shortcodes

The static method Shortcode::get_shortcodes() can be used to resolve all shortcodes of a particular name.

Shortcode::get_shortcodes("<post_content>", "et_pb_text");

This will return an array of Shortcode instances for each et_pb_text shortcode in the provided post_contents.

Shortcode at string offset

Initialize a new Shortcode instance.

// Start parsing a shortcode at string offset 123
new Shortcode("<post_content>", 123);

Primary functions

The following functions and properties are available for any given Shortcode instance:

Shortcode->name

Get the name of the current shortcode

$shortcode->name;
// "et_pb_text"

Shortcode->content

Get the contents of a shortcode (between a opening and closing shortcodes)

$shortcode->content;
// "<p>Hello world</p>"

Shortcode->attribute()

Get the value of a shortcode attribute for a given name

$shortcode->attribute("admin_label");
// "Hello world"