CMB2 Documentation
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  • Hooks
  • Download Docs
  • Github

Packages

  • CMB2
  • Demo
    • CMB2
  • None
  • Tests
    • CMB2

Classes

  • CMB2
  • CMB2_Ajax
  • CMB2_Base
  • CMB2_Bootstrap_2101
  • CMB2_Boxes
  • CMB2_Display_Checkbox
  • CMB2_Display_Colorpicker
  • CMB2_Display_File
  • CMB2_Display_File_List
  • CMB2_Display_Multicheck
  • CMB2_Display_oEmbed
  • CMB2_Display_Select
  • CMB2_Display_Taxonomy_Multicheck
  • CMB2_Display_Taxonomy_Radio
  • CMB2_Display_Text_Date
  • CMB2_Display_Text_Date_Timezone
  • CMB2_Display_Text_Money
  • CMB2_Display_Text_Time
  • CMB2_Display_Text_Url
  • CMB2_Display_Textarea
  • CMB2_Display_Textarea_Code
  • CMB2_Field
  • CMB2_Field_Display
  • CMB2_Hookup
  • CMB2_Hookup_Base
  • CMB2_Integration_Box
  • CMB2_JS
  • CMB2_Option
  • CMB2_Options
  • CMB2_Options_Hookup
  • CMB2_REST
  • CMB2_REST_Controller
  • CMB2_REST_Controller_Boxes
  • CMB2_REST_Controller_Fields
  • CMB2_Sanitize
  • CMB2_Show_Filters
  • CMB2_Type_Base
  • CMB2_Type_Checkbox
  • CMB2_Type_Colorpicker
  • CMB2_Type_Counter_Base
  • CMB2_Type_File
  • CMB2_Type_File_Base
  • CMB2_Type_File_List
  • CMB2_Type_Multi_Base
  • CMB2_Type_Multicheck
  • CMB2_Type_Oembed
  • CMB2_Type_Picker_Base
  • CMB2_Type_Radio
  • CMB2_Type_Select
  • CMB2_Type_Select_Timezone
  • CMB2_Type_Taxonomy_Base
  • CMB2_Type_Taxonomy_Multicheck
  • CMB2_Type_Taxonomy_Multicheck_Hierarchical
  • CMB2_Type_Taxonomy_Radio
  • CMB2_Type_Taxonomy_Radio_Hierarchical
  • CMB2_Type_Taxonomy_Select
  • CMB2_Type_Taxonomy_Select_Hierarchical
  • CMB2_Type_Text
  • CMB2_Type_Text_Date
  • CMB2_Type_Text_Datetime_Timestamp
  • CMB2_Type_Text_Datetime_Timestamp_Timezone
  • CMB2_Type_Text_Time
  • CMB2_Type_Textarea
  • CMB2_Type_Textarea_Code
  • CMB2_Type_Title
  • CMB2_Type_Wysiwyg
  • CMB2_Types
  • CMB2_Utils

Hooks

  • Hook Reference
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 
<?php
/**
 * Handles the dependencies and enqueueing of the CMB2 JS scripts
 *
 * @category  WordPress_Plugin
 * @package   CMB2
 * @author    CMB2 team
 * @license   GPL-2.0+
 * @link      https://cmb2.io
 */
class CMB2_JS {

    /**
     * The CMB2 JS handle
     *
     * @var   string
     * @since 2.0.7
     */
    protected static $handle = 'cmb2-scripts';

    /**
     * The CMB2 JS variable name
     *
     * @var   string
     * @since 2.0.7
     */
    protected static $js_variable = 'cmb2_l10';

    /**
     * Array of CMB2 JS dependencies
     *
     * @var   array
     * @since 2.0.7
     */
    protected static $dependencies = array(
        'jquery' => 'jquery',
    );

    /**
     * Array of CMB2 fields model data for JS.
     *
     * @var   array
     * @since 2.4.0
     */
    protected static $fields = array();

    /**
     * Add a dependency to the array of CMB2 JS dependencies
     *
     * @since 2.0.7
     * @param array|string $dependencies Array (or string) of dependencies to add.
     */
    public static function add_dependencies( $dependencies ) {
        foreach ( (array) $dependencies as $dependency ) {
            self::$dependencies[ $dependency ] = $dependency;
        }
    }

