PHP Класс Shortcode_Button

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$_index
$args
$button_data
$buttons_data
$dir
$enqueued
$handle
$index
$scripts_url

Открытые методы

Метод Описание
__construct ( string $button_slug, array $js_button_data, array $args = [] ) Button name
__get ( string $property ) : mixed Magic getter for our object.
add_button ( $plugin_array ) and tell tinymce where it lives
add_modal_form ( ) Include our button form in a modal
add_quicktag_button_script ( ) Enqueue our quicktag/general purpose button script, and localize our button data
ajax_parse_shortcode ( ) Parse shortcode for display within a TinyMCE view.
button_init ( ) Hook our buttons in to tinymce
do_cmb_form ( ) Use CMB2 cmb2_metabox_form to output form display
filter_form_fields ( $updated, $allvalues = [] ) : array Pass values through a variable filter hook before sending back to JS "{$button_slug}_shortcode_fields"
form_callback ( ) : mixed Check button data for form dislay callback
get_cmb_config ( ) : mixed Get the cmb config array from button args
get_cmb_object ( ) : mixed Use the passed-in CMB2 form args to retrieve a CMB2 object
hooks ( ) Hook it all in. non-ajax hooks check for a conditional callback
process_cmb_form ( array $fields ) CMB2 form processing.
process_form ( ) Ajax form processing.
register_button ( $buttons ) register it with tinymce
sanitize_cmb_fields ( array $fields ) : array Uses CMB2 field processing to sanitize fields (Only applies if cmb_metabox_config parameter exists)
send_json_success ( $send )
url ( string $path = '' ) : string Get script url

Описание методов

__construct() публичный Метод

Button name
С версии: 0.1.0
public __construct ( string $button_slug, array $js_button_data, array $args = [] )
$button_slug string Button name/slug
$js_button_data array Button arguments passed to Javascript
$args array (optional) Override arguments

__get() публичный Метод

Magic getter for our object.
С версии: 0.1.0
public __get ( string $property ) : mixed
$property string Object property to retrieve
Результат mixed

add_button() публичный Метод

and tell tinymce where it lives
public add_button ( $plugin_array )

add_modal_form() публичный Метод

Include our button form in a modal
С версии: 0.1.0
public add_modal_form ( )

add_quicktag_button_script() публичный статический Метод

Enqueue our quicktag/general purpose button script, and localize our button data
С версии: 0.1.0
public static add_quicktag_button_script ( )

ajax_parse_shortcode() публичный статический Метод

Parse shortcode for display within a TinyMCE view.
public static ajax_parse_shortcode ( )

button_init() публичный Метод

Hook our buttons in to tinymce
С версии: 0.1.0
public button_init ( )

do_cmb_form() публичный Метод

Only applies if cmb_metabox_config parameter exists. CMB2 must be included prior to running this script.
С версии: 0.1.0
public do_cmb_form ( )

filter_form_fields() публичный Метод

Pass values through a variable filter hook before sending back to JS "{$button_slug}_shortcode_fields"
С версии: 0.1.0
public filter_form_fields ( $updated, $allvalues = [] ) : array
Результат array Filtered field values

form_callback() публичный Метод

Check button data for form dislay callback
С версии: 0.1.0
public form_callback ( ) : mixed
Результат mixed Form display callback (or false)

get_cmb_config() публичный Метод

Get the cmb config array from button args
С версии: 0.1.0
public get_cmb_config ( ) : mixed
Результат mixed CMB2 form args (or false)

get_cmb_object() публичный Метод

Use the passed-in CMB2 form args to retrieve a CMB2 object
С версии: 0.1.0
public get_cmb_object ( ) : mixed
Результат mixed Returns a CMB2 object or null;

hooks() публичный Метод

Hook it all in. non-ajax hooks check for a conditional callback
С версии: 0.1.0
public hooks ( )

process_cmb_form() публичный Метод

(Only applies if cmb_metabox_config parameter exists)
С версии: 0.1.0
public process_cmb_form ( array $fields )
$fields array Field values to process

process_form() публичный Метод

Uses dynamic filter before returning: "{$button_slug}_shortcode_fields"
С версии: 0.1.0
public process_form ( )

register_button() публичный Метод

register it with tinymce
public register_button ( $buttons )

sanitize_cmb_fields() публичный Метод

Uses CMB2 field processing to sanitize fields (Only applies if cmb_metabox_config parameter exists)
С версии: 0.1.0
public sanitize_cmb_fields ( array $fields ) : array
$fields array Field values to sanitize
Результат array Array of sanitized fields

send_json_success() публичный статический Метод

public static send_json_success ( $send )

url() публичный статический Метод

Get script url
С версии: 0.1.0
public static url ( string $path = '' ) : string
$path string Path to append to url
Результат string Script url plus path if passed in

Описание свойств

$_index защищенное статическое свойство

protected static $_index

$args защищенное свойство

protected $args

$button_data защищенное свойство

protected $button_data

$buttons_data защищенное статическое свойство

protected static $buttons_data

$dir защищенное статическое свойство

protected static $dir

$enqueued защищенное статическое свойство

protected static $enqueued

$handle защищенное статическое свойство

protected static $handle

$index защищенное свойство

protected $index

$scripts_url защищенное статическое свойство

protected static $scripts_url