Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Shortcode class

[2] Fix | Delete

[3] Fix | Delete

* @package PUM

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[8] Fix | Delete

exit;

[9] Fix | Delete

}

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Class PUM_Shortcode

[13] Fix | Delete

[14] Fix | Delete

* This is a base class for all popup maker & extension shortcodes.

[15] Fix | Delete

[16] Fix | Delete

abstract class PUM_Shortcode {

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Per instance version for compatibility fixes.

[20] Fix | Delete

[21] Fix | Delete

* @var int

[22] Fix | Delete

[23] Fix | Delete

public $version = 1;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Used to force ajax rendering of the shortcode.

[27] Fix | Delete

[28] Fix | Delete

* @var bool

[29] Fix | Delete

[30] Fix | Delete

public $ajax_rendering = false;

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Shortcode supports inner content.

[34] Fix | Delete

[35] Fix | Delete

* @var bool

[36] Fix | Delete

[37] Fix | Delete

public $has_content = false;

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Section/Tab where the content editor will be placed.

[41] Fix | Delete

[42] Fix | Delete

* @var string

[43] Fix | Delete

[44] Fix | Delete

public $inner_content_section = 'general';

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Field priority of the content editor.

[48] Fix | Delete

[49] Fix | Delete

* @var int

[50] Fix | Delete

[51] Fix | Delete

public $inner_content_priority = 5;

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* @deprecated 1.7.0

[55] Fix | Delete

* @var string

[56] Fix | Delete

[57] Fix | Delete

public $field_prefix = 'attrs';

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* @deprecated 1.7.0

[61] Fix | Delete

* @var string

[62] Fix | Delete

[63] Fix | Delete

public $field_name_format = '{$prefix}[{$field}]';

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Current version used for compatibility fixes.

[67] Fix | Delete

[68] Fix | Delete

* @var int

[69] Fix | Delete

[70] Fix | Delete

public $current_version = 2;

[71] Fix | Delete

[72] Fix | Delete

/**

[73] Fix | Delete

* Class constructor will set the needed filter and action hooks

[74] Fix | Delete

[75] Fix | Delete

* @param array $args

[76] Fix | Delete

[77] Fix | Delete

public function __construct( $args = [] ) {

[78] Fix | Delete

if ( ! did_action( 'init' ) ) {

[79] Fix | Delete

add_action( 'init', [ $this, 'register' ] );

[80] Fix | Delete

} elseif ( ! did_action( 'admin_head' ) && current_action() !== 'init' ) {

[81] Fix | Delete

add_action( 'admin_head', [ $this, 'register' ] );

[82] Fix | Delete

} else {

[83] Fix | Delete

$this->register();

[84] Fix | Delete

}

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Register this shortcode with Shortcode UI & Shortcake.

[89] Fix | Delete

[90] Fix | Delete

public function register() {

[91] Fix | Delete

add_shortcode( $this->tag(), [ $this, 'handler' ] );

[92] Fix | Delete

add_action( 'print_media_templates', [ $this, 'render_template' ] );

[93] Fix | Delete

add_action( 'register_shortcode_ui', [ $this, 'register_shortcode_ui' ] );

[94] Fix | Delete

[95] Fix | Delete

PUM_Shortcodes::instance()->add_shortcode( $this );

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

/**

[99] Fix | Delete

* The shortcode tag.

[100] Fix | Delete

[101] Fix | Delete

abstract public function tag();

[102] Fix | Delete

[103] Fix | Delete

/**

[104] Fix | Delete

* @return mixed

[105] Fix | Delete

[106] Fix | Delete

public static function init() {

[107] Fix | Delete

$class = get_called_class();

[108] Fix | Delete

return new $class();

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* Shortcode handler

[113] Fix | Delete

[114] Fix | Delete

* @param array $atts shortcode attributes

[115] Fix | Delete

* @param string $content shortcode content

[116] Fix | Delete

[117] Fix | Delete

* @return string

[118] Fix | Delete

[119] Fix | Delete

abstract public function handler( $atts, $content = null );

[120] Fix | Delete

[121] Fix | Delete

public function _tabs() {

[122] Fix | Delete

$tabs = $this->version < 2 && method_exists( $this, 'sections' ) ? $this->sections() : $this->tabs();

[123] Fix | Delete

[124] Fix | Delete

return apply_filters( 'pum_shortcode_tabs', $tabs, $this->tag() );

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

public function _subtabs() {

[128] Fix | Delete

$subtabs = $this->version >= 2 && method_exists( $this, 'subtabs' ) ? $this->subtabs() : false;

[129] Fix | Delete

[130] Fix | Delete

foreach ( $this->_tabs() as $tab_id => $tab_label ) {

[131] Fix | Delete

if ( empty( $subtabs[ $tab_id ] ) || ! is_array( $subtabs[ $tab_id ] ) ) {

[132] Fix | Delete

$subtabs[ $tab_id ] = [

[133] Fix | Delete

'main' => $tab_label,

[134] Fix | Delete

];

[135] Fix | Delete

}

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

return apply_filters( 'pum_shortcode_subtabs', $subtabs, $this->tag() );

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

/**

[142] Fix | Delete

* Sections.

[143] Fix | Delete

[144] Fix | Delete

* @deprecated 1.7.0 Use $this->tabs() instead.

[145] Fix | Delete

[146] Fix | Delete

* @todo Once all shortcodes are v2+ remove $this->sections()

[147] Fix | Delete

[148] Fix | Delete

* @return array

[149] Fix | Delete

[150] Fix | Delete

public function sections() {

[151] Fix | Delete

return [

[152] Fix | Delete

'general' => __( 'General', 'popup-maker' ),

[153] Fix | Delete

'options' => __( 'Options', 'popup-maker' ),

[154] Fix | Delete

];

[155] Fix | Delete

}

[156] Fix | Delete

[157] Fix | Delete

/**

[158] Fix | Delete

* Returns a list of tabs for this shortcodes editor.

[159] Fix | Delete

[160] Fix | Delete

* @return array

[161] Fix | Delete

[162] Fix | Delete

public function tabs() {

[163] Fix | Delete

return [

[164] Fix | Delete

'general' => __( 'General', 'popup-maker' ),

[165] Fix | Delete

'options' => __( 'Options', 'popup-maker' ),

[166] Fix | Delete

];

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

/**

[170] Fix | Delete

* Returns a list of tabs for this shortcodes editor.

[171] Fix | Delete

[172] Fix | Delete

* @return array

[173] Fix | Delete

[174] Fix | Delete

public function subtabs() {

[175] Fix | Delete

return [

[176] Fix | Delete

'general' => [

[177] Fix | Delete

'main' => __( 'General', 'popup-maker' ),

[178] Fix | Delete

[179] Fix | Delete

'options' => [

[180] Fix | Delete

'main' => __( 'Options', 'popup-maker' ),

[181] Fix | Delete

[182] Fix | Delete

];

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

/**

[186] Fix | Delete

* Gets preprocessed shortcode attributes.

[187] Fix | Delete

[188] Fix | Delete

* @param $atts

[189] Fix | Delete

[190] Fix | Delete

* @return array

[191] Fix | Delete

[192] Fix | Delete

public function shortcode_atts( $atts ) {

[193] Fix | Delete

if ( ! is_array( $atts ) ) {

[194] Fix | Delete

$atts = [];

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

foreach ( $atts as $key => $value ) {

[198] Fix | Delete

/**

[199] Fix | Delete

* Fix for truthy & value-less arguments such as [shortcode argument]

[200] Fix | Delete

[201] Fix | Delete

if ( is_int( $key ) ) {

[202] Fix | Delete

unset( $atts[ $key ] );

[203] Fix | Delete

$atts[ $value ] = true;

[204] Fix | Delete

}

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete

return shortcode_atts( $this->defaults(), $atts, $this->tag() );

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

/**

[211] Fix | Delete

* Array of default attribute values.

[212] Fix | Delete

[213] Fix | Delete

* @todo Convert this to pull from the std of $this->fields.

[214] Fix | Delete

[215] Fix | Delete

* @return array

[216] Fix | Delete

[217] Fix | Delete

public function defaults() {

[218] Fix | Delete

$defaults = [];

[219] Fix | Delete

[220] Fix | Delete

$fields = PUM_Admin_Helpers::flatten_fields_array( $this->fields() );

[221] Fix | Delete

[222] Fix | Delete

foreach ( $fields as $key => $field ) {

[223] Fix | Delete

$defaults[ $key ] = isset( $field['std'] ) ? $field['std'] : null;

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

return apply_filters( 'pum_shortcode_defaults', $defaults, $this );

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

/**

[230] Fix | Delete

* Render the template based on shortcode classes methods.

[231] Fix | Delete

[232] Fix | Delete

public function render_template() {

[233] Fix | Delete

if ( $this->version >= 2 && $this->get_template() !== false ) {

[234] Fix | Delete

echo '<script type="text/html" id="tmpl-pum-shortcode-view-' . $this->tag() . '">';

[235] Fix | Delete

$this->style_block();

[236] Fix | Delete

$this->template();

[237] Fix | Delete

echo '</script>';

[238] Fix | Delete

} else {

[239] Fix | Delete

/** @deprecated, here in case shortcode doesn't yet have the new $this->template() method. */

[240] Fix | Delete

$this->_template();

[241] Fix | Delete

}

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

