ucf / wp-shortcode-interface

Creates a shortcode interface that provides a form for inserting and updating shortcodes.

WP Shortcode Interface

Creates a form that provides the available parameters for defined shortcodes.

Description

Provides an interface for inserting shortcodes into the WordPress WYSIWYG editor. Developers can write supported hooks into their plugins to make their shortcodes available within the interface.

Installation

Manual Installation

1. Upload the plugin files (unzipped) to the /wp-content/plugins directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the "Plugins" screen in WordPress

WP CLI Installation

1. $ wp plugin install --activate https://github.com/UCF/WP-Shortcode-Interface/archive/master.zip. See WP-CLI Docs for more command options.

Changelog

0.2.3

Enhancements:

• Added composer file.

0.2.2

Enhancements:

• Added Github updater support
• Added minimum required PHP version

0.2.1

Bug Fixes:

• Fixed the generated url for a spinner icon used in the admin interface that could cause internal redirect problems.

0.2.0

Enhancements:

• Added ability to assign a shortcode to a group for better organization within the shortcode select dropdown

0.1.0

• Initial prerelease

Upgrade Notice

n/a

Installation Requirements

n/a

Development & Contributing

NOTE: this plugin's readme.md file is automatically generated. Please only make modifications to the readme.txt file, and make sure the gulp readme command has been run before committing readme changes.

wp-shortcode-interface's Issues

Update packages

Plugin needs to be updated to use gulp 4; other packages should be brought up to date to make future development sprints easier to get started with.

Default values for fields

get_field_markup() functions should account for 'default' values passed for each field.

Create Function for Registering Shortcode Configs

To prevent total breakage when the wp_scif_add_shortcode filter is called by an another plugin, instead create a function for adding shortcodes. This function can then validate the incoming configuration and verify it won't break anything, and then add a filter.

Shortcode field options and preview don't load when the plaintext editor is active

Field sanitization

Values from attribute fields in the shortcode interface should be sanitized before being passed pack to TinyMCE to avoid the creation of invalid shortcodes and/or attributes.

For example, when editing the "class" attribute of a button shortcode, if I add a value of " data-bad-attr="something" ", the following is inserted into the WYSIWYG editor:

[button class="" data-bad-attr="something" ""][/button]

Shortcode interface - can't click on label to activate input

Clicking a field label does not properly activate the related input, due to the label's for attribute referencing the input's name instead of its id.

Shortcode interface - shortcode options of type 'checkbox' are added to all shortcodes

Whenever I add a new shortcode using the shortcode interface, fields from other shortcodes will populate into the generated shortcode if the field type is 'checkbox'.

For example, between two available shortcodes:
[foo] with text field name, and
[bar] with checkbox field is_enabled,
If I insert the shortcode [foo] into the wysiwyg, the resulting shortcode looks like:
[foo name="..." is_enabled="false"].

Normalize field options/fix undefined index notices

Ideally, instead of $this->fields being assigned the raw fields array passed to it, the assigned fields array should be normalized and assigned a set of default supported key/value pairs, e.g.

public function __construct( $args ) {
  ...
  $this->fields = $this->normalize_fields( $args['fields'] );
  ...
}

...

public function normalize_fields( $fields ) {
  $normalized = array();
  foreach ( $fields as $field ) {
    $normalized[] = array_merge( array( 'name' => '', 'desc' => '', ... ), $field );
  }
  return $normalized;
}

Doing this would help suppress undefined index notices caused on lines such as this one, where $field['required'] may not have been set in the original fields array passed to the constructor.

Descriptions for 'checkbox' fields are never displayed

Inserted shortcodes don't have closing tags

A shortcode added to the wysiwyg editor from the shortcode interface does not have a closing tag; only the opening tag is inserted. We should always add closing tags to ensure that both self-closing and non-self-closing tags are compatible.