    /**
     * Add field model data to the array for JS.
     *
     * @since 2.4.0
     *
     * @param CMB2_Field $field Field object.
     */
    public static function add_field_data( CMB2_Field $field ) {
        $hash = $field->hash_id();
        if ( ! isset( self::$fields[ $hash ] ) ) {
            self::$fields[ $hash ] = $field->js_data();
        }
    }

    /**
     * Enqueue the CMB2 JS
     *
     * @since  2.0.7
     */
    public static function enqueue() {
        // Filter required script dependencies.
        $dependencies = self::$dependencies = apply_filters( 'cmb2_script_dependencies', self::$dependencies );

        // Only use minified files if SCRIPT_DEBUG is off.
        $debug = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG;

        $min = $debug ? '' : '.min';

        // if colorpicker.
        if ( isset( $dependencies['wp-color-picker'] ) ) {
            if ( ! is_admin() ) {
                self::colorpicker_frontend();
            }

            // Enqueue colorpicker
            if ( ! wp_script_is( 'wp-color-picker', 'enqueued' ) ) {
                wp_enqueue_script( 'wp-color-picker' );
            }

            if ( isset( $dependencies['wp-color-picker-alpha'] ) ) {
                self::register_colorpicker_alpha();
            }
        }

        // if file/file_list.
        if ( isset( $dependencies['media-editor'] ) ) {
            wp_enqueue_media();
            CMB2_Type_File_Base::output_js_underscore_templates();
        }

        // if timepicker.
        if ( isset( $dependencies['jquery-ui-datetimepicker'] ) ) {
            self::register_datetimepicker();
        }

        // if cmb2-wysiwyg.
        $enqueue_wysiwyg = isset( $dependencies['cmb2-wysiwyg'] ) && $debug;
        unset( $dependencies['cmb2-wysiwyg'] );

        // if cmb2-char-counter.
        $enqueue_char_counter = isset( $dependencies['cmb2-char-counter'] ) && $debug;
        unset( $dependencies['cmb2-char-counter'] );

        // Enqueue cmb JS.
        wp_enqueue_script( self::$handle, CMB2_Utils::url( "js/cmb2{$min}.js" ), array_values( $dependencies ), CMB2_VERSION, true );

        // if SCRIPT_DEBUG, we need to enqueue separately.
        if ( $enqueue_wysiwyg ) {
            wp_enqueue_script( 'cmb2-wysiwyg', CMB2_Utils::url( 'js/cmb2-wysiwyg.js' ), array( 'jquery', 'wp-util' ), CMB2_VERSION );
        }
        if ( $enqueue_char_counter ) {
            wp_enqueue_script( 'cmb2-char-counter', CMB2_Utils::url( 'js/cmb2-char-counter.js' ), array( 'jquery', 'wp-util' ), CMB2_VERSION );
        }

        self::localize( $debug );

        do_action( 'cmb2_footer_enqueue' );
    }

    /**
     * Register or enqueue the wp-color-picker-alpha script.
     *
     * @since  2.2.7
     *
     * @param  boolean $enqueue Whether or not to enqueue.
     *
     * @return void
     */
    public static function register_colorpicker_alpha( $enqueue = false ) {
        // Only use minified files if SCRIPT_DEBUG is off.
        $min = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
        $func = $enqueue ? 'wp_enqueue_script' : 'wp_register_script';
        $func( 'wp-color-picker-alpha', CMB2_Utils::url( "js/wp-color-picker-alpha{$min}.js" ), array( 'wp-color-picker' ), '2.1.3' );
    }

    /**
     * Register or enqueue the jquery-ui-datetimepicker script.
     *
     * @since  2.2.7
     *
     * @param  boolean $enqueue Whether or not to enqueue.
     *
     * @return void
     */
    public static function register_datetimepicker( $enqueue = false ) {
        $func = $enqueue ? 'wp_enqueue_script' : 'wp_register_script';
        $func( 'jquery-ui-datetimepicker', CMB2_Utils::url( 'js/jquery-ui-timepicker-addon.min.js' ), array( 'jquery-ui-slider' ), '1.5.0' );
    }

    /**
     * We need to register colorpicker on the front-end
     *
     * @since  2.0.7
     */
    protected static function colorpicker_frontend() {
        wp_register_script( 'iris', admin_url( 'js/iris.min.js' ), array( 'jquery-ui-draggable', 'jquery-ui-slider', 'jquery-touch-punch' ), CMB2_VERSION );
        wp_register_script( 'wp-color-picker', admin_url( 'js/color-picker.min.js' ), array( 'iris' ), CMB2_VERSION );
        wp_localize_script( 'wp-color-picker', 'wpColorPickerL10n', array(
            'clear'         => esc_html__( 'Clear', 'cmb2' ),
            'defaultString' => esc_html__( 'Default', 'cmb2' ),
            'pick'          => esc_html__( 'Select Color', 'cmb2' ),
            'current'       => esc_html__( 'Current Color', 'cmb2' ),
        ) );
    }