/**

[245] Fix | Delete

* Returns the inner contents of the JS templates.

[246] Fix | Delete

[247] Fix | Delete

* @todo Once all shortcodes have been updated to use template over _template make this abstract.

[248] Fix | Delete

[249] Fix | Delete

* @return bool|string

[250] Fix | Delete

[251] Fix | Delete

public function template() {

[252] Fix | Delete

return false;

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Render the template based on shortcode classes methods.

[257] Fix | Delete

[258] Fix | Delete

public function style_block() {

[259] Fix | Delete

$styles = $this->get_template_styles();

[260] Fix | Delete

[261] Fix | Delete

if ( false !== $styles ) {

[262] Fix | Delete

echo '<style>' . $styles . '</style>';

[263] Fix | Delete

}

[264] Fix | Delete

}

[265] Fix | Delete

[266] Fix | Delete

/**

[267] Fix | Delete

* @deprecated 1.7.0 Use template() instead.

[268] Fix | Delete

[269] Fix | Delete

public function _template() {

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

/**

[273] Fix | Delete

* Render the template based on shortcode classes methods.

[274] Fix | Delete

[275] Fix | Delete

* @return string|false

[276] Fix | Delete

[277] Fix | Delete

public function get_template_styles() {

[278] Fix | Delete

[279] Fix | Delete

ob_start();

[280] Fix | Delete

[281] Fix | Delete

$this->template_styles();

[282] Fix | Delete

[283] Fix | Delete

/** $this->_template_styles() is @deprecated and here in case shortcode doesn't yet have the new $this->template() method. */

