Shortcode Ultimate API Overview 0 0

There are some available API of Shortcode Ultimate Joomla are show in below:

addFile()

To add new file in head tag you can use addFile() function.

Example

<?php 
suAsset::addFile('css', 'heading.css', __FUNCTION__);
suAsset::addFile('js', 'heading.js', __FUNCTION__); 
?>

Params

addString()

To add string of css or js in head tag, you can use addString() function.

Example

<?php 
suAsset::addString('css',  '.su-heading { font-size: 10px;}');
suAsset::addString('js',  'jQuery(document).ready(function ($) {});'); 
?>

Params

alert_box()

To add alert you can use alert_box() function.

Example

<?php 
alert_box("alert message", 'warning'); 
?>

Params

get_config()

To get options of shortcode that is showing in window of shortcode and to define shortcode name, desc, icon, type, you can use this get_config() function.

Example

<?php 

static function get_config() {

        return array(
            'name'  => 'New Heading',
            'type'  => 'wrap',
            'group' => 'content',
            'content' => 'Your heading text here',
            'desc'    => "This is new Custom Heading Shortcode.",
            'icon'    => 'h-square',
            'atts'  => array(               

                'size' => array(
                    'type'    => 'slider',
                    'min'     => 7,
                    'max'     => 48,
                    'step'    => 1,
                    'default' => 16,
                    'name'    => 'Size',
                    'desc'    => 'Select Your Font Size from here'
                ),

                'class' => array(
                    'default' => '',
                    'name'    => 'Class',
                    'desc'    => 'If you want to add extra CSS class for this element so type here'
                )
            )
        );
    }
?>

Params

Available Attribute Type(I mean that Return Array => atts => size => type) There are some type that you can use like- slider(for set number that will set by dragging),color(for color selection),icon(for icon selection),select(for certain value select), border(for border assignment),shadow(for shadow), bool(for switch button). Note: if you do not want to use any type(like class attribute). you will get a text box where you can add anything.

get_slides()

To get all article as array you can use get_slides() function.

Example

<?php 
$args = array(
            'source' => 'none',
            'limit' => 20,
            'gallery' => null,
            'type' => '',
            'order' => '',
            'order_by' => 'desc',
            'link' => 'attachment'
        );

$slides = (array) Su_Tools::get_slides($atts);

foreach ((array) $slides as $slide) {

    $image_url = $slide['image'];

    $title = $slide['title'];

    $intro_text = $slide['introtext'];

    $category = $slide['category'];

    $link = $slide['link'];

    $created = $slide['created'];
}
?>

Params

Input Attributes

Get Output Attributes

image_media()

To fix problem of image locate you can use image_media() function.

Example

<?php 
image_media($image_url);
?>

Params

su_char_limit()

To returns the number of character in a string, You can use su_char_limit() function.

Example

<?php 
su_char_limit($str, $limit, $end_char);
?>

Params

su_word_limit()

To returns the number of words in a string, You can use su_word_limit() function.

Example

<?php 
su_word_limit($str, $limit, $end_char);
?>

Params

su_do_shortcode()

To compile shortcode of contents you can use su_do_shortcode() function.

Why need this shortcode:

Suppose, your content can be (a paragraph [spacer size="10"] a paragraph after spacer shortcode.). So you must need to compile this spacer shortcode. so that you can use this shortcode.

Example

<?php 
su_do_shortcode($content);
?>

Params

su_image_resize()

To convert or re-size you can use su_image_resize() function.

Example

<?php
$converted_image_url = su_image_resize( $image_location , $image_width , $image_height, $quality );
?>

Params

Example

<?php 
$atts = su_shortcode_atts(array(
          'size'    => 16,
          'class'   => ''
       ), $atts, 'new_heading');
?>

Params

su_scroll_reveal()

To create  scroll animations of contents, you  may use the function.

Example

<?php 
$atts = su_shortcode_atts(array(
          'scroll_reveal'    => 'wait 0.4s, scale up 25%',
          'class'   => ''
       ), $atts, 'new_heading');

return '<h3' . su_scroll_reveal($atts) . '>'. su_do_shortcode($content) . '</h3>';
?>

Params