    /**
     * Localize the php variables for CMB2 JS
     *
     * @since  2.0.7
     *
     * @param mixed $debug Whether or not we are debugging.
     */
    protected static function localize( $debug ) {
        static $localized = false;
        if ( $localized ) {
            return;
        }

        $localized = true;
        $l10n = array(
            'fields'            => self::$fields,
            'ajax_nonce'        => wp_create_nonce( 'ajax_nonce' ),
            'ajaxurl'           => admin_url( '/admin-ajax.php' ),
            'script_debug'      => $debug,
            'up_arrow_class'    => 'dashicons dashicons-arrow-up-alt2',
            'down_arrow_class'  => 'dashicons dashicons-arrow-down-alt2',
            'user_can_richedit' => user_can_richedit(),
            'defaults'          => array(
                'code_editor'  => false,
                'color_picker' => false,
                'date_picker'  => array(
                    'changeMonth'     => true,
                    'changeYear'      => true,
                    'dateFormat'      => _x( 'mm/dd/yy', 'Valid formatDate string for jquery-ui datepicker', 'cmb2' ),
                    'dayNames'        => explode( ',', esc_html__( 'Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday', 'cmb2' ) ),
                    'dayNamesMin'     => explode( ',', esc_html__( 'Su, Mo, Tu, We, Th, Fr, Sa', 'cmb2' ) ),
                    'dayNamesShort'   => explode( ',', esc_html__( 'Sun, Mon, Tue, Wed, Thu, Fri, Sat', 'cmb2' ) ),
                    'monthNames'      => explode( ',', esc_html__( 'January, February, March, April, May, June, July, August, September, October, November, December', 'cmb2' ) ),
                    'monthNamesShort' => explode( ',', esc_html__( 'Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec', 'cmb2' ) ),
                    'nextText'        => esc_html__( 'Next', 'cmb2' ),
                    'prevText'        => esc_html__( 'Prev', 'cmb2' ),
                    'currentText'     => esc_html__( 'Today', 'cmb2' ),
                    'closeText'       => esc_html__( 'Done', 'cmb2' ),
                    'clearText'       => esc_html__( 'Clear', 'cmb2' ),
                ),
                'time_picker'  => array(
                    'timeOnlyTitle' => esc_html__( 'Choose Time', 'cmb2' ),
                    'timeText'      => esc_html__( 'Time', 'cmb2' ),
                    'hourText'      => esc_html__( 'Hour', 'cmb2' ),
                    'minuteText'    => esc_html__( 'Minute', 'cmb2' ),
                    'secondText'    => esc_html__( 'Second', 'cmb2' ),
                    'currentText'   => esc_html__( 'Now', 'cmb2' ),
                    'closeText'     => esc_html__( 'Done', 'cmb2' ),
                    'timeFormat'    => _x( 'hh:mm TT', 'Valid formatting string, as per http://trentrichardson.com/examples/timepicker/', 'cmb2' ),
                    'controlType'   => 'select',
                    'stepMinute'    => 5,
                ),
            ),
            'strings' => array(
                'upload_file'  => esc_html__( 'Use this file', 'cmb2' ),
                'upload_files' => esc_html__( 'Use these files', 'cmb2' ),
                'remove_image' => esc_html__( 'Remove Image', 'cmb2' ),
                'remove_file'  => esc_html__( 'Remove', 'cmb2' ),
                'file'         => esc_html__( 'File:', 'cmb2' ),
                'download'     => esc_html__( 'Download', 'cmb2' ),
                'check_toggle' => esc_html__( 'Select / Deselect All', 'cmb2' ),
            ),
        );

        if ( isset( self::$dependencies['code-editor'] ) && function_exists( 'wp_enqueue_code_editor' ) ) {
            $l10n['defaults']['code_editor'] = wp_enqueue_code_editor( array(
                'type' => 'text/html',
            ) );
        }

        wp_localize_script( self::$handle, self::$js_variable, apply_filters( 'cmb2_localized_data', $l10n ) );
    }

}
CMB2 Documentation API documentation generated by ApiGen