[284] Fix | Delete

echo $this->_template_styles();

[285] Fix | Delete

[286] Fix | Delete

$styles = ob_get_clean();

[287] Fix | Delete

[288] Fix | Delete

return ! empty( $styles ) ? $styles : false;

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete

/**

[292] Fix | Delete

* Returns the styles for inner contents of the JS templates.

[293] Fix | Delete

[294] Fix | Delete

* @todo Once all shortcodes have been updated to use template over _template make this abstract.

[295] Fix | Delete

[296] Fix | Delete

public function template_styles() {}

[297] Fix | Delete

[298] Fix | Delete

/**

[299] Fix | Delete

* @deprecated 1.7.0 use template_styles() instead.

[300] Fix | Delete

[301] Fix | Delete

* @return string

[302] Fix | Delete

[303] Fix | Delete

public function _template_styles() {

[304] Fix | Delete

return '';

[305] Fix | Delete

}

[306] Fix | Delete

[307] Fix | Delete

/**

[308] Fix | Delete

* Returns the inner contents of the JS templates.

[309] Fix | Delete

[310] Fix | Delete

* @todo Once all shortcodes have been updated to use template over _template make this abstract.

[311] Fix | Delete

[312] Fix | Delete

* @return bool|string

[313] Fix | Delete

[314] Fix | Delete

public function get_template() {

[315] Fix | Delete

ob_start();

[316] Fix | Delete

[317] Fix | Delete

$this->template();

[318] Fix | Delete

[319] Fix | Delete

$template = ob_get_clean();

[320] Fix | Delete

[321] Fix | Delete

return ! empty( $template ) ? $template : false;

[322] Fix | Delete

}

[323] Fix | Delete

[324] Fix | Delete

/**

[325] Fix | Delete

* Register this shortcode in shortcake ui.

[326] Fix | Delete

[327] Fix | Delete

public function register_shortcode_ui() {

[328] Fix | Delete

[329] Fix | Delete

if ( ! is_admin() || ! function_exists( 'shortcode_ui_register_for_shortcode' ) ) {

[330] Fix | Delete

return;

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

$shortcode_ui_args = [

[334] Fix | Delete

'label' => $this->label(),

[335] Fix | Delete

'listItemImage' => $this->icon(),

[336] Fix | Delete

'post_type' => apply_filters( 'pum_shortcode_post_types', $this->post_types(), $this ),

[337] Fix | Delete

'attrs' => [],

[338] Fix | Delete

];

[339] Fix | Delete

[340] Fix | Delete

/**

[341] Fix | Delete

* Register UI for the "inner content" of the shortcode. Optional.

[342] Fix | Delete

* If no UI is registered for the inner content, then any inner content

[343] Fix | Delete

* data present will be backed up during editing.

[344] Fix | Delete

[345] Fix | Delete

if ( $this->has_content ) {

[346] Fix | Delete

$shortcode_ui_args['inner_content'] = $this->inner_content_labels();

[347] Fix | Delete

}

[348] Fix | Delete

[349] Fix | Delete

$fields = PUM_Admin_Helpers::flatten_fields_array( $this->_fields() );

[350] Fix | Delete

[351] Fix | Delete

if ( count( $fields ) ) {

[352] Fix | Delete

foreach ( $fields as $field_id => $field ) {

[353] Fix | Delete

[354] Fix | Delete

// Don't register inner content fields.

[355] Fix | Delete

if ( '_inner_content' === $field_id ) {

[356] Fix | Delete

continue;

[357] Fix | Delete

}

[358] Fix | Delete

[359] Fix | Delete

// text, checkbox, textarea, radio, select, email, url, number, date, attachment, color, post_select

[360] Fix | Delete

switch ( $field['type'] ) {

[361] Fix | Delete

case 'select':

[362] Fix | Delete

$shortcode_ui_args['attrs'][] = [

[363] Fix | Delete

'label' => esc_html( $field['label'] ),

[364] Fix | Delete

'attr' => $field_id,

[365] Fix | Delete

'type' => 'select',

[366] Fix | Delete

'options' => $field['options'],

[367] Fix | Delete

];

[368] Fix | Delete

break;

[369] Fix | Delete

[370] Fix | Delete

case 'postselect':

[371] Fix | Delete

case 'objectselect':

[372] Fix | Delete

if ( empty( $field['post_type'] ) ) {

[373] Fix | Delete

break;

[374] Fix | Delete

}

[375] Fix | Delete

$shortcode_ui_args['attrs'][] = [

[376] Fix | Delete

'label' => esc_html( $field['label'] ),

[377] Fix | Delete

'attr' => $field_id,

[378] Fix | Delete

'type' => 'post_select',

[379] Fix | Delete

'options' => isset( $field['options'] ) ? $field['options'] : [],

[380] Fix | Delete

'query' => [ 'post_type' => $field['post_type'] ],

[381] Fix | Delete

];

[382] Fix | Delete

break;

[383] Fix | Delete

[384] Fix | Delete

case 'taxonomyselect':

[385] Fix | Delete

break;

[386] Fix | Delete

[387] Fix | Delete

case 'text';

[388] Fix | Delete

default:

[389] Fix | Delete

$shortcode_ui_args['attrs'][] = [

[390] Fix | Delete

'label' => $field['label'],

[391] Fix | Delete

'attr' => $field_id,

[392] Fix | Delete

'type' => 'text',

[393] Fix | Delete

'value' => ! empty( $field['std'] ) ? $field['std'] : '',

[394] Fix | Delete

// 'encode' => true,

[395] Fix | Delete

'meta' => [

[396] Fix | Delete

'placeholder' => $field['placeholder'],

[397] Fix | Delete

[398] Fix | Delete

];

[399] Fix | Delete

break;

[400] Fix | Delete

}

[401] Fix | Delete

}

[402] Fix | Delete

}

[403] Fix | Delete

[404] Fix | Delete

/**

[405] Fix | Delete

* Register UI for your shortcode

[406] Fix | Delete

[407] Fix | Delete

* @param string $shortcode_tag

[408] Fix | Delete

* @param array $ui_args

[409] Fix | Delete

[410] Fix | Delete

shortcode_ui_register_for_shortcode( $this->tag(), $shortcode_ui_args );

[411] Fix | Delete

}

[412] Fix | Delete

[413] Fix | Delete

/**

[414] Fix | Delete

* How the shortcode should be labeled in the UI. Required argument.

[415] Fix | Delete

[416] Fix | Delete

* @return string

[417] Fix | Delete

[418] Fix | Delete

abstract public function label();

[419] Fix | Delete

[420] Fix | Delete

/**

[421] Fix | Delete

* Include an icon with your shortcode. Optional.

[422] Fix | Delete

* Use a dashicon, or full URL to image.

[423] Fix | Delete

[424] Fix | Delete

* Only used by Shortcake

[425] Fix | Delete

[426] Fix | Delete

* @return string

[427] Fix | Delete

[428] Fix | Delete

public function icon() {

[429] Fix | Delete

return 'dashicons-editor-quote';

[430] Fix | Delete

}

[431] Fix | Delete

[432] Fix | Delete

/**

[433] Fix | Delete

* Limit this shortcode UI to specific post_types. Optional.

[434] Fix | Delete

[435] Fix | Delete

* @return array

[436] Fix | Delete

[437] Fix | Delete

public function post_types() {

[438] Fix | Delete

return [ 'post', 'page', 'popup' ];

[439] Fix | Delete

}

[440] Fix | Delete

[441] Fix | Delete

/**

[442] Fix | Delete

* @todo Remove the inner function calls and just have this function define them directly.

[443] Fix | Delete

[444] Fix | Delete

* @return array

[445] Fix | Delete

[446] Fix | Delete

public function inner_content_labels() {

[447] Fix | Delete

return [

[448] Fix | Delete

'label' => $this->label(),

[449] Fix | Delete

'description' => $this->description(),

[450] Fix | Delete

];

[451] Fix | Delete

}

[452] Fix | Delete

[453] Fix | Delete

/**

[454] Fix | Delete

* Used internally to merge the inner content field with existing fields.

[455] Fix | Delete

[456] Fix | Delete

* @return array

[457] Fix | Delete

[458] Fix | Delete

public function _fields() {

[459] Fix | Delete

$fields = apply_filters( 'pum_shortcode_fields', $this->fields(), $this );

[460] Fix | Delete

[461] Fix | Delete

if ( $this->has_content ) {

[462] Fix | Delete

$inner_content_labels = $this->inner_content_labels();

[463] Fix | Delete

[464] Fix | Delete

$fields[ $this->inner_content_section ]['main']['_inner_content'] = [

[465] Fix | Delete

'label' => $inner_content_labels['label'],

[466] Fix | Delete

'desc' => $inner_content_labels['description'],

[467] Fix | Delete

'section' => $this->inner_content_section,

[468] Fix | Delete

'type' => 'textarea',

[469] Fix | Delete

'priority' => $this->inner_content_priority,

[470] Fix | Delete

];

[471] Fix | Delete

}

[472] Fix | Delete

[473] Fix | Delete

$fields = PUM_Admin_Helpers::parse_tab_fields(

[474] Fix | Delete

$fields,

[475] Fix | Delete

[

[476] Fix | Delete

'has_subtabs' => $this->version >= 2,

[477] Fix | Delete

'name' => 'attrs[%s]',

[478] Fix | Delete

]

[479] Fix | Delete

);

[480] Fix | Delete

[481] Fix | Delete

if ( $this->version < 2 ) {

[482] Fix | Delete

foreach ( $fields as $tab_id => $tab_fields ) {

[483] Fix | Delete

foreach ( $tab_fields as $field_id => $field ) {

[484] Fix | Delete

/**

[485] Fix | Delete

* Apply field compatibility fixes for shortcodes still on v1.

[486] Fix | Delete

[487] Fix | Delete

if ( ! empty( $field['type'] ) && in_array( $field['type'], [ 'select', 'postselect', 'radio', 'multicheck' ] ) ) {

[488] Fix | Delete

$fields[ $tab_id ][ $field_id ]['options'] = ! empty( $field['options'] ) ? array_flip( $field['options'] ) : [];

[489] Fix | Delete

}

[490] Fix | Delete

}

[491] Fix | Delete

}

[492] Fix | Delete

}

[493] Fix | Delete

[494] Fix | Delete

return $fields;

[495] Fix | Delete

}

[496] Fix | Delete

[497] Fix | Delete

/**

[498] Fix | Delete

* @return string

[499] Fix | Delete