- ';
+ echo '
- ', $this->_display(), ' '; - ; + echo '
- ', $this->_display(), ' ';; } echo '
- '+
- '
'+ - ''+ - ''+ - '
';
-
- } else {
- // Standard generic output if it's not an image.
- uploadStatus = ' - '+ l10n.strings.file +' '+ this.filename +' ('+ l10n.strings.download +' / '+ l10n.strings.remove_file +')'+ - ''+ - ' '; - - } - - // Add our file to our fileGroup array - fileGroup.push( uploadStatus ); - }); - - if ( ! returnIt ) { - // Append each item from our fileGroup array to .cmb2-media-status - $( fileGroup ).each( function() { - media.$field.siblings('.cmb2-media-status').slideDown().append(this); - }); - } else { - return fileGroup; - } - - }; - - cmb.mediaHandlers.single = function( selection ) { - // Only get one file from the uploader - attachment = selection.first().toJSON(); - - media.$field.val(attachment.url); - $id( media.field +'_id' ).val(attachment.id); - - if ( attachment.type && attachment.type === 'image' ) { - // image preview - var width = media.previewSize[0] ? media.previewSize[0] : 350; - uploadStatus = ''; - } else { - // Standard generic output if it's not an image. - uploadStatus = '
- ' +
+ '';
+
+ } else {
+ // Standard generic output if it's not an image.
+ uploadStatus = '
- ' + l10n.strings.file + ' ' + this.filename + ' (' + l10n.strings.download + ' / ' + l10n.strings.remove_file + ')' + + '' + + ' '; + + } + + // Add our file to our fileGroup array + fileGroup.push(uploadStatus); + }); + + if (!returnIt) { + // Append each item from our fileGroup array to .cmb2-media-status + $(fileGroup).each(function () { + media.$field.siblings('.cmb2-media-status').slideDown().append(this); + }); + } else { + return fileGroup; + } + + }; + + cmb.mediaHandlers.single = function (selection) { + // Only get one file from the uploader + attachment = selection.first().toJSON(); + + media.$field.val(attachment.url); + $id(media.field + '_id').val(attachment.id); + + if (attachment.type && attachment.type === 'image') { + // image preview + var width = media.previewSize[0] ? media.previewSize[0] : 350; + uploadStatus = ''; + } else { + // Standard generic output if it's not an image. + uploadStatus = '
- ';
foreach ( $this->field->value as $val ) {
$this->value = $val;
- echo '
';
@@ -365,6 +387,7 @@ protected function _display() {
class CMB2_Display_File extends CMB2_Field_Display {
/**
* Display file value.
+ *
* @since 2.2.2
*/
protected function _display() {
@@ -395,7 +418,7 @@ protected function file_output( $url_value, $id, CMB2_Type_File_Base $field_type
if ( $id ) {
$image = wp_get_attachment_image( $id, $img_size, null, array( 'class' => 'cmb-image-display' ) );
} else {
- $size = is_array( $img_size ) ? $img_size[0] : 200;
+ $size = is_array( $img_size ) ? $img_size[0] : 200;
$image = '
';
}
@@ -416,6 +439,7 @@ protected function file_output( $url_value, $id, CMB2_Type_File_Base $field_type
class CMB2_Display_File_List extends CMB2_Display_File {
/**
* Display file_list value.
+ *
* @since 2.2.2
*/
protected function _display() {
@@ -436,6 +460,7 @@ protected function _display() {
class CMB2_Display_oEmbed extends CMB2_Field_Display {
/**
* Display oembed value.
+ *
* @since 2.2.2
*/
protected function _display() {
diff --git a/includes/CMB2/includes/CMB2_Hookup_Base.php b/includes/CMB2/includes/CMB2_Hookup_Base.php
index e135692..7c0c738 100755
--- a/includes/CMB2/includes/CMB2_Hookup_Base.php
+++ b/includes/CMB2/includes/CMB2_Hookup_Base.php
@@ -1,9 +1,10 @@
cmb = $cmb;
+ $this->cmb = $cmb;
$this->object_type = $this->cmb->mb_object_type();
}
@@ -40,7 +44,9 @@ abstract public function universal_hooks();
/**
* Ensures WordPress hook only gets fired once per object.
+ *
* @since 2.0.0
+ *
* @param string $action The name of the filter to hook the $hook callback to.
* @param callback $hook The callback to be run when the filter is applied.
* @param integer $priority Order the functions are executed
diff --git a/includes/CMB2/includes/CMB2_JS.php b/includes/CMB2/includes/CMB2_JS.php
index 01d0387..171d50d 100755
--- a/includes/CMB2/includes/CMB2_JS.php
+++ b/includes/CMB2/includes/CMB2_JS.php
@@ -1,5 +1,6 @@
esc_html__( 'Clear', 'cmb2' ),
@@ -103,6 +118,7 @@ protected static function colorpicker_frontend() {
/**
* Localize the php variables for CMB2 JS
+ *
* @since 2.0.7
*/
protected static function localize( $debug ) {
@@ -112,7 +128,7 @@ protected static function localize( $debug ) {
}
$localized = true;
- $l10n = array(
+ $l10n = array(
'ajax_nonce' => wp_create_nonce( 'ajax_nonce' ),
'ajaxurl' => admin_url( '/admin-ajax.php' ),
'script_debug' => $debug,
@@ -148,7 +164,7 @@ protected static function localize( $debug ) {
'stepMinute' => 5,
),
),
- 'strings' => array(
+ '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' ),
diff --git a/includes/CMB2/includes/CMB2_Options.php b/includes/CMB2/includes/CMB2_Options.php
index cf8cb35..2293736 100755
--- a/includes/CMB2/includes/CMB2_Options.php
+++ b/includes/CMB2/includes/CMB2_Options.php
@@ -9,6 +9,7 @@
* @link http://webdevstudios.com
*/
defined( 'ABSPATH' ) or die; // exit if accessed directly
+
/**
* Retrieves an instance of CMB2_Option based on the option key
*
@@ -18,6 +19,7 @@
class CMB2_Options {
/**
* Array of all CMB2_Option instances
+ *
* @var array
* @since 1.0.0
*/
@@ -44,20 +46,24 @@ class CMB2_Option {
/**
* Options array
+ *
* @var array
*/
protected $options = array();
/**
* Current option key
+ *
* @var string
*/
protected $key = '';
/**
* Initiate option object
+ *
* @param string $option_key Option key where data will be saved.
* Leave empty for temporary data store.
+ *
* @since 2.0.0
*/
public function __construct( $option_key = '' ) {
@@ -66,19 +72,24 @@ public function __construct( $option_key = '' ) {
/**
* Delete the option from the db
+ *
* @since 2.0.0
* @return bool Delete success or failure
*/
public function delete_option() {
- $deleted = $this->key ? delete_option( $this->key ) : true;
+ $deleted = $this->key ? delete_option( $this->key ) : true;
$this->options = $deleted ? array() : $this->options;
+
return $this->options;
}
/**
* Removes an option from an option array
+ *
* @since 1.0.1
- * @param string $field_id Option array field key
+ *
+ * @param string $field_id Option array field key
+ *
* @return array Modified options
*/
public function remove( $field_id, $resave = false ) {
@@ -97,62 +108,44 @@ public function remove( $field_id, $resave = false ) {
}
/**
- * Retrieves an option from an option array
- * @since 1.0.1
- * @param string $field_id Option array field key
- * @param mixed $default Fallback value for the option
- * @return array Requested field or default
- */
- public function get( $field_id, $default = false ) {
- $opts = $this->get_options();
-
- if ( 'all' == $field_id ) {
- return $opts;
- } elseif ( array_key_exists( $field_id, $opts ) ) {
- return false !== $opts[ $field_id ] ? $opts[ $field_id ] : $default;
- }
-
- return $default;
- }
-
- /**
- * Updates Option data
+ * Retrieve option value based on name of option.
+ *
+ * @uses apply_filters() Calls 'cmb2_override_option_get_{$this->key}' hook to allow
+ * overwriting the option value to be retrieved.
+ *
* @since 1.0.1
- * @param string $field_id Option array field key
- * @param mixed $value Value to update data with
- * @param bool $resave Whether to re-save the data
- * @param bool $single Whether data should not be an array
- * @return boolean Return status of update
+ *
+ * @param mixed $default Optional. Default value to return if the option does not exist.
+ *
+ * @return mixed Value set for the option.
*/
- public function update( $field_id, $value = '', $resave = false, $single = true ) {
- $this->get_options();
+ public function get_options( $default = null ) {
+ if ( empty( $this->options ) && ! empty( $this->key ) ) {
- if ( true !== $field_id ) {
+ $test_get = apply_filters( "cmb2_override_option_get_{$this->key}", 'cmb2_no_override_option_get', $default, $this );
- if ( ! $single ) {
- // If multiple, add to array
- $this->options[ $field_id ][] = $value;
+ if ( 'cmb2_no_override_option_get' !== $test_get ) {
+ $this->options = $test_get;
} else {
- $this->options[ $field_id ] = $value;
+ // If no override, get the option
+ $this->options = get_option( $this->key, $default );
}
-
}
- if ( $resave || true === $field_id ) {
- return $this->set();
- }
-
- return true;
+ return (array) $this->options;
}
/**
* Saves the option array
* Needs to be run after finished using remove/update_option
- * @uses apply_filters() Calls 'cmb2_override_option_save_{$this->key}' hook
+ *
+ * @uses apply_filters() Calls 'cmb2_override_option_save_{$this->key}' hook
* to allow overwriting the option value to be stored.
*
* @since 1.0.1
+ *
* @param array $options Optional options to override
+ *
* @return bool Success/Failure
*/
public function set( $options = array() ) {
@@ -175,28 +168,58 @@ public function set( $options = array() ) {
}
/**
- * Retrieve option value based on name of option.
- * @uses apply_filters() Calls 'cmb2_override_option_get_{$this->key}' hook to allow
- * overwriting the option value to be retrieved.
+ * Retrieves an option from an option array
*
* @since 1.0.1
- * @param mixed $default Optional. Default value to return if the option does not exist.
- * @return mixed Value set for the option.
+ *
+ * @param string $field_id Option array field key
+ * @param mixed $default Fallback value for the option
+ *
+ * @return array Requested field or default
*/
- public function get_options( $default = null ) {
- if ( empty( $this->options ) && ! empty( $this->key ) ) {
+ public function get( $field_id, $default = false ) {
+ $opts = $this->get_options();
- $test_get = apply_filters( "cmb2_override_option_get_{$this->key}", 'cmb2_no_override_option_get', $default, $this );
+ if ( 'all' == $field_id ) {
+ return $opts;
+ } elseif ( array_key_exists( $field_id, $opts ) ) {
+ return false !== $opts[ $field_id ] ? $opts[ $field_id ] : $default;
+ }
- if ( 'cmb2_no_override_option_get' !== $test_get ) {
- $this->options = $test_get;
+ return $default;
+ }
+
+ /**
+ * Updates Option data
+ *
+ * @since 1.0.1
+ *
+ * @param string $field_id Option array field key
+ * @param mixed $value Value to update data with
+ * @param bool $resave Whether to re-save the data
+ * @param bool $single Whether data should not be an array
+ *
+ * @return boolean Return status of update
+ */
+ public function update( $field_id, $value = '', $resave = false, $single = true ) {
+ $this->get_options();
+
+ if ( true !== $field_id ) {
+
+ if ( ! $single ) {
+ // If multiple, add to array
+ $this->options[ $field_id ][] = $value;
} else {
- // If no override, get the option
- $this->options = get_option( $this->key, $default );
+ $this->options[ $field_id ] = $value;
}
+
}
- return (array) $this->options;
+ if ( $resave || true === $field_id ) {
+ return $this->set();
+ }
+
+ return true;
}
}
diff --git a/includes/CMB2/includes/CMB2_Sanitize.php b/includes/CMB2/includes/CMB2_Sanitize.php
index a07e42c..3f51bdc 100755
--- a/includes/CMB2/includes/CMB2_Sanitize.php
+++ b/includes/CMB2/includes/CMB2_Sanitize.php
@@ -1,9 +1,10 @@
type()}".
*/
if ( function_exists( 'apply_filters_deprecated' ) ) {
- $override_value = apply_filters_deprecated( "cmb2_validate_{$this->field->type()}", array( null, $this->value, $this->field->object_id, $this->field->args(), $this ), '2.0.0', "cmb2_sanitize_{$this->field->type()}" );
+ $override_value = apply_filters_deprecated( "cmb2_validate_{$this->field->type()}", array(
+ null,
+ $this->value,
+ $this->field->object_id,
+ $this->field->args(),
+ $this
+ ), '2.0.0', "cmb2_sanitize_{$this->field->type()}" );
} else {
$override_value = apply_filters( "cmb2_validate_{$this->field->type()}", null, $this->value, $this->field->object_id, $this->field->args(), $this );
}
@@ -101,17 +117,18 @@ public function default_sanitization() {
}
/**
- * Default sanitization method, sanitize_text_field. Checks if value is array.
- * @since 2.2.4
- * @return mixed Sanitized value.
+ * Sanitize textareas and wysiwyg fields
+ *
+ * @since 1.0.1
+ * @return string Sanitized data
*/
- protected function _default_sanitization() {
- // Handle repeatable fields array
- return is_array( $this->value ) ? array_map( 'sanitize_text_field', $this->value ) : sanitize_text_field( $this->value );
+ public function textarea() {
+ return is_array( $this->value ) ? array_map( 'wp_kses_post', $this->value ) : wp_kses_post( $this->value );
}
/**
* Sets the object terms to the object (if not options-page) and optionally returns the sanitized term values.
+ *
* @since 2.2.4
* @return mixed Blank value, or sanitized term values if "cmb2_return_taxonomy_values_{$cmb_id}" is true.
*/
@@ -143,7 +160,7 @@ protected function _taxonomy() {
*
* @param bool $return_values By default, this is only true for 'options-page' boxes. To enable:
* `add_filter( "cmb2_return_taxonomy_values_{$cmb_id}", '__return_true' );`
- * @param CMB2_Sanitize $sanitizer This object.
+ * @param CMB2_Sanitize $sanitizer This object.
*/
if ( apply_filters( "cmb2_return_taxonomy_values_{$cmb_id}", $return_values, $this ) ) {
$sanitized_value = $this->_default_sanitization();
@@ -154,37 +171,49 @@ protected function _taxonomy() {
}
/**
- * Simple checkbox validation
- * @since 1.0.1
- * @return string|false 'on' or false
+ * Default sanitization method, sanitize_text_field. Checks if value is array.
+ *
+ * @since 2.2.4
+ * @return mixed Sanitized value.
*/
- public function checkbox() {
- return $this->value === 'on' ? 'on' : false;
+ protected function _default_sanitization() {
+ // Handle repeatable fields array
+ return is_array( $this->value ) ? array_map( 'sanitize_text_field', $this->value ) : sanitize_text_field( $this->value );
}
/**
- * Validate url in a meta value
- * @since 1.0.1
- * @return string Empty string or escaped url
+ * Determine if passed value is an empty array
+ *
+ * @since 2.0.6
+ *
+ * @param mixed $to_check Value to check
+ *
+ * @return boolean Whether value is an array that's empty
*/
- public function text_url() {
- $protocols = $this->field->args( 'protocols' );
- // for repeatable
- if ( is_array( $this->value ) ) {
- foreach ( $this->value as $key => $val ) {
- $this->value[ $key ] = $val ? esc_url_raw( $val, $protocols ) : $this->field->get_default();
- }
- } else {
- $this->value = $this->value ? esc_url_raw( $this->value, $protocols ) : $this->field->get_default();
+ public function _is_empty_array( $to_check ) {
+ if ( is_array( $to_check ) ) {
+ $cleaned_up = array_filter( $to_check );
+
+ return empty( $cleaned_up );
}
- return $this->value;
+ return false;
+ }
+
+ /**
+ * Simple checkbox validation
+ *
+ * @since 1.0.1
+ * @return string|false 'on' or false
+ */
+ public function checkbox() {
+ return $this->value === 'on' ? 'on' : false;
}
public function colorpicker() {
// for repeatable
if ( is_array( $this->value ) ) {
- $check = $this->value;
+ $check = $this->value;
$this->value = array();
foreach ( $check as $key => $val ) {
if ( $val && '#' != $val ) {
@@ -194,11 +223,13 @@ public function colorpicker() {
} else {
$this->value = ! $this->value || '#' == $this->value ? '' : esc_attr( $this->value );
}
+
return $this->value;
}
/**
* Validate email in a meta value
+ *
* @since 1.0.1
* @return string Empty string or sanitized email
*/
@@ -206,7 +237,7 @@ public function text_email() {
// for repeatable
if ( is_array( $this->value ) ) {
foreach ( $this->value as $key => $val ) {
- $val = trim( $val );
+ $val = trim( $val );
$this->value[ $key ] = is_email( $val ) ? $val : '';
}
} else {
@@ -219,6 +250,7 @@ public function text_email() {
/**
* Validate money in a meta value
+ *
* @since 1.0.1
* @return string Empty string or sanitized money value
*/
@@ -229,7 +261,7 @@ public function text_money() {
global $wp_locale;
- $search = array( $wp_locale->number_format['thousands_sep'], $wp_locale->number_format['decimal_point'] );
+ $search = array( $wp_locale->number_format['thousands_sep'], $wp_locale->number_format['decimal_point'] );
$replace = array( '', '.' );
// for repeatable
@@ -248,6 +280,7 @@ public function text_money() {
/**
* Converts text date to timestamp
+ *
* @since 1.0.2
* @return string Timestring
*/
@@ -259,6 +292,7 @@ public function text_date_timestamp() {
/**
* Datetime to timestamp
+ *
* @since 1.0.1
* @return string|array Timestring
*/
@@ -285,8 +319,41 @@ public function text_datetime_timestamp( $repeat = false ) {
return $this->value;
}
+ /**
+ * If repeating, loop through and re-apply sanitization method
+ *
+ * @since 1.1.0
+ *
+ * @param string $method Class method
+ * @param bool $repeat Whether repeating or not
+ *
+ * @return mixed Sanitized value
+ */
+ public function _check_repeat( $method, $repeat ) {
+ if ( $repeat || ! $this->field->args( 'repeatable' ) ) {
+ return false;
+ }
+
+ $values_array = $this->value;
+
+ $new_value = array();
+ foreach ( $values_array as $iterator => $this->value ) {
+ if ( $this->value ) {
+ $val = $this->$method( true );
+ if ( ! empty( $val ) ) {
+ $new_value[] = $val;
+ }
+ }
+ }
+
+ $this->value = $new_value;
+
+ return empty( $this->value ) ? null : $this->value;
+ }
+
/**
* Datetime to timestamp with timezone
+ *
* @since 1.0.1
* @return string Timestring
*/
@@ -372,16 +439,29 @@ public function text_datetime_timestamp_timezone( $repeat = false ) {
}
/**
- * Sanitize textareas and wysiwyg fields
- * @since 1.0.1
- * @return string Sanitized data
+ * Peforms saving of `text_datetime_timestamp_timezone` utc timestamp
+ *
+ * @since 2.2.0
*/
- public function textarea() {
- return is_array( $this->value ) ? array_map( 'wp_kses_post', $this->value ) : wp_kses_post( $this->value );
+ public function _save_utc_value( $utc_key, $utc_stamp ) {
+ return $this->_new_supporting_field( $utc_key )->save_field( $utc_stamp );
+ }
+
+ /**
+ * Returns a new, supporting, CMB2_Field object based on a new field id.
+ *
+ * @since 2.2.0
+ */
+ public function _new_supporting_field( $new_field_id ) {
+ return $this->field->get_field_clone( array(
+ 'id' => $new_field_id,
+ 'sanitization_cb' => false,
+ ) );
}
/**
* Sanitize code textareas
+ *
* @since 1.0.2
* @return string Sanitized data
*/
@@ -396,6 +476,7 @@ public function textarea_code( $repeat = false ) {
/**
* Handles saving of attachment post ID and sanitizing file url
+ *
* @since 1.1.0
* @return string Sanitized url
*/
@@ -415,6 +496,7 @@ public function file() {
/**
* Gets the values for the `file` field type from the data being saved.
+ *
* @since 2.2.0
*/
public function _get_group_file_value_array( $id_key ) {
@@ -423,19 +505,40 @@ public function _get_group_file_value_array( $id_key ) {
$i = $this->field->group->index;
// Check group $alldata data
- $id_val = isset( $alldata[ $base_id ][ $i ][ $id_key ] )
+ $id_val = isset( $alldata[ $base_id ][ $i ][ $id_key ] )
? absint( $alldata[ $base_id ][ $i ][ $id_key ] )
: 0;
return array(
- 'value' => $this->text_url(),
+ 'value' => $this->text_url(),
'supporting_field_value' => $id_val,
'supporting_field_id' => $id_key,
);
}
+ /**
+ * Validate url in a meta value
+ *
+ * @since 1.0.1
+ * @return string Empty string or escaped url
+ */
+ public function text_url() {
+ $protocols = $this->field->args( 'protocols' );
+ // for repeatable
+ if ( is_array( $this->value ) ) {
+ foreach ( $this->value as $key => $val ) {
+ $this->value[ $key ] = $val ? esc_url_raw( $val, $protocols ) : $this->field->get_default();
+ }
+ } else {
+ $this->value = $this->value ? esc_url_raw( $this->value, $protocols ) : $this->field->get_default();
+ }
+
+ return $this->value;
+ }
+
/**
* Peforms saving of `file` attachement's ID
+ *
* @since 1.1.0
*/
public function _save_file_id_value( $file_id_key ) {
@@ -454,66 +557,4 @@ public function _save_file_id_value( $file_id_key ) {
return $id_field->save_field( $id_val );
}
- /**
- * Peforms saving of `text_datetime_timestamp_timezone` utc timestamp
- * @since 2.2.0
- */
- public function _save_utc_value( $utc_key, $utc_stamp ) {
- return $this->_new_supporting_field( $utc_key )->save_field( $utc_stamp );
- }
-
- /**
- * Returns a new, supporting, CMB2_Field object based on a new field id.
- * @since 2.2.0
- */
- public function _new_supporting_field( $new_field_id ) {
- return $this->field->get_field_clone( array(
- 'id' => $new_field_id,
- 'sanitization_cb' => false,
- ) );
- }
-
- /**
- * If repeating, loop through and re-apply sanitization method
- * @since 1.1.0
- * @param string $method Class method
- * @param bool $repeat Whether repeating or not
- * @return mixed Sanitized value
- */
- public function _check_repeat( $method, $repeat ) {
- if ( $repeat || ! $this->field->args( 'repeatable' ) ) {
- return false;
- }
-
- $values_array = $this->value;
-
- $new_value = array();
- foreach ( $values_array as $iterator => $this->value ) {
- if ( $this->value ) {
- $val = $this->$method( true );
- if ( ! empty( $val ) ) {
- $new_value[] = $val;
- }
- }
- }
-
- $this->value = $new_value;
-
- return empty( $this->value ) ? null : $this->value;
- }
-
- /**
- * Determine if passed value is an empty array
- * @since 2.0.6
- * @param mixed $to_check Value to check
- * @return boolean Whether value is an array that's empty
- */
- public function _is_empty_array( $to_check ) {
- if ( is_array( $to_check ) ) {
- $cleaned_up = array_filter( $to_check );
- return empty( $cleaned_up );
- }
- return false;
- }
-
}
diff --git a/includes/CMB2/includes/CMB2_Show_Filters.php b/includes/CMB2/includes/CMB2_Show_Filters.php
index dad26e2..70c18b5 100755
--- a/includes/CMB2/includes/CMB2_Show_Filters.php
+++ b/includes/CMB2/includes/CMB2_Show_Filters.php
@@ -1,5 +1,6 @@
object_id() : get_the_ID();
+
+ if ( ! $object_id ) {
+ return false;
+ }
+
+ // If current page id is in the included array, display the metabox
+ return in_array( $object_id, (array) self::get_show_on_value( $meta_box_args ) );
+ }
+
/**
* Get Show_on key. backwards compatible w/ 'key' indexes
*
@@ -36,6 +65,7 @@ private static function get_show_on_key( $meta_box_args ) {
}
$keys = array_keys( $show_on );
+
return $keys[0];
}
@@ -68,36 +98,14 @@ private static function get_show_on_value( $meta_box_args ) {
return array();
}
- /**
- * Add metaboxes for an specific ID
- * @since 1.0.0
- * @param bool $display To display or not
- * @param array $meta_box_args Metabox config array
- * @param CMB2 $cmb The CMB2 instance.
- * @return bool Whether to display this metabox on the current page.
- */
- public static function check_id( $display, $meta_box_args, $cmb ) {
-
- $key = self::get_show_on_key( $meta_box_args );
- if ( ! $key || 'id' !== $key ) {
- return $display;
- }
-
- $object_id = is_admin() ? $cmb->object_id() : get_the_ID();
-
- if ( ! $object_id ) {
- return false;
- }
-
- // If current page id is in the included array, display the metabox
- return in_array( $object_id, (array) self::get_show_on_value( $meta_box_args ) );
- }
-
/**
* Add metaboxes for an specific Page Template
+ *
* @since 1.0.0
- * @param bool $display To display or not
+ *
+ * @param bool $display To display or not
* @param array $meta_box_args Metabox config array
+ *
* @return bool Whether to display this metabox on the current page.
*/
public static function check_page_template( $display, $meta_box_args, $cmb ) {
@@ -126,9 +134,12 @@ public static function check_page_template( $display, $meta_box_args, $cmb ) {
/**
* Only show options-page metaboxes on their options page (but only enforce on the admin side)
+ *
* @since 1.0.0
- * @param bool $display To display or not
+ *
+ * @param bool $display To display or not
* @param array $meta_box_args Metabox config array
+ *
* @return bool Whether to display this metabox on the current page.
*/
public static function check_admin_page( $display, $meta_box_args ) {
diff --git a/includes/CMB2/includes/CMB2_Types.php b/includes/CMB2/includes/CMB2_Types.php
index 38160eb..2444d4e 100755
--- a/includes/CMB2/includes/CMB2_Types.php
+++ b/includes/CMB2/includes/CMB2_Types.php
@@ -1,9 +1,10 @@
field->args( 'repeatable' ) ) {
- $this->render_repeatable_field();
- } else {
- $this->_render();
+ public function maybe_proxy_method( $method, $arguments ) {
+ $exists = false;
+
+ $proxied = array(
+ 'get_object_terms' => array(),
+ 'is_valid_img_ext' => false,
+ 'parse_args' => array(),
+ 'concat_items' => '',
+ 'select_option' => '',
+ 'list_input' => '',
+ 'list_input_checkbox' => '',
+ 'img_status_output' => '',
+ 'file_status_output' => '',
+ 'parse_picker_options' => array(),
+ );
+ if ( isset( $proxied[ $method ] ) ) {
+ $exists = array(
+ // Ok, proxy the method call to the CMB2_Type_Base object.
+ 'value' => $this->proxy_method( $method, $proxied[ $method ], $arguments ),
+ );
}
- }
- /**
- * Render a field type
- * @since 1.1.0
- */
- protected function _render() {
- $this->field->peform_param_callback( 'before_field' );
- echo $this->{$this->field->type()}();
- $this->field->peform_param_callback( 'after_field' );
+ return $exists;
}
/**
@@ -135,7 +154,7 @@ protected function proxy_method( $method, $default, $args = array() ) {
*
* @since 2.2.3
*
- * @param string $method Method attempting to be called on the CMB2_Type_Base object.
+ * @param string $method Method attempting to be called on the CMB2_Type_Base object.
*/
protected function guess_type_object( $method ) {
@@ -171,41 +190,11 @@ protected function guess_type_object( $method ) {
return null !== $this->type;
}
- /**
- * Check for methods to be proxied to the CMB2_Type_Base object.
- * @since 2.2.4
- * @param string $method The possible method to proxy.
- * @param array $arguments All arguments passed to the method.
- * @return bool|array False if not proxied, else array with 'value' key being the return of the method.
- */
- public function maybe_proxy_method( $method, $arguments ) {
- $exists = false;
-
- $proxied = array(
- 'get_object_terms' => array(),
- 'is_valid_img_ext' => false,
- 'parse_args' => array(),
- 'concat_items' => '',
- 'select_option' => '',
- 'list_input' => '',
- 'list_input_checkbox' => '',
- 'img_status_output' => '',
- 'file_status_output' => '',
- 'parse_picker_options' => array(),
- );
- if ( isset( $proxied[ $method ] ) ) {
- $exists = array(
- // Ok, proxy the method call to the CMB2_Type_Base object.
- 'value' => $this->proxy_method( $method, $proxied[ $method ], $arguments ),
- );
- }
-
- return $exists;
- }
-
/**
* Checks for a custom field class to use for rendering.
+ *
* @since 2.2.4
+ *
* @param string $fieldtype Non-existent field type name
*/
public function maybe_custom_field_object( $fieldtype ) {
@@ -216,8 +205,8 @@ public function maybe_custom_field_object( $fieldtype ) {
*
* @since 2.2.4
*
- * @param string $class The custom field type class to use. Default null.
- * @param object $field_type_object This `CMB2_Types` object.
+ * @param string $class The custom field type class to use. Default null.
+ * @param object $field_type_object This `CMB2_Types` object.
*/
$render_class_name = apply_filters( "cmb2_render_class_{$fieldtype}", null, $this );
@@ -234,49 +223,21 @@ public function maybe_custom_field_object( $fieldtype ) {
}
/**
- * Retrieve text parameter from field's options array (if it has one), or use fallback text
- * @since 2.0.0
- * @param string $text_key Key in field's options array
- * @param string $fallback Fallback text
- * @return string Text
- */
- public function _text( $text_key, $fallback = '' ) {
- return $this->field->get_string( $text_key, $fallback );
- }
-
- /**
- * Determine a file's extension
- * @since 1.0.0
- * @param string $file File url
- * @return string|false File extension or false
- */
- public function get_file_ext( $file ) {
- return CMB2_Utils::get_file_ext( $file );
- }
-
- /**
- * Get the file name from a url
- * @since 2.0.0
- * @param string $value File url or path
- * @return string File name
- */
- public function get_file_name_from_path( $value ) {
- return CMB2_Utils::get_file_name_from_path( $value );
- }
-
- /**
- * Combines attributes into a string for a form element
+ * Render a field (and handle repeatable)
+ *
* @since 1.1.0
- * @param array $attrs Attributes to concatenate
- * @param array $attr_exclude Attributes that should NOT be concatenated
- * @return string String of attributes for form element
*/
- public function concat_attrs( $attrs, $attr_exclude = array() ) {
- return CMB2_Utils::concat_attrs( $attrs, $attr_exclude );
+ public function render() {
+ if ( $this->field->args( 'repeatable' ) ) {
+ $this->render_repeatable_field();
+ } else {
+ $this->_render();
+ }
}
/**
* Generates repeatable field table markup
+ *
* @since 1.0.0
*/
public function render_repeatable_field() {
@@ -285,28 +246,62 @@ public function render_repeatable_field() {
$this->_desc( true, true, true );
?>
- 
';
}
diff --git a/includes/CMB2/includes/types/CMB2_Type_File_Base.php b/includes/CMB2/includes/types/CMB2_Type_File_Base.php
index 10dd0ef..f97ff79 100755
--- a/includes/CMB2/includes/types/CMB2_Type_File_Base.php
+++ b/includes/CMB2/includes/types/CMB2_Type_File_Base.php
@@ -1,9 +1,10 @@
'hidden',
- 'class' => 'cmb2-upload-file cmb2-upload-list',
- 'size' => 45, 'desc' => '', 'value' => '',
+ 'type' => 'hidden',
+ 'class' => 'cmb2-upload-file cmb2-upload-list',
+ 'size' => 45,
+ 'desc' => '',
+ 'value' => '',
'data-previewsize' => is_array( $img_size ) ? sprintf( '[%s]', implode( ',', $img_size ) ) : 50,
'data-queryargs' => ! empty( $query_args ) ? json_encode( $query_args ) : '',
'js_dependencies' => 'media-editor',
@@ -34,8 +37,9 @@ public function render() {
$output .= parent::render( array(
'type' => 'button',
'class' => 'cmb2-upload-button button cmb2-upload-list',
- 'value' => esc_attr( $this->_text( 'add_upload_files_text', esc_html__( 'Add or Upload Files', 'cmb2' ) ) ),
- 'name' => '', 'id' => '',
+ 'value' => esc_attr( $this->_text( 'add_upload_files_text', esc_html__( 'Add or Upload Files', 'cmb2' ) ) ),
+ 'name' => '',
+ 'id' => '',
) );
$output .= '
-
+
+
+
+
-
repeatable_rows(); ?>
-
- - -
++ +
iterator = 0; } + /** + * Generates description markup + * + * @since 1.0.0 + * + * @param boolean $paragraph Paragraph tag or span + * @param boolean $echo Whether to echo description or only return it + * + * @return string Field's description markup + */ + public function _desc( $paragraph = false, $echo = false, $repeat_group = false ) { + // Prevent description from printing multiple times for repeatable fields + if ( ! $repeat_group && ( $this->field->args( 'repeatable' ) || $this->iterator > 0 ) ) { + return ''; + } + + $desc = $this->field->args( 'description' ); + + if ( ! $desc ) { + return; + } + + $tag = $paragraph ? 'p' : 'span'; + $desc = sprintf( "\n" . '<%1$s class="cmb2-metabox-description">%2$s' . "\n", $tag, $desc ); + + if ( $echo ) { + echo $desc; + } + + return $desc; + } + /** * Generates repeatable field rows + * * @since 1.1.0 */ public function repeatable_rows() { $meta_value = array_filter( (array) $this->field->escaped_value() ); // check for default content - $default = $this->field->get_default(); + $default = $this->field->get_default(); // check for saved data if ( ! empty( $meta_value ) ) { @@ -322,7 +317,7 @@ public function repeatable_rows() { foreach ( (array) $meta_value as $val ) { $this->field->escaped_value = $val; $this->repeat_row( $count < 2 ); - $this->iterator++; + $this->iterator ++; } } else { @@ -335,65 +330,107 @@ public function repeatable_rows() { // Then add an empty row $this->field->escaped_value = ''; - $this->iterator = $this->iterator ? $this->iterator : 1; + $this->iterator = $this->iterator ? $this->iterator : 1; $this->repeat_row( false, 'empty-row hidden' ); } /** * Generates a repeatable row's markup + * * @since 1.1.0 + * * @param bool $disable_remover Whether remove button should be disabled - * @param string $class Repeatable table row's class + * @param string $class Repeatable table row's class */ protected function repeat_row( $disable_remover = false, $class = 'cmb-repeat-row' ) { $disabled = $disable_remover ? ' button-disabled' : ''; ?> -
-
field->args( 'repeatable' ) || $this->iterator > 0 ) ) {
- return '';
- }
-
- $desc = $this->field->args( 'description' );
+ protected function _render() {
+ $this->field->peform_param_callback( 'before_field' );
+ echo $this->{$this->field->type()}();
+ $this->field->peform_param_callback( 'after_field' );
+ }
- if ( ! $desc ) {
- return;
- }
+ /**
+ * Retrieve text parameter from field's options array (if it has one), or use fallback text
+ *
+ * @since 2.0.0
+ *
+ * @param string $text_key Key in field's options array
+ * @param string $fallback Fallback text
+ *
+ * @return string Text
+ */
+ public function _text( $text_key, $fallback = '' ) {
+ return $this->field->get_string( $text_key, $fallback );
+ }
- $tag = $paragraph ? 'p' : 'span';
- $desc = sprintf( "\n" . '<%1$s class="cmb2-metabox-description">%2$s' . "\n", $tag, $desc );
+ /**
+ * Determine a file's extension
+ *
+ * @since 1.0.0
+ *
+ * @param string $file File url
+ *
+ * @return string|false File extension or false
+ */
+ public function get_file_ext( $file ) {
+ return CMB2_Utils::get_file_ext( $file );
+ }
- if ( $echo ) {
- echo $desc;
- }
+ /**
+ * Get the file name from a url
+ *
+ * @since 2.0.0
+ *
+ * @param string $value File url or path
+ *
+ * @return string File name
+ */
+ public function get_file_name_from_path( $value ) {
+ return CMB2_Utils::get_file_name_from_path( $value );
+ }
- return $desc;
+ /**
+ * Combines attributes into a string for a form element
+ *
+ * @since 1.1.0
+ *
+ * @param array $attrs Attributes to concatenate
+ * @param array $attr_exclude Attributes that should NOT be concatenated
+ *
+ * @return string String of attributes for form element
+ */
+ public function concat_attrs( $attrs, $attr_exclude = array() ) {
+ return CMB2_Utils::concat_attrs( $attrs, $attr_exclude );
}
/**
* Generate field name attribute
+ *
* @since 1.1.0
- * @param string $suffix For multi-part fields
+ *
+ * @param string $suffix For multi-part fields
+ *
* @return string Name attribute
*/
public function _name( $suffix = '' ) {
@@ -402,76 +439,73 @@ public function _name( $suffix = '' ) {
/**
* Generate field id attribute
+ *
* @since 1.1.0
- * @param string $suffix For multi-part fields
+ *
+ * @param string $suffix For multi-part fields
+ *
* @return string Id attribute
*/
public function _id( $suffix = '' ) {
return $this->field->id() . $suffix . ( $this->field->args( 'repeatable' ) ? '_' . $this->iterator . '" data-iterator="' . $this->iterator : '' );
}
+ /**
+ * Begin Field Types
+ */
+
+ public function text() {
+ return $this->input();
+ }
+
/**
* Handles outputting an 'input' element
+ *
* @since 1.1.0
+ *
* @param array $args Override arguments
* @param string $type Field type
+ *
* @return string Form input element
*/
public function input( $args = array(), $type = __FUNCTION__ ) {
$this->type = new CMB2_Type_Text( $this, $args, $type );
- return $this->type->render();
- }
- /**
- * Handles outputting an 'textarea' element
- * @since 1.1.0
- * @param array $args Override arguments
- * @return string Form textarea element
- */
- public function textarea( $args = array() ) {
- $this->type = new CMB2_Type_Textarea( $this, $args );
return $this->type->render();
}
- /**
- * Begin Field Types
- */
-
- public function text() {
- return $this->input();
- }
-
public function hidden() {
$args = array(
- 'type' => 'hidden',
- 'desc' => '',
+ 'type' => 'hidden',
+ 'desc' => '',
'class' => 'cmb2-hidden',
);
if ( $this->field->group ) {
- $args['data-groupid'] = $this->field->group->id();
+ $args['data-groupid'] = $this->field->group->id();
$args['data-iterator'] = $this->iterator;
}
+
return $this->input( $args );
}
public function text_small() {
return $this->input( array(
'class' => 'cmb2-text-small',
- 'desc' => $this->_desc(),
+ 'desc' => $this->_desc(),
) );
}
public function text_medium() {
return $this->input( array(
'class' => 'cmb2-text-medium',
- 'desc' => $this->_desc(),
+ 'desc' => $this->_desc(),
) );
}
public function text_email() {
return $this->input( array(
'class' => 'cmb2-text-email cmb2-text-medium',
- 'type' => 'email',
+ 'type' => 'email',
) );
}
@@ -485,80 +519,103 @@ public function text_url() {
public function text_money() {
$input = $this->input( array(
'class' => 'cmb2-text-money',
- 'desc' => $this->_desc(),
+ 'desc' => $this->_desc(),
) );
+
return ( ! $this->field->get_param_callback_result( 'before_field' ) ? '$ ' : ' ' ) . $input;
}
public function textarea_small() {
return $this->textarea( array(
'class' => 'cmb2-textarea-small',
- 'rows' => 4,
+ 'rows' => 4,
) );
}
+ /**
+ * Handles outputting an 'textarea' element
+ *
+ * @since 1.1.0
+ *
+ * @param array $args Override arguments
+ *
+ * @return string Form textarea element
+ */
+ public function textarea( $args = array() ) {
+ $this->type = new CMB2_Type_Textarea( $this, $args );
+
+ return $this->type->render();
+ }
+
public function textarea_code() {
$this->type = new CMB2_Type_Textarea_Code( $this );
+
return $this->type->render();
}
public function wysiwyg( $args = array() ) {
$this->type = new CMB2_Type_Wysiwyg( $this, $args );
- return $this->type->render();
- }
- public function text_date( $args = array() ) {
- $this->type = new CMB2_Type_Text_Date( $this, $args );
return $this->type->render();
}
- // Alias for text_date
public function text_date_timestamp( $args = array() ) {
return $this->text_date( $args );
}
+ // Alias for text_date
+
+ public function text_date( $args = array() ) {
+ $this->type = new CMB2_Type_Text_Date( $this, $args );
+
+ return $this->type->render();
+ }
+
public function text_time( $args = array() ) {
$this->type = new CMB2_Type_Text_Time( $this, $args );
+
return $this->type->render();
}
public function text_datetime_timestamp( $args = array() ) {
$this->type = new CMB2_Type_Text_Datetime_Timestamp( $this, $args );
+
return $this->type->render();
}
public function text_datetime_timestamp_timezone( $args = array() ) {
$this->type = new CMB2_Type_Text_Datetime_Timestamp_Timezone( $this, $args );
+
return $this->type->render();
}
public function select_timezone() {
$this->type = new CMB2_Type_Select_Timezone( $this );
+
return $this->type->render();
}
public function colorpicker( $args = array(), $meta_value = '' ) {
$this->type = new CMB2_Type_Colorpicker( $this, $args, $meta_value );
+
return $this->type->render();
}
public function title( $args = array() ) {
$this->type = new CMB2_Type_Title( $this, $args );
+
return $this->type->render();
}
public function select( $args = array() ) {
$this->type = new CMB2_Type_Select( $this, $args );
+
return $this->type->render();
}
public function taxonomy_select() {
$this->type = new CMB2_Type_Taxonomy_Select( $this );
- return $this->type->render();
- }
- public function radio( $args = array(), $type = __FUNCTION__ ) {
- $this->type = new CMB2_Type_Radio( $this, $args, $type );
return $this->type->render();
}
@@ -566,8 +623,9 @@ public function radio_inline() {
return $this->radio( array(), __FUNCTION__ );
}
- public function multicheck( $type = 'checkbox' ) {
- $this->type = new CMB2_Type_Multicheck( $this, array(), $type );
+ public function radio( $args = array(), $type = __FUNCTION__ ) {
+ $this->type = new CMB2_Type_Radio( $this, $args, $type );
+
return $this->type->render();
}
@@ -575,13 +633,15 @@ public function multicheck_inline() {
return $this->multicheck( 'multicheck_inline' );
}
- public function checkbox( $args = array(), $is_checked = null ) {
- $this->type = new CMB2_Type_Checkbox( $this, $args, $is_checked );
+ public function multicheck( $type = 'checkbox' ) {
+ $this->type = new CMB2_Type_Multicheck( $this, array(), $type );
+
return $this->type->render();
}
- public function taxonomy_radio() {
- $this->type = new CMB2_Type_Taxonomy_Radio( $this );
+ public function checkbox( $args = array(), $is_checked = null ) {
+ $this->type = new CMB2_Type_Checkbox( $this, $args, $is_checked );
+
return $this->type->render();
}
@@ -589,8 +649,9 @@ public function taxonomy_radio_inline() {
return $this->taxonomy_radio();
}
- public function taxonomy_multicheck() {
- $this->type = new CMB2_Type_Taxonomy_Multicheck( $this );
+ public function taxonomy_radio() {
+ $this->type = new CMB2_Type_Taxonomy_Radio( $this );
+
return $this->type->render();
}
@@ -598,18 +659,27 @@ public function taxonomy_multicheck_inline() {
return $this->taxonomy_multicheck();
}
+ public function taxonomy_multicheck() {
+ $this->type = new CMB2_Type_Taxonomy_Multicheck( $this );
+
+ return $this->type->render();
+ }
+
public function oembed() {
$this->type = new CMB2_Type_Oembed( $this );
+
return $this->type->render();
}
public function file_list() {
$this->type = new CMB2_Type_File_List( $this );
+
return $this->type->render();
}
public function file() {
$this->type = new CMB2_Type_File( $this );
+
return $this->type->render();
}
diff --git a/includes/CMB2/includes/CMB2_Utils.php b/includes/CMB2/includes/CMB2_Utils.php
index f25fa58..be3d32a 100755
--- a/includes/CMB2/includes/CMB2_Utils.php
+++ b/includes/CMB2/includes/CMB2_Utils.php
@@ -1,9 +1,10 @@
have_posts() ) {
foreach ( $query->posts as $post_id ) {
- $meta = wp_get_attachment_metadata( $post_id );
+ $meta = wp_get_attachment_metadata( $post_id );
$original_file = basename( $meta['file'] );
$cropped_image_files = isset( $meta['sizes'] ) ? wp_list_pluck( $meta['sizes'], 'file' ) : array();
if ( $original_file === $file || in_array( $file, $cropped_image_files ) ) {
@@ -78,8 +84,11 @@ public static function image_id_from_url( $img_url ) {
/**
* Utility method that returns time string offset by timezone
+ *
* @since 1.0.0
+ *
* @param string $tzstring Time string
+ *
* @return string Offset time string
*/
public static function timezone_offset( $tzstring ) {
@@ -88,12 +97,13 @@ public static function timezone_offset( $tzstring ) {
if ( ! empty( $tzstring ) && is_string( $tzstring ) ) {
if ( 'UTC' === substr( $tzstring, 0, 3 ) ) {
$tzstring = str_replace( array( ':15', ':30', ':45' ), array( '.25', '.5', '.75' ), $tzstring );
+
return intval( floatval( substr( $tzstring, 3 ) ) * HOUR_IN_SECONDS );
}
try {
$date_time_zone_selected = new DateTimeZone( $tzstring );
- $tz_offset = timezone_offset_get( $date_time_zone_selected, date_create() );
+ $tz_offset = timezone_offset_get( $date_time_zone_selected, date_create() );
} catch ( Exception $e ) {
self::log_if_debug( __METHOD__, __LINE__, $e->getMessage() );
}
@@ -103,6 +113,22 @@ public static function timezone_offset( $tzstring ) {
return $tz_offset;
}
+ /**
+ * Send to debug.log if WP_DEBUG is defined and true
+ *
+ * @since 2.2.0
+ *
+ * @param string $function Function name
+ * @param int $line Line number
+ * @param mixed $msg Message to output
+ * @param mixed $debug Variable to print_r
+ */
+ public static function log_if_debug( $function, $line, $msg, $debug = null ) {
+ if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
+ error_log( "In $function, $line:" . print_r( $msg, true ) . ( $debug ? print_r( $debug, true ) : '' ) );
+ }
+ }
+
/**
* Utility method that returns a timezone string representing the default timezone for the site.
*
@@ -138,9 +164,12 @@ public static function timezone_string() {
/**
* Returns a timestamp, first checking if value already is a timestamp.
+ *
* @since 2.0.0
+ *
* @param string|int $string Possible timestamp string
- * @return int Time stamp
+ *
+ * @return int Time stamp
*/
public static function make_valid_time_stamp( $string ) {
if ( ! $string ) {
@@ -154,20 +183,26 @@ public static function make_valid_time_stamp( $string ) {
/**
* Determine if a value is a valid timestamp
+ *
* @since 2.0.0
- * @param mixed $timestamp Value to check
+ *
+ * @param mixed $timestamp Value to check
+ *
* @return boolean Whether value is a valid timestamp
*/
public static function is_valid_time_stamp( $timestamp ) {
return (string) (int) $timestamp === (string) $timestamp
- && $timestamp <= PHP_INT_MAX
- && $timestamp >= ~PHP_INT_MAX;
+ && $timestamp <= PHP_INT_MAX
+ && $timestamp >= ~PHP_INT_MAX;
}
/**
* Checks if a value is 'empty'. Still accepts 0.
+ *
* @since 2.0.0
+ *
* @param mixed $value Value to check
+ *
* @return bool True or false
*/
public static function isempty( $value ) {
@@ -176,8 +211,11 @@ public static function isempty( $value ) {
/**
* Checks if a value is not 'empty'. 0 doesn't count as empty.
+ *
* @since 2.2.2
+ *
* @param mixed $value Value to check
+ *
* @return bool True or false
*/
public static function notempty( $value ) {
@@ -186,8 +224,11 @@ public static function notempty( $value ) {
/**
* Filters out empty values (not including 0).
+ *
* @since 2.2.2
+ *
* @param mixed $value Value to check
+ *
* @return bool True or false
*/
public static function filter_empty( $value ) {
@@ -196,7 +237,9 @@ public static function filter_empty( $value ) {
/**
* Insert a single array item inside another array at a set position
+ *
* @since 2.0.2
+ *
* @param array &$array Array to modify. Is passed by reference, and no return is needed.
* @param array $new New array to insert
* @param int $position Position in the main array to insert the new array
@@ -211,6 +254,7 @@ public static function array_insert( &$array, $new, $position ) {
* Defines the url which is used to load local resources.
* This may need to be filtered for local Window installations.
* If resources do not load, please check the wiki for details.
+ *
* @since 1.0.1
* @return string URL to CMB2 resources
*/
@@ -236,8 +280,11 @@ public static function url( $path = '' ) {
/**
* Converts a system path to a URL
+ *
* @since 2.2.2
+ *
* @param string $dir Directory path to convert.
+ *
* @return string Converted URL.
*/
public static function get_url_from_dir( $dir ) {
@@ -293,6 +340,7 @@ public static function get_url_from_dir( $dir ) {
* @since 2.2.0
*
* @param string $path Path to normalize.
+ *
* @return string Normalized path.
*/
protected static function normalize_path( $path ) {
@@ -312,13 +360,17 @@ protected static function normalize_path( $path ) {
/**
* Get timestamp from text date
+ *
* @since 2.2.0
+ *
* @param string $value Date value
* @param string $date_format Expected date format
+ *
* @return mixed Unix timestamp representing the date.
*/
public static function get_timestamp_from_value( $value, $date_format ) {
$date_object = date_create_from_format( $date_format, $value );
+
return $date_object ? $date_object->setTime( 0, 0, 0 )->getTimeStamp() : strtotime( $value );
}
@@ -334,7 +386,9 @@ public static function get_timestamp_from_value( $value, $date_format ) {
* bring even more translation troubles.
*
* @since 2.2.0
+ *
* @param string $format php date format
+ *
* @return string reformatted string
*/
public static function php_to_js_dateformat( $format ) {
@@ -374,56 +428,54 @@ public static function php_to_js_dateformat( $format ) {
/**
* Helper function for CMB_Utils->php_to_js_dateformat, because php 5.2 was retarded.
+ *
* @since 2.2.0
+ *
* @param $value Value to wrap/escape
+ *
* @return string Modified value
*/
public static function wrap_escaped_chars( $value ) {
return ''' . str_replace( '\\', '', $value[0] ) . ''';
}
- /**
- * Send to debug.log if WP_DEBUG is defined and true
- *
- * @since 2.2.0
- *
- * @param string $function Function name
- * @param int $line Line number
- * @param mixed $msg Message to output
- * @param mixed $debug Variable to print_r
- */
- public static function log_if_debug( $function, $line, $msg, $debug = null ) {
- if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
- error_log( "In $function, $line:" . print_r( $msg, true ) . ( $debug ? print_r( $debug, true ) : '' ) );
- }
- }
-
/**
* Determine a file's extension
+ *
* @since 1.0.0
- * @param string $file File url
+ *
+ * @param string $file File url
+ *
* @return string|false File extension or false
*/
public static function get_file_ext( $file ) {
$parsed = parse_url( $file, PHP_URL_PATH );
+
return $parsed ? strtolower( pathinfo( $parsed, PATHINFO_EXTENSION ) ) : false;
}
/**
* Get the file name from a url
+ *
* @since 2.0.0
+ *
* @param string $value File url or path
+ *
* @return string File name
*/
public static function get_file_name_from_path( $value ) {
$parts = explode( '/', $value );
+
return is_array( $parts ) ? end( $parts ) : $value;
}
/**
* Check if WP version is at least $version.
+ *
* @since 2.2.2
- * @param string $version WP version string to compare.
+ *
+ * @param string $version WP version string to compare.
+ *
* @return bool Result of comparison check.
*/
public static function wp_at_least( $version ) {
@@ -432,23 +484,27 @@ public static function wp_at_least( $version ) {
/**
* Combines attributes into a string for a form element.
+ *
* @since 1.1.0
- * @param array $attrs Attributes to concatenate.
- * @param array $attr_exclude Attributes that should NOT be concatenated.
+ *
+ * @param array $attrs Attributes to concatenate.
+ * @param array $attr_exclude Attributes that should NOT be concatenated.
+ *
* @return string String of attributes for form element.
*/
public static function concat_attrs( $attrs, $attr_exclude = array() ) {
$attr_exclude[] = 'rendered';
- $attributes = '';
+ $attributes = '';
foreach ( $attrs as $attr => $val ) {
$excluded = in_array( $attr, (array) $attr_exclude, true );
$empty = false === $val && 'value' !== $attr;
if ( ! $excluded && ! $empty ) {
// if data attribute, use single quote wraps, else double
- $quotes = false !== stripos( $attr, 'data-' ) ? "'" : '"';
+ $quotes = false !== stripos( $attr, 'data-' ) ? "'" : '"';
$attributes .= sprintf( ' %1$s=%3$s%2$s%3$s', $attr, $val, $quotes );
}
}
+
return $attributes;
}
diff --git a/includes/CMB2/includes/CMB2_hookup.php b/includes/CMB2/includes/CMB2_hookup.php
index a5c9461..9d167d7 100755
--- a/includes/CMB2/includes/CMB2_hookup.php
+++ b/includes/CMB2/includes/CMB2_hookup.php
@@ -1,10 +1,11 @@
cmb = $cmb;
+ $this->cmb = $cmb;
$this->object_type = $this->cmb->mb_object_type();
}
+ /**
+ * Registers scripts and styles for CMB2
+ *
+ * @since 1.0.0
+ */
+ public static function register_scripts() {
+ self::register_styles();
+ self::register_js();
+ }
+
+ /**
+ * Registers scripts for CMB2
+ *
+ * @since 2.0.7
+ */
+ protected static function register_js() {
+ if ( self::$js_registration_done ) {
+ return;
+ }
+
+ $hook = is_admin() ? 'admin_footer' : 'wp_footer';
+ add_action( $hook, array( 'CMB2_JS', 'enqueue' ), 8 );
+
+ self::$js_registration_done = true;
+ }
+
public function universal_hooks() {
foreach ( get_class_methods( 'CMB2_Show_Filters' ) as $filter ) {
add_filter( 'cmb2_show_on', array( 'CMB2_Show_Filters', $filter ), 10, 3 );
@@ -77,6 +110,66 @@ public function universal_hooks() {
}
}
+ /**
+ * Enqueues the 'cmb2-display-styles' if the conditions match (has columns, on the right page, etc).
+ *
+ * @since 2.2.2.1
+ */
+ protected function maybe_enqueue_column_display_styles() {
+ global $pagenow;
+ if (
+ $pagenow
+ && $this->cmb->has_columns
+ && $this->cmb->prop( 'cmb_styles' )
+ && in_array( $pagenow, array( 'edit.php', 'users.php', 'edit-comments.php', 'edit-tags.php' ), 1 )
+ ) {
+ self::enqueue_cmb_css( 'cmb2-display-styles' );
+ }
+ }
+
+ /**
+ * Includes CMB2 styles
+ *
+ * @since 2.0.0
+ */
+ public static function enqueue_cmb_css( $handle = 'cmb2-styles' ) {
+ if ( ! apply_filters( 'cmb2_enqueue_css', true ) ) {
+ return false;
+ }
+
+ self::register_styles();
+
+ /*
+ * White list the options as this method can be used as a hook callback
+ * and have a different argument passed.
+ */
+
+ return wp_enqueue_style( 'cmb2-display-styles' === $handle ? $handle : 'cmb2-styles' );
+ }
+
+ /**
+ * Registers styles for CMB2
+ *
+ * @since 2.0.7
+ */
+ protected static function register_styles() {
+ if ( self::$css_registration_done ) {
+ return;
+ }
+
+ // Only use minified files if SCRIPT_DEBUG is off
+ $min = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
+ $front = is_admin() ? '' : '-front';
+ $rtl = is_rtl() ? '-rtl' : '';
+
+ // Filter required styles and register stylesheet
+ $dependencies = apply_filters( 'cmb2_style_dependencies', array() );
+ wp_register_style( 'cmb2-styles', CMB2_Utils::url( "css/cmb2{$front}{$rtl}{$min}.css" ), $dependencies );
+ wp_register_style( 'cmb2-display-styles', CMB2_Utils::url( "css/cmb2-display{$rtl}{$min}.css" ), $dependencies );
+
+ self::$css_registration_done = true;
+ }
+
public function post_hooks() {
add_action( 'add_meta_boxes', array( $this, 'add_metaboxes' ) );
add_action( 'add_attachment', array( $this, 'save_post' ) );
@@ -97,7 +190,7 @@ public function comment_hooks() {
if ( $this->cmb->has_columns ) {
add_filter( 'manage_edit-comments_columns', array( $this, 'register_column_headers' ) );
- add_action( 'manage_comments_custom_column', array( $this, 'column_display' ), 10, 3 );
+ add_action( 'manage_comments_custom_column', array( $this, 'column_display' ), 10, 3 );
}
}
@@ -114,10 +207,42 @@ public function user_hooks() {
if ( $this->cmb->has_columns ) {
add_filter( 'manage_users_columns', array( $this, 'register_column_headers' ) );
- add_filter( 'manage_users_custom_column', array( $this, 'return_column_display' ), 10, 3 );
+ add_filter( 'manage_users_custom_column', array( $this, 'return_column_display' ), 10, 3 );
}
}
+ /**
+ * Get the CMB priority property set to numeric hook priority.
+ *
+ * @since 2.2.0
+ *
+ * @param integer $default Default display hook priority.
+ *
+ * @return integer Hook priority.
+ */
+ public function get_priority( $default = 10 ) {
+ $priority = $this->cmb->prop( 'priority' );
+
+ if ( ! is_numeric( $priority ) ) {
+ switch ( $priority ) {
+
+ case 'high':
+ $priority = 5;
+ break;
+
+ case 'low':
+ $priority = 20;
+ break;
+
+ default:
+ $priority = $default;
+ break;
+ }
+ }
+
+ return $priority;
+ }
+
public function term_hooks() {
if ( ! function_exists( 'get_term_meta' ) ) {
wp_die( esc_html__( 'Term Metadata is a WordPress 4.4+ feature. Please upgrade your WordPress install.', 'cmb2' ) );
@@ -148,7 +273,7 @@ public function term_hooks() {
if ( $this->cmb->has_columns ) {
add_filter( "manage_edit-{$taxonomy}_columns", array( $this, 'register_column_headers' ) );
- add_filter( "manage_{$taxonomy}_custom_column", array( $this, 'return_column_display' ), 10, 3 );
+ add_filter( "manage_{$taxonomy}_custom_column", array( $this, 'return_column_display' ), 10, 3 );
}
}
@@ -158,54 +283,9 @@ public function term_hooks() {
}
- /**
- * Registers styles for CMB2
- * @since 2.0.7
- */
- protected static function register_styles() {
- if ( self::$css_registration_done ) {
- return;
- }
-
- // Only use minified files if SCRIPT_DEBUG is off
- $min = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
- $front = is_admin() ? '' : '-front';
- $rtl = is_rtl() ? '-rtl' : '';
-
- // Filter required styles and register stylesheet
- $dependencies = apply_filters( 'cmb2_style_dependencies', array() );
- wp_register_style( 'cmb2-styles', CMB2_Utils::url( "css/cmb2{$front}{$rtl}{$min}.css" ), $dependencies );
- wp_register_style( 'cmb2-display-styles', CMB2_Utils::url( "css/cmb2-display{$rtl}{$min}.css" ), $dependencies );
-
- self::$css_registration_done = true;
- }
-
- /**
- * Registers scripts for CMB2
- * @since 2.0.7
- */
- protected static function register_js() {
- if ( self::$js_registration_done ) {
- return;
- }
-
- $hook = is_admin() ? 'admin_footer' : 'wp_footer';
- add_action( $hook, array( 'CMB2_JS', 'enqueue' ), 8 );
-
- self::$js_registration_done = true;
- }
-
- /**
- * Registers scripts and styles for CMB2
- * @since 1.0.0
- */
- public static function register_scripts() {
- self::register_styles();
- self::register_js();
- }
-
/**
* Enqueues scripts and styles for CMB2 in admin_head.
+ *
* @since 1.0.0
*/
public function do_scripts( $hook ) {
@@ -233,8 +313,24 @@ public function do_scripts( $hook ) {
}
}
+ /**
+ * Includes CMB2 JS
+ *
+ * @since 2.0.0
+ */
+ public static function enqueue_cmb_js() {
+ if ( ! apply_filters( 'cmb2_enqueue_js', true ) ) {
+ return false;
+ }
+
+ self::register_js();
+
+ return true;
+ }
+
/**
* Register the CMB2 field column headers.
+ *
* @since 2.2.2
*/
public function register_column_headers( $columns ) {
@@ -253,25 +349,39 @@ public function register_column_headers( $columns ) {
} else {
- $before = array_slice( $columns, 0, absint( $column['position'] ) );
+ $before = array_slice( $columns, 0, absint( $column['position'] ) );
$before[ $field['id'] ] = $column['name'];
- $columns = $before + $columns;
+ $columns = $before + $columns;
}
- $column['field'] = $field;
+ $column['field'] = $field;
$this->columns[ $field['id'] ] = $column;
}
return $columns;
}
+ /**
+ * Returns the column display.
+ *
+ * @since 2.2.2
+ */
+ public function return_column_display( $empty, $custom_column, $object_id ) {
+ ob_start();
+ $this->column_display( $custom_column, $object_id );
+ $column = ob_get_clean();
+
+ return $column ? $column : $empty;
+ }
+
/**
* The CMB2 field column display output.
+ *
* @since 2.2.2
*/
public function column_display( $column_name, $object_id ) {
if ( isset( $this->columns[ $column_name ] ) ) {
- $field = new CMB2_Field( array(
+ $field = new CMB2_Field( array(
'field_args' => $this->columns[ $column_name ]['field'],
'object_type' => $this->object_type,
'object_id' => $this->cmb->object_id( $object_id ),
@@ -282,20 +392,9 @@ public function column_display( $column_name, $object_id ) {
}
}
- /**
- * Returns the column display.
- * @since 2.2.2
- */
- public function return_column_display( $empty, $custom_column, $object_id ) {
- ob_start();
- $this->column_display( $custom_column, $object_id );
- $column = ob_get_clean();
-
- return $column ? $column : $empty;
- }
-
/**
* Add metaboxes (to 'post' or 'comment' object types)
+ *
* @since 1.0.0
*/
public function add_metaboxes() {
@@ -319,20 +418,50 @@ public function add_metaboxes() {
foreach ( $this->cmb->prop( 'object_types' ) as $post_type ) {
if ( $this->cmb->prop( 'closed' ) ) {
- add_filter( "postbox_classes_{$post_type}_{$this->cmb->cmb_id}", array( $this, 'close_metabox_class' ) );
+ add_filter( "postbox_classes_{$post_type}_{$this->cmb->cmb_id}", array(
+ $this,
+ 'close_metabox_class'
+ ) );
}
if ( count( $this->cmb->tax_metaboxes_to_remove ) ) {
$this->remove_default_tax_metaboxes( $post_type );
}
- add_meta_box( $this->cmb->cmb_id, $this->cmb->prop( 'title' ), array( $this, 'metabox_callback' ), $post_type, $this->cmb->prop( 'context' ), $this->cmb->prop( 'priority' ) );
+ add_meta_box( $this->cmb->cmb_id, $this->cmb->prop( 'title' ), array(
+ $this,
+ 'metabox_callback'
+ ), $post_type, $this->cmb->prop( 'context' ), $this->cmb->prop( 'priority' ) );
}
}
+ /**
+ * Determines if metabox should be shown in current context
+ *
+ * @since 2.0.0
+ * @return bool Whether metabox should be added/shown
+ */
+ public function show_on() {
+ // If metabox is requesting to be conditionally shown
+ $show = $this->cmb->should_show();
+
+ /**
+ * Filter to determine if metabox should show. Default is true
+ *
+ * @param array $show Default is true, show the metabox
+ * @param mixed $meta_box_args Array of the metabox arguments
+ * @param mixed $cmb The CMB2 instance
+ */
+ $show = (bool) apply_filters( 'cmb2_show_on', $show, $this->cmb->meta_box, $this->cmb );
+
+ return $show;
+ }
+
/**
* Remove the specified default taxonomy metaboxes for a post-type.
+ *
* @since 2.2.3
+ *
* @param string $post_type Post type to remove the metabox for.
*/
protected function remove_default_tax_metaboxes( $post_type ) {
@@ -348,17 +477,22 @@ protected function remove_default_tax_metaboxes( $post_type ) {
/**
* Add 'closed' class to metabox
+ *
* @since 2.0.0
- * @param array $classes Array of classes
+ *
+ * @param array $classes Array of classes
+ *
* @return array Modified array of classes
*/
public function close_metabox_class( $classes ) {
$classes[] = 'closed';
+
return $classes;
}
/**
* Display metaboxes for a post or comment object
+ *
* @since 1.0.0
*/
public function metabox_callback() {
@@ -368,6 +502,7 @@ public function metabox_callback() {
/**
* Display metaboxes for new user page
+ *
* @since 1.0.0
*/
public function user_new_metabox( $section ) {
@@ -380,24 +515,20 @@ public function user_new_metabox( $section ) {
/**
* Display metaboxes for a user object
+ *
* @since 1.0.0
*/
public function user_metabox() {
$this->show_form_for_type( 'user' );
}
- /**
- * Display metaboxes for a taxonomy term object
- * @since 2.2.0
- */
- public function term_metabox() {
- $this->show_form_for_type( 'term' );
- }
-
/**
* Display metaboxes for an object type
+ *
* @since 2.2.0
+ *
* @param string $type Object type
+ *
* @return void
*/
public function show_form_for_type( $type ) {
@@ -420,60 +551,22 @@ public function show_form_for_type( $type ) {
}
/**
- * Determines if metabox should be shown in current context
- * @since 2.0.0
- * @return bool Whether metabox should be added/shown
- */
- public function show_on() {
- // If metabox is requesting to be conditionally shown
- $show = $this->cmb->should_show();
-
- /**
- * Filter to determine if metabox should show. Default is true
- *
- * @param array $show Default is true, show the metabox
- * @param mixed $meta_box_args Array of the metabox arguments
- * @param mixed $cmb The CMB2 instance
- */
- $show = (bool) apply_filters( 'cmb2_show_on', $show, $this->cmb->meta_box, $this->cmb );
-
- return $show;
- }
-
- /**
- * Get the CMB priority property set to numeric hook priority.
+ * Display metaboxes for a taxonomy term object
+ *
* @since 2.2.0
- * @param integer $default Default display hook priority.
- * @return integer Hook priority.
*/
- public function get_priority( $default = 10 ) {
- $priority = $this->cmb->prop( 'priority' );
-
- if ( ! is_numeric( $priority ) ) {
- switch ( $priority ) {
-
- case 'high':
- $priority = 5;
- break;
-
- case 'low':
- $priority = 20;
- break;
-
- default:
- $priority = $default;
- break;
- }
- }
-
- return $priority;
+ public function term_metabox() {
+ $this->show_form_for_type( 'term' );
}
/**
* Save data from post metabox
+ *
* @since 1.0.0
- * @param int $post_id Post ID
- * @param mixed $post Post object
+ *
+ * @param int $post_id Post ID
+ * @param mixed $post Post object
+ *
* @return null
*/
public function save_post( $post_id, $post = false ) {
@@ -496,10 +589,37 @@ public function save_post( $post_id, $post = false ) {
$this->cmb->save_fields( $post_id, 'post', $_POST );
}
+ /**
+ * Determines if the current object is able to be saved
+ *
+ * @since 2.0.9
+ *
+ * @param string $type Current post_type or comment_type
+ *
+ * @return bool Whether object can be saved
+ */
+ public function can_save( $type = '' ) {
+ return apply_filters( 'cmb2_can_save', (
+ $this->cmb->prop( 'save_fields' )
+ // check nonce
+ && isset( $_POST[ $this->cmb->nonce() ] )
+ && wp_verify_nonce( $_POST[ $this->cmb->nonce() ], $this->cmb->nonce() )
+ // check if autosave
+ && ! ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE )
+ // get the metabox types & compare it to this type
+ && ( $type && in_array( $type, $this->cmb->prop( 'object_types' ) ) )
+ // Don't do updates during a switch-to-blog instance.
+ && ! ( is_multisite() && ms_is_switched() )
+ ) );
+ }
+
/**
* Save data from comment metabox
+ *
* @since 2.0.9
- * @param int $comment_id Comment ID
+ *
+ * @param int $comment_id Comment ID
+ *
* @return null
*/
public function save_comment( $comment_id ) {
@@ -513,8 +633,11 @@ public function save_comment( $comment_id ) {
/**
* Save data from user fields
+ *
* @since 1.0.x
- * @param int $user_id User ID
+ *
+ * @param int $user_id User ID
+ *
* @return null
*/
public function save_user( $user_id ) {
@@ -526,10 +649,13 @@ public function save_user( $user_id ) {
/**
* Save data from term fields
+ *
* @since 2.2.0
+ *
* @param int $term_id Term ID
* @param int $tt_id Term Taxonomy ID
* @param string $taxonomy Taxonomy
+ *
* @return null
*/
public function save_term( $term_id, $tt_id, $taxonomy = '' ) {
@@ -541,51 +667,13 @@ public function save_term( $term_id, $tt_id, $taxonomy = '' ) {
}
}
- /**
- * Delete term meta when a term is deleted.
- * @since 2.2.0
- * @param int $term_id Term ID
- * @param int $tt_id Term Taxonomy ID
- * @param string $taxonomy Taxonomy
- * @return null
- */
- public function delete_term( $term_id, $tt_id, $taxonomy = '' ) {
- if ( $this->taxonomy_can_save( $taxonomy ) ) {
-
- $data_to_delete = array();
- foreach ( $this->cmb->prop( 'fields' ) as $field ) {
- $data_to_delete[ $field['id'] ] = '';
- }
-
- $this->cmb->save_fields( $term_id, 'term', $data_to_delete );
- }
- }
-
- /**
- * Determines if the current object is able to be saved
- * @since 2.0.9
- * @param string $type Current post_type or comment_type
- * @return bool Whether object can be saved
- */
- public function can_save( $type = '' ) {
- return apply_filters( 'cmb2_can_save', (
- $this->cmb->prop( 'save_fields' )
- // check nonce
- && isset( $_POST[ $this->cmb->nonce() ] )
- && wp_verify_nonce( $_POST[ $this->cmb->nonce() ], $this->cmb->nonce() )
- // check if autosave
- && ! ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE )
- // get the metabox types & compare it to this type
- && ( $type && in_array( $type, $this->cmb->prop( 'object_types' ) ) )
- // Don't do updates during a switch-to-blog instance.
- && ! ( is_multisite() && ms_is_switched() )
- ) );
- }
-
/**
* Determine if taxonomy of term being modified is cmb2-editable.
+ *
* @since 2.2.0
+ *
* @param string $taxonomy Taxonomy of term being modified.
+ *
* @return bool Whether taxonomy is editable.
*/
public function taxonomy_can_save( $taxonomy ) {
@@ -603,50 +691,26 @@ public function taxonomy_can_save( $taxonomy ) {
}
/**
- * Enqueues the 'cmb2-display-styles' if the conditions match (has columns, on the right page, etc).
- * @since 2.2.2.1
- */
- protected function maybe_enqueue_column_display_styles() {
- global $pagenow;
- if (
- $pagenow
- && $this->cmb->has_columns
- && $this->cmb->prop( 'cmb_styles' )
- && in_array( $pagenow, array( 'edit.php', 'users.php', 'edit-comments.php', 'edit-tags.php' ), 1 )
- ) {
- self::enqueue_cmb_css( 'cmb2-display-styles' );
- }
- }
-
- /**
- * Includes CMB2 styles
- * @since 2.0.0
+ * Delete term meta when a term is deleted.
+ *
+ * @since 2.2.0
+ *
+ * @param int $term_id Term ID
+ * @param int $tt_id Term Taxonomy ID
+ * @param string $taxonomy Taxonomy
+ *
+ * @return null
*/
- public static function enqueue_cmb_css( $handle = 'cmb2-styles' ) {
- if ( ! apply_filters( 'cmb2_enqueue_css', true ) ) {
- return false;
- }
-
- self::register_styles();
+ public function delete_term( $term_id, $tt_id, $taxonomy = '' ) {
+ if ( $this->taxonomy_can_save( $taxonomy ) ) {
- /*
- * White list the options as this method can be used as a hook callback
- * and have a different argument passed.
- */
- return wp_enqueue_style( 'cmb2-display-styles' === $handle ? $handle : 'cmb2-styles' );
- }
+ $data_to_delete = array();
+ foreach ( $this->cmb->prop( 'fields' ) as $field ) {
+ $data_to_delete[ $field['id'] ] = '';
+ }
- /**
- * Includes CMB2 JS
- * @since 2.0.0
- */
- public static function enqueue_cmb_js() {
- if ( ! apply_filters( 'cmb2_enqueue_js', true ) ) {
- return false;
+ $this->cmb->save_fields( $term_id, 'term', $data_to_delete );
}
-
- self::register_js();
- return true;
}
}
diff --git a/includes/CMB2/includes/helper-functions.php b/includes/CMB2/includes/helper-functions.php
index 0e14102..29ae38d 100755
--- a/includes/CMB2/includes/helper-functions.php
+++ b/includes/CMB2/includes/helper-functions.php
@@ -12,8 +12,11 @@
/**
* Helper function to provide directory path to CMB2
+ *
* @since 2.0.0
- * @param string $path Path to append
+ *
+ * @param string $path Path to append
+ *
* @return string Directory with optional path appended
*/
function cmb2_dir( $path = '' ) {
@@ -22,7 +25,9 @@ function cmb2_dir( $path = '' ) {
/**
* Autoloads files with CMB2 classes when needed
+ *
* @since 1.0.0
+ *
* @param string $class_name Name of the class being requested
*/
function cmb2_autoload_classes( $class_name ) {
@@ -45,17 +50,20 @@ function cmb2_autoload_classes( $class_name ) {
/**
* Get instance of the CMB2_Utils class
+ *
* @since 2.0.0
* @return CMB2_Utils object CMB2 utilities class
*/
function cmb2_utils() {
static $cmb2_utils;
$cmb2_utils = $cmb2_utils ? $cmb2_utils : new CMB2_Utils();
+
return $cmb2_utils;
}
/**
* Get instance of the CMB2_Ajax class
+ *
* @since 2.0.0
* @return CMB2_Ajax object CMB2 ajax class
*/
@@ -65,6 +73,7 @@ function cmb2_ajax() {
/**
* Get instance of the CMB2_Option class for the passed metabox ID
+ *
* @since 2.0.0
* @return CMB2_Option object Options class for setting/getting options for metabox
*/
@@ -74,8 +83,10 @@ function cmb2_options( $key ) {
/**
* Get a cmb oEmbed. Handles oEmbed getting for non-post objects
+ *
* @since 2.0.0
- * @param array $args Arguments. Accepts:
+ *
+ * @param array $args Arguments. Accepts:
*
* 'url' - URL to retrieve the oEmbed from,
* 'object_id' - $post_id,
@@ -96,7 +107,7 @@ function cmb2_get_oembed( $args = array() ) {
}
$error = sprintf(
- /* translators: 1: results for. 2: link to codex.wordpress.org/Embeds */
+ /* translators: 1: results for. 2: link to codex.wordpress.org/Embeds */
esc_html__( 'No oEmbed Results Found for %1$s. View more info at %2$s.', 'cmb2' ),
$oembed['fallback'],
'codex.wordpress.org/Embeds'
@@ -112,20 +123,25 @@ function cmb2_get_oembed( $args = array() ) {
/**
* Outputs the return of cmb2_get_oembed.
+ *
* @since 2.2.2
- * @see cmb2_get_oembed
+ * @see cmb2_get_oembed
*/
function cmb2_do_oembed( $args = array() ) {
echo cmb2_get_oembed( $args );
}
+
add_action( 'cmb2_do_oembed', 'cmb2_do_oembed' );
/**
* A helper function to get an option from a CMB2 options array
+ *
* @since 1.0.1
- * @param string $option_key Option key
- * @param string $field_id Option array field key
- * @param mixed $default Optional default fallback value
+ *
+ * @param string $option_key Option key
+ * @param string $field_id Option array field key
+ * @param mixed $default Optional default fallback value
+ *
* @return array Options array or specific field
*/
function cmb2_get_option( $option_key, $field_id = '', $default = false ) {
@@ -134,11 +150,14 @@ function cmb2_get_option( $option_key, $field_id = '', $default = false ) {
/**
* A helper function to update an option in a CMB2 options array
+ *
* @since 2.0.0
+ *
* @param string $option_key Option key
* @param string $field_id Option array field key
* @param mixed $value Value to update data with
* @param boolean $single Whether data should not be an array
+ *
* @return boolean Success/Failure
*/
function cmb2_update_option( $option_key, $field_id, $value, $single = true ) {
@@ -151,18 +170,21 @@ function cmb2_update_option( $option_key, $field_id, $value, $single = true ) {
/**
* Get a CMB2 field object.
+ *
* @since 1.1.0
+ *
* @param array $meta_box Metabox ID or Metabox config array
* @param array $field_id Field ID or all field arguments
* @param int $object_id Object ID
* @param string $object_type Type of object being saved. (e.g., post, user, comment, or options-page).
* Defaults to metabox object type.
+ *
* @return CMB2_Field|null CMB2_Field object unless metabox config cannot be found
*/
function cmb2_get_field( $meta_box, $field_id, $object_id = 0, $object_type = '' ) {
$object_id = $object_id ? $object_id : get_the_ID();
- $cmb = $meta_box instanceof CMB2 ? $meta_box : cmb2_get_metabox( $meta_box, $object_id );
+ $cmb = $meta_box instanceof CMB2 ? $meta_box : cmb2_get_metabox( $meta_box, $object_id );
if ( ! $cmb ) {
return;
@@ -175,23 +197,30 @@ function cmb2_get_field( $meta_box, $field_id, $object_id = 0, $object_type = ''
/**
* Get a field's value.
+ *
* @since 1.1.0
+ *
* @param array $meta_box Metabox ID or Metabox config array
* @param array $field_id Field ID or all field arguments
* @param int $object_id Object ID
* @param string $object_type Type of object being saved. (e.g., post, user, comment, or options-page).
* Defaults to metabox object type.
+ *
* @return mixed Maybe escaped value
*/
function cmb2_get_field_value( $meta_box, $field_id, $object_id = 0, $object_type = '' ) {
$field = cmb2_get_field( $meta_box, $field_id, $object_id, $object_type );
+
return $field->escaped_value();
}
/**
* Because OOP can be scary
+ *
* @since 2.0.2
+ *
* @param array $meta_box_config Metabox Config array
+ *
* @return CMB2 object Instantiated CMB2 object
*/
function new_cmb2_box( array $meta_box_config ) {
@@ -200,11 +229,14 @@ function new_cmb2_box( array $meta_box_config ) {
/**
* Retrieve a CMB2 instance by the metabox ID
+ *
* @since 2.0.0
+ *
* @param mixed $meta_box Metabox ID or Metabox config array
* @param int $object_id Object ID
* @param string $object_type Type of object being saved. (e.g., post, user, comment, or options-page).
* Defaults to metabox object type.
+ *
* @return CMB2 object
*/
function cmb2_get_metabox( $meta_box, $object_id = 0, $object_type = '' ) {
@@ -235,22 +267,29 @@ function cmb2_get_metabox( $meta_box, $object_id = 0, $object_type = '' ) {
/**
* Returns array of sanitized field values from a metabox (without saving them)
+ *
* @since 2.0.3
+ *
* @param mixed $meta_box Metabox ID or Metabox config array
* @param array $data_to_sanitize Array of field_id => value data for sanitizing (likely $_POST data).
+ *
* @return mixed Array of sanitized values or false if no CMB2 object found
*/
function cmb2_get_metabox_sanitized_values( $meta_box, array $data_to_sanitize ) {
$cmb = cmb2_get_metabox( $meta_box );
+
return $cmb ? $cmb->get_sanitized_values( $data_to_sanitize ) : false;
}
/**
* Retrieve a metabox form
+ *
* @since 2.0.0
- * @param mixed $meta_box Metabox config array or Metabox ID
- * @param int $object_id Object ID
- * @param array $args Optional arguments array
+ *
+ * @param mixed $meta_box Metabox config array or Metabox ID
+ * @param int $object_id Object ID
+ * @param array $args Optional arguments array
+ *
* @return string CMB2 html form markup
*/
function cmb2_get_metabox_form( $meta_box, $object_id = 0, $args = array() ) {
@@ -268,15 +307,17 @@ function cmb2_get_metabox_form( $meta_box, $object_id = 0, $args = array() ) {
/**
* Display a metabox form & save it on submission
+ *
* @since 1.0.0
- * @param mixed $meta_box Metabox config array or Metabox ID
- * @param int $object_id Object ID
- * @param array $args Optional arguments array
+ *
+ * @param mixed $meta_box Metabox config array or Metabox ID
+ * @param int $object_id Object ID
+ * @param array $args Optional arguments array
*/
function cmb2_print_metabox_form( $meta_box, $object_id = 0, $args = array() ) {
$object_id = $object_id ? $object_id : get_the_ID();
- $cmb = cmb2_get_metabox( $meta_box, $object_id );
+ $cmb = cmb2_get_metabox( $meta_box, $object_id );
// if passing a metabox ID, and that ID was not found
if ( ! $cmb ) {
@@ -332,10 +373,12 @@ function cmb2_print_metabox_form( $meta_box, $object_id = 0, $args = array() ) {
/**
* Display a metabox form (or optionally return it) & save it on submission
+ *
* @since 1.0.0
- * @param mixed $meta_box Metabox config array or Metabox ID
- * @param int $object_id Object ID
- * @param array $args Optional arguments array
+ *
+ * @param mixed $meta_box Metabox config array or Metabox ID
+ * @param int $object_id Object ID
+ * @param array $args Optional arguments array
*/
function cmb2_metabox_form( $meta_box, $object_id = 0, $args = array() ) {
if ( ! isset( $args['echo'] ) || $args['echo'] ) {
@@ -360,7 +403,7 @@ function date_create_from_format( $date_format, $date_value ) {
$schedule_format = str_replace(
array( 'M', 'Y', 'm', 'd', 'H', 'i', 'a' ),
- array('%b', '%Y', '%m', '%d', '%H', '%M', '%p' ),
+ array( '%b', '%Y', '%m', '%d', '%H', '%M', '%p' ),
$date_format
);
@@ -371,11 +414,11 @@ function date_create_from_format( $date_format, $date_value ) {
$parsed_time = strptime( $date_value, $schedule_format );
$ymd = sprintf(
- /*
- * This is a format string that takes six total decimal
- * arguments, then left-pads them with zeros to either
- * 4 or 2 characters, as needed
- */
+ /*
+ * This is a format string that takes six total decimal
+ * arguments, then left-pads them with zeros to either
+ * 4 or 2 characters, as needed
+ */
'%04d-%02d-%02d %02d:%02d:%02d',
$parsed_time['tm_year'] + 1900, // This will be "111", so we need to add 1900.
$parsed_time['tm_mon'] + 1, // This will be the month minus one, so we add one.
@@ -385,6 +428,6 @@ function date_create_from_format( $date_format, $date_value ) {
$parsed_time['tm_sec']
);
- return new DateTime($ymd);
+ return new DateTime( $ymd );
}
}
diff --git a/includes/CMB2/includes/rest-api/CMB2_REST.php b/includes/CMB2/includes/rest-api/CMB2_REST.php
index 8ecfbca..dc92902 100755
--- a/includes/CMB2/includes/rest-api/CMB2_REST.php
+++ b/includes/CMB2/includes/rest-api/CMB2_REST.php
@@ -1,10 +1,11 @@
array(),
- 'user' => array(),
+ 'post' => array(),
+ 'user' => array(),
'comment' => array(),
- 'term' => array(),
+ 'term' => array(),
);
-
+ /**
+ * @var CMB2 object
+ * @since 2.2.3
+ */
+ public $cmb;
/**
* Array of readable field objects.
+ *
* @var CMB2_Field[]
* @since 2.2.3
*/
@@ -65,6 +65,7 @@ class CMB2_REST extends CMB2_Hookup_Base {
/**
* Array of editable field objects.
+ *
* @var CMB2_Field[]
* @since 2.2.3
*/
@@ -72,12 +73,14 @@ class CMB2_REST extends CMB2_Hookup_Base {
/**
* Whether CMB2 object is readable via the rest api.
+ *
* @var boolean
*/
protected $rest_read = false;
/**
* Whether CMB2 object is editable via the rest api.
+ *
* @var boolean
*/
protected $rest_edit = false;
@@ -90,7 +93,7 @@ class CMB2_REST extends CMB2_Hookup_Base {
* @param CMB2 $cmb The CMB2 object to be registered for the API.
*/
public function __construct( CMB2 $cmb ) {
- $this->cmb = $cmb;
+ $this->cmb = $cmb;
self::$boxes[ $cmb->cmb_id ] = $this;
$show_value = $this->cmb->prop( 'show_in_rest' );
@@ -100,23 +103,40 @@ public function __construct( CMB2 $cmb ) {
}
/**
- * Hooks to register on frontend and backend.
+ * Checks if given value is readable.
+ *
+ * Value is considered readable if it is not empty and if it does not match the editable blacklist.
*
* @since 2.2.3
*
- * @return void
+ * @param mixed $value Value to check.
+ *
+ * @return boolean Whether value is considered readable.
*/
- public function universal_hooks() {
- // hook up the CMB rest endpoint classes
- $this->once( 'rest_api_init', array( __CLASS__, 'init_routes' ), 0 );
-
- if ( function_exists( 'register_rest_field' ) ) {
- $this->once( 'rest_api_init', array( __CLASS__, 'register_cmb2_fields' ), 50 );
- }
-
- $this->declare_read_edit_fields();
+ public static function is_readable( $value ) {
+ return ! empty( $value ) && ! in_array( $value, array(
+ WP_REST_Server::CREATABLE,
+ WP_REST_Server::EDITABLE,
+ WP_REST_Server::DELETABLE,
+ ), true );
+ }
- add_filter( 'is_protected_meta', array( $this, 'is_protected_meta' ), 10, 3 );
+ /**
+ * Checks if given value is editable.
+ *
+ * Value is considered editable if matches the editable whitelist.
+ *
+ * @since 2.2.3
+ *
+ * @param mixed $value Value to check.
+ *
+ * @return boolean Whether value is considered editable.
+ */
+ public static function is_editable( $value ) {
+ return in_array( $value, array(
+ WP_REST_Server::EDITABLE,
+ WP_REST_Server::ALLMETHODS,
+ ), true );
}
/**
@@ -171,7 +191,7 @@ public static function register_cmb2_fields() {
}
if ( ! empty( $types ) ) {
- $alltypes = array_merge( $alltypes, array_flip( $types ) );
+ $alltypes = array_merge( $alltypes, array_flip( $types ) );
self::$type_boxes['post'][ $cmb_id ] = $cmb_id;
}
}
@@ -202,7 +222,7 @@ public static function register_cmb2_fields() {
*
* @param string|array $object_types Object(s) the field is being registered
* to, "post"|"term"|"comment" etc.
- * @param string $object_types Canonical object type for callbacks.
+ * @param string $object_types Canonical object type for callbacks.
*
* @return void
*/
@@ -214,72 +234,6 @@ protected static function register_rest_field( $object_types, $object_type ) {
) );
}
- /**
- * Setup readable and editable fields.
- *
- * @since 2.2.3
- *
- * @return void
- */
- protected function declare_read_edit_fields() {
- foreach ( $this->cmb->prop( 'fields' ) as $field ) {
- $show_in_rest = isset( $field['show_in_rest'] ) ? $field['show_in_rest'] : null;
-
- if ( false === $show_in_rest ) {
- continue;
- }
-
- if ( $this->can_read( $show_in_rest ) ) {
- $this->read_fields[] = $field['id'];
- }
-
- if ( $this->can_edit( $show_in_rest ) ) {
- $this->edit_fields[] = $field['id'];
- }
-
- }
- }
-
- /**
- * Determines if a field is readable based on it's show_in_rest value
- * and the box's show_in_rest value.
- *
- * @since 2.2.3
- *
- * @param bool $show_in_rest Field's show_in_rest value. Default null.
- *
- * @return bool Whether field is readable.
- */
- protected function can_read( $show_in_rest ) {
- // if 'null', then use default box value.
- if ( null === $show_in_rest ) {
- return $this->rest_read;
- }
-
- // Else check if the value represents readable.
- return self::is_readable( $show_in_rest );
- }
-
- /**
- * Determines if a field is editable based on it's show_in_rest value
- * and the box's show_in_rest value.
- *
- * @since 2.2.3
- *
- * @param bool $show_in_rest Field's show_in_rest value. Default null.
- *
- * @return bool Whether field is editable.
- */
- protected function can_edit( $show_in_rest ) {
- // if 'null', then use default box value.
- if ( null === $show_in_rest ) {
- return $this->rest_edit;
- }
-
- // Else check if the value represents editable.
- return self::is_editable( $show_in_rest );
- }
-
/**
* Handler for getting post custom field data.
*
@@ -298,60 +252,6 @@ public static function get_post_rest_values( $object, $field_name, $request, $ob
}
}
- /**
- * Handler for getting user custom field data.
- *
- * @since 2.2.3
- *
- * @param array $object The object data from the response
- * @param string $field_name Name of field
- * @param WP_REST_Request $request Current request
- * @param string $object_type The request object type
- *
- * @return mixed
- */
- public static function get_user_rest_values( $object, $field_name, $request, $object_type ) {
- if ( 'cmb2' === $field_name ) {
- return self::get_rest_values( $object, $request, $object_type, 'user' );
- }
- }
-
- /**
- * Handler for getting comment custom field data.
- *
- * @since 2.2.3
- *
- * @param array $object The object data from the response
- * @param string $field_name Name of field
- * @param WP_REST_Request $request Current request
- * @param string $object_type The request object type
- *
- * @return mixed
- */
- public static function get_comment_rest_values( $object, $field_name, $request, $object_type ) {
- if ( 'cmb2' === $field_name ) {
- return self::get_rest_values( $object, $request, $object_type, 'comment' );
- }
- }
-
- /**
- * Handler for getting term custom field data.
- *
- * @since 2.2.3
- *
- * @param array $object The object data from the response
- * @param string $field_name Name of field
- * @param WP_REST_Request $request Current request
- * @param string $object_type The request object type
- *
- * @return mixed
- */
- public static function get_term_rest_values( $object, $field_name, $request, $object_type ) {
- if ( 'cmb2' === $field_name ) {
- return self::get_rest_values( $object, $request, $object_type, 'term' );
- }
- }
-
/**
* Handler for getting custom field data.
*
@@ -393,64 +293,61 @@ protected static function get_rest_values( $object, $request, $object_type, $mai
}
/**
- * Handler for updating post custom field data.
+ * Handler for getting user custom field data.
*
* @since 2.2.3
*
- * @param mixed $values The value of the field
- * @param object $object The object from the response
+ * @param array $object The object data from the response
* @param string $field_name Name of field
* @param WP_REST_Request $request Current request
* @param string $object_type The request object type
*
- * @return bool|int
+ * @return mixed
*/
- public static function update_post_rest_values( $values, $object, $field_name, $request, $object_type ) {
+ public static function get_user_rest_values( $object, $field_name, $request, $object_type ) {
if ( 'cmb2' === $field_name ) {
- return self::update_rest_values( $values, $object, $request, $object_type, 'post' );
+ return self::get_rest_values( $object, $request, $object_type, 'user' );
}
}
/**
- * Handler for updating user custom field data.
+ * Handler for getting comment custom field data.
*
* @since 2.2.3
*
- * @param mixed $values The value of the field
- * @param object $object The object from the response
+ * @param array $object The object data from the response
* @param string $field_name Name of field
* @param WP_REST_Request $request Current request
* @param string $object_type The request object type
*
- * @return bool|int
+ * @return mixed
*/
- public static function update_user_rest_values( $values, $object, $field_name, $request, $object_type ) {
+ public static function get_comment_rest_values( $object, $field_name, $request, $object_type ) {
if ( 'cmb2' === $field_name ) {
- return self::update_rest_values( $values, $object, $request, $object_type, 'user' );
+ return self::get_rest_values( $object, $request, $object_type, 'comment' );
}
}
/**
- * Handler for updating comment custom field data.
+ * Handler for getting term custom field data.
*
* @since 2.2.3
*
- * @param mixed $values The value of the field
- * @param object $object The object from the response
+ * @param array $object The object data from the response
* @param string $field_name Name of field
* @param WP_REST_Request $request Current request
* @param string $object_type The request object type
*
- * @return bool|int
+ * @return mixed
*/
- public static function update_comment_rest_values( $values, $object, $field_name, $request, $object_type ) {
+ public static function get_term_rest_values( $object, $field_name, $request, $object_type ) {
if ( 'cmb2' === $field_name ) {
- return self::update_rest_values( $values, $object, $request, $object_type, 'comment' );
+ return self::get_rest_values( $object, $request, $object_type, 'term' );
}
}
/**
- * Handler for updating term custom field data.
+ * Handler for updating post custom field data.
*
* @since 2.2.3
*
@@ -462,9 +359,9 @@ public static function update_comment_rest_values( $values, $object, $field_name
*
* @return bool|int
*/
- public static function update_term_rest_values( $values, $object, $field_name, $request, $object_type ) {
+ public static function update_post_rest_values( $values, $object, $field_name, $request, $object_type ) {
if ( 'cmb2' === $field_name ) {
- return self::update_rest_values( $values, $object, $request, $object_type, 'term' );
+ return self::update_rest_values( $values, $object, $request, $object_type, 'post' );
}
}
@@ -512,12 +409,35 @@ protected static function update_rest_values( $values, $object, $request, $objec
return $updated;
}
+ protected static function get_object_id( $object, $object_type = 'post' ) {
+ switch ( $object_type ) {
+ case 'user':
+ case 'post':
+ if ( isset( $object->ID ) ) {
+ return intval( $object->ID );
+ }
+ case 'comment':
+ if ( isset( $object->comment_ID ) ) {
+ return intval( $object->comment_ID );
+ }
+ case 'term':
+ if ( is_array( $object ) && isset( $object['term_id'] ) ) {
+ return intval( $object['term_id'] );
+ } elseif ( isset( $object->term_id ) ) {
+ return intval( $object->term_id );
+ }
+ }
+
+ return 0;
+ }
+
/**
* Loop through box fields and sanitize the values.
*
* @since 2.2.o
*
- * @param array $values Array of values being provided.
+ * @param array $values Array of values being provided.
+ *
* @return array Array of updated/sanitized values.
*/
public function sanitize_box_values( array $values ) {
@@ -539,8 +459,8 @@ public function sanitize_box_values( array $values ) {
*
* @since 2.2.3
*
- * @param array $values Array of values being provided.
- * @param string $field_id The id of the field to update.
+ * @param array $values Array of values being provided.
+ * @param string $field_id The id of the field to update.
*
* @return mixed The results of saving/sanitizing a field value.
*/
@@ -570,8 +490,8 @@ protected function sanitize_field_value( array $values, $field_id ) {
*
* @since 2.2.3
*
- * @param array $values Array of values being provided.
- * @param CMB2_Field $field CMB2_Field object.
+ * @param array $values Array of values being provided.
+ * @param CMB2_Field $field CMB2_Field object.
*
* @return mixed The results of saving/sanitizing the group field value.
*/
@@ -587,89 +507,60 @@ protected function sanitize_group_value( array $values, CMB2_Field $field ) {
}
/**
- * Filter whether a meta key is protected.
- *
- * @since 2.2.3
- *
- * @param bool $protected Whether the key is protected. Default false.
- * @param string $meta_key Meta key.
- * @param string $meta_type Meta type.
- */
- public function is_protected_meta( $protected, $meta_key, $meta_type ) {
- if ( $this->field_can_edit( $meta_key ) ) {
- return false;
- }
-
- return $protected;
- }
-
- protected static function get_object_id( $object, $object_type = 'post' ) {
- switch ( $object_type ) {
- case 'user':
- case 'post':
- if ( isset( $object->ID ) ) {
- return intval( $object->ID );
- }
- case 'comment':
- if ( isset( $object->comment_ID ) ) {
- return intval( $object->comment_ID );
- }
- case 'term':
- if ( is_array( $object ) && isset( $object['term_id'] ) ) {
- return intval( $object['term_id'] );
- } elseif ( isset( $object->term_id ) ) {
- return intval( $object->term_id );
- }
- }
-
- return 0;
- }
-
- /**
- * Checks if a given field can be read.
+ * Handler for updating user custom field data.
*
* @since 2.2.3
*
- * @param string|CMB2_Field $field_id Field ID or CMB2_Field object.
- * @param boolean $return_object Whether to return the Field object.
+ * @param mixed $values The value of the field
+ * @param object $object The object from the response
+ * @param string $field_name Name of field
+ * @param WP_REST_Request $request Current request
+ * @param string $object_type The request object type
*
- * @return mixed False if field can't be read or true|CMB2_Field object.
+ * @return bool|int
*/
- public function field_can_read( $field_id, $return_object = false ) {
- return $this->field_can( 'read_fields', $field_id, $return_object );
+ public static function update_user_rest_values( $values, $object, $field_name, $request, $object_type ) {
+ if ( 'cmb2' === $field_name ) {
+ return self::update_rest_values( $values, $object, $request, $object_type, 'user' );
+ }
}
/**
- * Checks if a given field can be edited.
+ * Handler for updating comment custom field data.
*
* @since 2.2.3
*
- * @param string|CMB2_Field $field_id Field ID or CMB2_Field object.
- * @param boolean $return_object Whether to return the Field object.
+ * @param mixed $values The value of the field
+ * @param object $object The object from the response
+ * @param string $field_name Name of field
+ * @param WP_REST_Request $request Current request
+ * @param string $object_type The request object type
*
- * @return mixed False if field can't be edited or true|CMB2_Field object.
+ * @return bool|int
*/
- public function field_can_edit( $field_id, $return_object = false ) {
- return $this->field_can( 'edit_fields', $field_id, $return_object );
+ public static function update_comment_rest_values( $values, $object, $field_name, $request, $object_type ) {
+ if ( 'cmb2' === $field_name ) {
+ return self::update_rest_values( $values, $object, $request, $object_type, 'comment' );
+ }
}
/**
- * Checks if a given field can be read or edited.
+ * Handler for updating term custom field data.
*
* @since 2.2.3
*
- * @param string $type Whether we are checking for read or edit fields.
- * @param string|CMB2_Field $field_id Field ID or CMB2_Field object.
- * @param boolean $return_object Whether to return the Field object.
+ * @param mixed $values The value of the field
+ * @param object $object The object from the response
+ * @param string $field_name Name of field
+ * @param WP_REST_Request $request Current request
+ * @param string $object_type The request object type
*
- * @return mixed False if field can't be read or edited or true|CMB2_Field object.
+ * @return bool|int
*/
- protected function field_can( $type = 'read_fields', $field_id, $return_object = false ) {
- if ( ! in_array( $field_id instanceof CMB2_Field ? $field_id->id() : $field_id, $this->{$type}, true ) ) {
- return false;
+ public static function update_term_rest_values( $values, $object, $field_name, $request, $object_type ) {
+ if ( 'cmb2' === $field_name ) {
+ return self::update_rest_values( $values, $object, $request, $object_type, 'term' );
}
-
- return $return_object ? $this->cmb->get_field( $field_id ) : true;
}
/**
@@ -677,7 +568,7 @@ protected function field_can( $type = 'read_fields', $field_id, $return_object =
*
* @since 2.2.3
*
- * @param string $cmb_id CMB2 config id
+ * @param string $cmb_id CMB2 config id
*
* @return CMB2_REST|false The CMB2_REST object or false.
*/
@@ -709,46 +600,160 @@ public static function get_all() {
}
/**
- * Checks if given value is readable.
+ * Hooks to register on frontend and backend.
*
- * Value is considered readable if it is not empty and if it does not match the editable blacklist.
+ * @since 2.2.3
+ *
+ * @return void
+ */
+ public function universal_hooks() {
+ // hook up the CMB rest endpoint classes
+ $this->once( 'rest_api_init', array( __CLASS__, 'init_routes' ), 0 );
+
+ if ( function_exists( 'register_rest_field' ) ) {
+ $this->once( 'rest_api_init', array( __CLASS__, 'register_cmb2_fields' ), 50 );
+ }
+
+ $this->declare_read_edit_fields();
+
+ add_filter( 'is_protected_meta', array( $this, 'is_protected_meta' ), 10, 3 );
+ }
+
+ /**
+ * Setup readable and editable fields.
*
* @since 2.2.3
*
- * @param mixed $value Value to check.
+ * @return void
+ */
+ protected function declare_read_edit_fields() {
+ foreach ( $this->cmb->prop( 'fields' ) as $field ) {
+ $show_in_rest = isset( $field['show_in_rest'] ) ? $field['show_in_rest'] : null;
+
+ if ( false === $show_in_rest ) {
+ continue;
+ }
+
+ if ( $this->can_read( $show_in_rest ) ) {
+ $this->read_fields[] = $field['id'];
+ }
+
+ if ( $this->can_edit( $show_in_rest ) ) {
+ $this->edit_fields[] = $field['id'];
+ }
+
+ }
+ }
+
+ /**
+ * Determines if a field is readable based on it's show_in_rest value
+ * and the box's show_in_rest value.
*
- * @return boolean Whether value is considered readable.
+ * @since 2.2.3
+ *
+ * @param bool $show_in_rest Field's show_in_rest value. Default null.
+ *
+ * @return bool Whether field is readable.
*/
- public static function is_readable( $value ) {
- return ! empty( $value ) && ! in_array( $value, array(
- WP_REST_Server::CREATABLE,
- WP_REST_Server::EDITABLE,
- WP_REST_Server::DELETABLE,
- ), true );
+ protected function can_read( $show_in_rest ) {
+ // if 'null', then use default box value.
+ if ( null === $show_in_rest ) {
+ return $this->rest_read;
+ }
+
+ // Else check if the value represents readable.
+ return self::is_readable( $show_in_rest );
}
/**
- * Checks if given value is editable.
+ * Determines if a field is editable based on it's show_in_rest value
+ * and the box's show_in_rest value.
*
- * Value is considered editable if matches the editable whitelist.
+ * @since 2.2.3
+ *
+ * @param bool $show_in_rest Field's show_in_rest value. Default null.
+ *
+ * @return bool Whether field is editable.
+ */
+ protected function can_edit( $show_in_rest ) {
+ // if 'null', then use default box value.
+ if ( null === $show_in_rest ) {
+ return $this->rest_edit;
+ }
+
+ // Else check if the value represents editable.
+ return self::is_editable( $show_in_rest );
+ }
+
+ /**
+ * Filter whether a meta key is protected.
+ *
+ * @since 2.2.3
+ *
+ * @param bool $protected Whether the key is protected. Default false.
+ * @param string $meta_key Meta key.
+ * @param string $meta_type Meta type.
+ */
+ public function is_protected_meta( $protected, $meta_key, $meta_type ) {
+ if ( $this->field_can_edit( $meta_key ) ) {
+ return false;
+ }
+
+ return $protected;
+ }
+
+ /**
+ * Checks if a given field can be edited.
*
* @since 2.2.3
*
- * @param mixed $value Value to check.
+ * @param string|CMB2_Field $field_id Field ID or CMB2_Field object.
+ * @param boolean $return_object Whether to return the Field object.
*
- * @return boolean Whether value is considered editable.
+ * @return mixed False if field can't be edited or true|CMB2_Field object.
*/
- public static function is_editable( $value ) {
- return in_array( $value, array(
- WP_REST_Server::EDITABLE,
- WP_REST_Server::ALLMETHODS,
- ), true );
+ public function field_can_edit( $field_id, $return_object = false ) {
+ return $this->field_can( 'edit_fields', $field_id, $return_object );
+ }
+
+ /**
+ * Checks if a given field can be read or edited.
+ *
+ * @since 2.2.3
+ *
+ * @param string $type Whether we are checking for read or edit fields.
+ * @param string|CMB2_Field $field_id Field ID or CMB2_Field object.
+ * @param boolean $return_object Whether to return the Field object.
+ *
+ * @return mixed False if field can't be read or edited or true|CMB2_Field object.
+ */
+ protected function field_can( $type = 'read_fields', $field_id, $return_object = false ) {
+ if ( ! in_array( $field_id instanceof CMB2_Field ? $field_id->id() : $field_id, $this->{$type}, true ) ) {
+ return false;
+ }
+
+ return $return_object ? $this->cmb->get_field( $field_id ) : true;
+ }
+
+ /**
+ * Checks if a given field can be read.
+ *
+ * @since 2.2.3
+ *
+ * @param string|CMB2_Field $field_id Field ID or CMB2_Field object.
+ * @param boolean $return_object Whether to return the Field object.
+ *
+ * @return mixed False if field can't be read or true|CMB2_Field object.
+ */
+ public function field_can_read( $field_id, $return_object = false ) {
+ return $this->field_can( 'read_fields', $field_id, $return_object );
}
/**
* Magic getter for our object.
*
* @param string $field
+ *
* @throws Exception Throws an exception if the field is invalid.
*
* @return mixed
diff --git a/includes/CMB2/includes/rest-api/CMB2_REST_Controller.php b/includes/CMB2/includes/rest-api/CMB2_REST_Controller.php
index ab820fb..b4de407 100755
--- a/includes/CMB2/includes/rest-api/CMB2_REST_Controller.php
+++ b/includes/CMB2/includes/rest-api/CMB2_REST_Controller.php
@@ -9,10 +9,10 @@
* Creates CMB2 objects/fields endpoint for WordPres REST API.
* Allows access to fields registered to a specific post type and more.
*
- * @todo Add better documentation.
- * @todo Research proper schema.
+ * @todo Add better documentation.
+ * @todo Research proper schema.
*
- * @since 2.2.3
+ * @since 2.2.3
*
* @category WordPress_Plugin
* @package CMB2
@@ -23,21 +23,22 @@
abstract class CMB2_REST_Controller extends WP_REST_Controller {
/**
- * The namespace of this controller's route.
+ * The initial route
*
- * @var string
+ * @var string
+ * @since 2.2.3
*/
- protected $namespace = CMB2_REST::NAME_SPACE;
-
+ protected static $route = '';
/**
- * The base of this controller's route.
+ * Defines which endpoint the initial request is.
*
- * @var string
+ * @var string $request_type
+ * @since 2.2.3
*/
- protected $rest_base;
-
+ protected static $request_type = '';
/**
* The current request object
+ *
* @var WP_REST_Request $request
* @since 2.2.3
*/
@@ -45,6 +46,7 @@ abstract class CMB2_REST_Controller extends WP_REST_Controller {
/**
* The current server object
+ *
* @var WP_REST_Server $server
* @since 2.2.3
*/
@@ -52,6 +54,7 @@ abstract class CMB2_REST_Controller extends WP_REST_Controller {
/**
* Box object id
+ *
* @var mixed
* @since 2.2.3
*/
@@ -59,18 +62,29 @@ abstract class CMB2_REST_Controller extends WP_REST_Controller {
/**
* Box object type
+ *
* @var string
* @since 2.2.3
*/
public $object_type = '';
-
+ /**
+ * The namespace of this controller's route.
+ *
+ * @var string
+ */
+ protected $namespace = CMB2_REST::NAME_SPACE;
+ /**
+ * The base of this controller's route.
+ *
+ * @var string
+ */
+ protected $rest_base;
/**
* CMB2 Instance
*
* @var CMB2_REST
*/
protected $rest_box;
-
/**
* CMB2_Field Instance
*
@@ -79,25 +93,34 @@ abstract class CMB2_REST_Controller extends WP_REST_Controller {
protected $field;
/**
- * The initial route
- * @var string
+ * Constructor
+ *
* @since 2.2.3
*/
- protected static $route = '';
+ public function __construct( WP_REST_Server $wp_rest_server ) {
+ $this->server = $wp_rest_server;
+ }
/**
- * Defines which endpoint the initial request is.
- * @var string $request_type
- * @since 2.2.3
+ * Useful when getting `_embed`-ed items
+ *
+ * @since 2.2.3
+ *
+ * @return string Initial requested type.
*/
- protected static $request_type = '';
+ public static function get_intial_request_type() {
+ return self::$request_type;
+ }
/**
- * Constructor
- * @since 2.2.3
+ * Useful when getting `_embed`-ed items
+ *
+ * @since 2.2.3
+ *
+ * @return string Initial requested route.
*/
- public function __construct( WP_REST_Server $wp_rest_server ) {
- $this->server = $wp_rest_server;
+ public static function get_intial_route() {
+ return self::$route;
}
/**
@@ -187,18 +210,45 @@ public function maybe_unhook_registered_callback( $filter ) {
* @since 2.2.3
*
* @param mixed $data
+ *
* @return array $data
*/
public function prepare_item( $data ) {
return $this->prepare_item_for_response( $data, $this->request );
}
+ /**
+ * Prepare the CMB2 item for the REST response.
+ *
+ * @since 2.2.3
+ *
+ * @param mixed $item WordPress representation of the item.
+ * @param WP_REST_Request $request Request object.
+ *
+ * @return WP_REST_Response $response
+ */
+ public function prepare_item_for_response( $data, $request = null ) {
+ $data = $this->filter_response_by_context( $data, $this->request['context'] );
+
+ /**
+ * Filter the prepared CMB2 item response.
+ *
+ * @since 2.2.3
+ *
+ * @param mixed $data Prepared data
+ * @param object $request The WP_REST_Request object
+ * @param object $cmb2_endpoints This endpoints object
+ */
+ return apply_filters( 'cmb2_rest_prepare', rest_ensure_response( $data ), $this->request, $this );
+ }
+
/**
* Output buffers a callback and returns the results.
*
* @since 2.2.3
*
* @param mixed $cb Callable function/method.
+ *
* @return mixed Results of output buffer after calling function/method.
*/
public function get_cb_results( $cb ) {
@@ -211,49 +261,71 @@ public function get_cb_results( $cb ) {
}
/**
- * Prepare the CMB2 item for the REST response.
+ * Get CMB2 fields schema, conforming to JSON Schema
*
* @since 2.2.3
*
- * @param mixed $item WordPress representation of the item.
- * @param WP_REST_Request $request Request object.
- * @return WP_REST_Response $response
+ * @return array
*/
- public function prepare_item_for_response( $data, $request = null ) {
- $data = $this->filter_response_by_context( $data, $this->request['context'] );
+ public function get_item_schema() {
+ $schema = array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'title' => 'CMB2',
+ 'type' => 'object',
+ 'properties' => array(
+ 'description' => array(
+ 'description' => __( 'A human-readable description of the object.', 'cmb2' ),
+ 'type' => 'string',
+ 'context' => array( 'view' ),
+ ),
+ 'name' => array(
+ 'description' => __( 'The id for the object.', 'cmb2' ),
+ 'type' => 'integer',
+ 'context' => array( 'view' ),
+ ),
+ 'name' => array(
+ 'description' => __( 'The title for the object.', 'cmb2' ),
+ 'type' => 'string',
+ 'context' => array( 'view' ),
+ ),
+ ),
+ );
- /**
- * Filter the prepared CMB2 item response.
- *
- * @since 2.2.3
- *
- * @param mixed $data Prepared data
- * @param object $request The WP_REST_Request object
- * @param object $cmb2_endpoints This endpoints object
- */
- return apply_filters( 'cmb2_rest_prepare', rest_ensure_response( $data ), $this->request, $this );
+ return $this->add_additional_fields_schema( $schema );
}
/**
- * Initiates the request property and the rest_box property if box is readable.
+ * Get whitelisted query strings from URL for appending to link URLS.
*
* @since 2.2.3
*
- * @param WP_REST_Request $request Request object.
- * @param string $request_type A description of the type of request being made.
- *
- * @return void
+ * @return string URL query stringl
*/
- protected function initiate_rest_read_box( $request, $request_type ) {
- $this->initiate_rest_box( $request, $request_type );
+ public function get_query_string() {
+ $defaults = array(
+ 'object_id' => 0,
+ 'object_type' => '',
+ '_rendered' => '',
+ // '_embed' => '',
+ );
- if ( ! is_wp_error( $this->rest_box ) && ! $this->rest_box->rest_read ) {
- $this->rest_box = new WP_Error( 'cmb2_rest_no_read_error', __( 'This box does not have read permissions.', 'cmb2' ), array( 'status' => 403 ) );
+ $query_string = '';
+
+ foreach ( $defaults as $key => $value ) {
+ if ( isset( $this->request[ $key ] ) ) {
+ $query_string .= $query_string ? '&' : '?';
+ $query_string .= $key;
+ if ( $value = sanitize_text_field( $this->request[ $key ] ) ) {
+ $query_string .= '=' . $value;
+ }
+ }
}
+
+ return $query_string;
}
/**
- * Initiates the request property and the rest_box property if box is writeable.
+ * Initiates the request property and the rest_box property if box is readable.
*
* @since 2.2.3
*
@@ -262,11 +334,11 @@ protected function initiate_rest_read_box( $request, $request_type ) {
*
* @return void
*/
- protected function initiate_rest_edit_box( $request, $request_type ) {
+ protected function initiate_rest_read_box( $request, $request_type ) {
$this->initiate_rest_box( $request, $request_type );
- if ( ! is_wp_error( $this->rest_box ) && ! $this->rest_box->rest_edit ) {
- $this->rest_box = new WP_Error( 'cmb2_rest_no_write_error', __( 'This box does not have write permissions.', 'cmb2' ), array( 'status' => 403 ) );
+ if ( ! is_wp_error( $this->rest_box ) && ! $this->rest_box->rest_read ) {
+ $this->rest_box = new WP_Error( 'cmb2_rest_no_read_error', __( 'This box does not have read permissions.', 'cmb2' ), array( 'status' => 403 ) );
}
}
@@ -328,102 +400,35 @@ public function initiate_request( $request, $request_type ) {
}
/**
- * Useful when getting `_embed`-ed items
- *
- * @since 2.2.3
- *
- * @return string Initial requested type.
- */
- public static function get_intial_request_type() {
- return self::$request_type;
- }
-
- /**
- * Useful when getting `_embed`-ed items
+ * Initiates the request property and the rest_box property if box is writeable.
*
* @since 2.2.3
*
- * @return string Initial requested route.
- */
- public static function get_intial_route() {
- return self::$route;
- }
-
- /**
- * Get CMB2 fields schema, conforming to JSON Schema
- *
- * @since 2.2.3
+ * @param WP_REST_Request $request Request object.
+ * @param string $request_type A description of the type of request being made.
*
- * @return array
+ * @return void
*/
- public function get_item_schema() {
- $schema = array(
- '$schema' => 'http://json-schema.org/draft-04/schema#',
- 'title' => 'CMB2',
- 'type' => 'object',
- 'properties' => array(
- 'description' => array(
- 'description' => __( 'A human-readable description of the object.', 'cmb2' ),
- 'type' => 'string',
- 'context' => array( 'view' ),
- ),
- 'name' => array(
- 'description' => __( 'The id for the object.', 'cmb2' ),
- 'type' => 'integer',
- 'context' => array( 'view' ),
- ),
- 'name' => array(
- 'description' => __( 'The title for the object.', 'cmb2' ),
- 'type' => 'string',
- 'context' => array( 'view' ),
- ),
- ),
- );
+ protected function initiate_rest_edit_box( $request, $request_type ) {
+ $this->initiate_rest_box( $request, $request_type );
- return $this->add_additional_fields_schema( $schema );
+ if ( ! is_wp_error( $this->rest_box ) && ! $this->rest_box->rest_edit ) {
+ $this->rest_box = new WP_Error( 'cmb2_rest_no_write_error', __( 'This box does not have write permissions.', 'cmb2' ), array( 'status' => 403 ) );
+ }
}
/**
* Return an array of contextual links for endpoint/object
- * @link http://v2.wp-api.org/extending/linking/
- * @link http://www.iana.org/assignments/link-relations/link-relations.xhtml
+ *
+ * @link http://v2.wp-api.org/extending/linking/
+ * @link http://www.iana.org/assignments/link-relations/link-relations.xhtml
*
* @since 2.2.3
*
- * @param mixed $object Object to build links from.
+ * @param mixed $object Object to build links from.
*
* @return array Array of links
*/
abstract protected function prepare_links( $object );
- /**
- * Get whitelisted query strings from URL for appending to link URLS.
- *
- * @since 2.2.3
- *
- * @return string URL query stringl
- */
- public function get_query_string() {
- $defaults = array(
- 'object_id' => 0,
- 'object_type' => '',
- '_rendered' => '',
- // '_embed' => '',
- );
-
- $query_string = '';
-
- foreach ( $defaults as $key => $value ) {
- if ( isset( $this->request[ $key ] ) ) {
- $query_string .= $query_string ? '&' : '?';
- $query_string .= $key;
- if ( $value = sanitize_text_field( $this->request[ $key ] ) ) {
- $query_string .= '=' . $value;
- }
- }
- }
-
- return $query_string;
- }
-
}
diff --git a/includes/CMB2/includes/rest-api/CMB2_REST_Controller_Boxes.php b/includes/CMB2/includes/rest-api/CMB2_REST_Controller_Boxes.php
index 55367ae..fd05450 100755
--- a/includes/CMB2/includes/rest-api/CMB2_REST_Controller_Boxes.php
+++ b/includes/CMB2/includes/rest-api/CMB2_REST_Controller_Boxes.php
@@ -1,13 +1,14 @@
prepare_item( $boxes_data );
}
- /**
- * Check if a given request has access to a box.
- * By default, no special permissions needed, but filtering return value.
- *
- * @since 2.2.3
- *
- * @param WP_REST_Request $request Full details about the request.
- * @return WP_Error|boolean
- */
- public function get_item_permissions_check( $request ) {
- $this->initiate_rest_read_box( $request, 'box_read' );
-
- return $this->get_item_permissions_check_filter();
- }
-
/**
* Check by filter if a given request has access to a box.
* By default, no special permissions needed, but filtering return value.
@@ -165,6 +154,7 @@ public function get_item_permissions_check( $request ) {
* @since 2.2.3
*
* @param bool $can_access Whether the current request has access to view the box by default.
+ *
* @return WP_Error|boolean
*/
public function get_item_permissions_check_filter( $can_access = true ) {
@@ -179,24 +169,6 @@ public function get_item_permissions_check_filter( $can_access = true ) {
return $this->maybe_hook_callback_and_apply_filters( 'cmb2_api_get_box_permissions_check', $can_access );
}
- /**
- * Get one CMB2 box from the collection.
- *
- * @since 2.2.3
- *
- * @param WP_REST_Request $request Full data about the request.
- * @return WP_Error|WP_REST_Response
- */
- public function get_item( $request ) {
- $this->initiate_rest_read_box( $request, 'box_read' );
-
- if ( is_wp_error( $this->rest_box ) ) {
- return $this->rest_box;
- }
-
- return $this->prepare_item( $this->get_rest_box() );
- }
-
/**
* Get a CMB2 box prepared for REST
*
@@ -210,16 +182,16 @@ public function get_rest_box() {
$boxes_data = $cmb->meta_box;
if ( isset( $this->request['_rendered'] ) && $this->namespace_base !== ltrim( CMB2_REST_Controller::get_intial_route(), '/' ) ) {
- $boxes_data['form_open'] = $this->get_cb_results( array( $cmb, 'render_form_open' ) );
+ $boxes_data['form_open'] = $this->get_cb_results( array( $cmb, 'render_form_open' ) );
$boxes_data['form_close'] = $this->get_cb_results( array( $cmb, 'render_form_close' ) );
global $wp_scripts, $wp_styles;
$before_css = $wp_styles->queue;
- $before_js = $wp_scripts->queue;
+ $before_js = $wp_scripts->queue;
CMB2_JS::enqueue();
- $boxes_data['js_dependencies'] = array_values( array_diff( $wp_scripts->queue, $before_js ) );
+ $boxes_data['js_dependencies'] = array_values( array_diff( $wp_scripts->queue, $before_js ) );
$boxes_data['css_dependencies'] = array_values( array_diff( $wp_styles->queue, $before_css ) );
}
@@ -251,19 +223,54 @@ protected function prepare_links( $cmb ) {
return array(
// Standard Link Relations -- http://v2.wp-api.org/extending/linking/
- 'self' => array(
+ 'self' => array(
'href' => rest_url( $boxbase . $query_string ),
),
- 'collection' => array(
+ 'collection' => array(
'href' => rest_url( $this->namespace_base . $query_string ),
),
// Custom Link Relations -- http://v2.wp-api.org/extending/linking/
// TODO URL should document relationship.
'https://cmb2.io/fields' => array(
- 'href' => rest_url( trailingslashit( $boxbase ) . 'fields' . $query_string ),
+ 'href' => rest_url( trailingslashit( $boxbase ) . 'fields' . $query_string ),
'embeddable' => true,
),
);
}
+ /**
+ * Check if a given request has access to a box.
+ * By default, no special permissions needed, but filtering return value.
+ *
+ * @since 2.2.3
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ *
+ * @return WP_Error|boolean
+ */
+ public function get_item_permissions_check( $request ) {
+ $this->initiate_rest_read_box( $request, 'box_read' );
+
+ return $this->get_item_permissions_check_filter();
+ }
+
+ /**
+ * Get one CMB2 box from the collection.
+ *
+ * @since 2.2.3
+ *
+ * @param WP_REST_Request $request Full data about the request.
+ *
+ * @return WP_Error|WP_REST_Response
+ */
+ public function get_item( $request ) {
+ $this->initiate_rest_read_box( $request, 'box_read' );
+
+ if ( is_wp_error( $this->rest_box ) ) {
+ return $this->rest_box;
+ }
+
+ return $this->prepare_item( $this->get_rest_box() );
+ }
+
}
diff --git a/includes/CMB2/includes/rest-api/CMB2_REST_Controller_Fields.php b/includes/CMB2/includes/rest-api/CMB2_REST_Controller_Fields.php
index 3b23102..eba8e94 100755
--- a/includes/CMB2/includes/rest-api/CMB2_REST_Controller_Fields.php
+++ b/includes/CMB2/includes/rest-api/CMB2_REST_Controller_Fields.php
@@ -1,13 +1,14 @@
array(
+ '_embed' => array(
'description' => __( 'Includes the box object which the fields are registered to in the response.', 'cmb2' ),
),
- '_rendered' => array(
+ '_rendered' => array(
'description' => __( 'When the \'_rendered\' argument is passed, the renderable field attributes will be returned fully rendered. By default, the names of the callback handers for the renderable attributes will be returned.', 'cmb2' ),
),
- 'object_id' => array(
+ 'object_id' => array(
'description' => __( 'To view or modify the field\'s value, the \'object_id\' and \'object_type\' arguments are required.', 'cmb2' ),
),
'object_type' => array(
@@ -49,8 +50,8 @@ public function register_routes() {
'schema' => array( $this, 'get_item_schema' ),
) );
- $delete_args = $args;
- $delete_args['object_id']['required'] = true;
+ $delete_args = $args;
+ $delete_args['object_id']['required'] = true;
$delete_args['object_type']['required'] = true;
// Returns specific field data.
@@ -85,6 +86,7 @@ public function register_routes() {
* @since 2.2.3
*
* @param WP_REST_Request $request Full data about the request.
+ *
* @return WP_Error|boolean
*/
public function get_items_permissions_check( $request ) {
@@ -108,6 +110,7 @@ public function get_items_permissions_check( $request ) {
* @since 2.2.3
*
* @param WP_REST_Request $request Full data about the request.
+ *
* @return WP_Error|WP_REST_Response
*/
public function get_items( $request ) {
@@ -137,24 +140,6 @@ public function get_items( $request ) {
return $this->prepare_item( $fields );
}
- /**
- * Check if a given request has access to a field.
- * By default, no special permissions needed, but filtering return value.
- *
- * @since 2.2.3
- *
- * @param WP_REST_Request $request Full details about the request.
- * @return WP_Error|boolean
- */
- public function get_item_permissions_check( $request ) {
- $this->initiate_rest_read_box( $request, 'field_read' );
- if ( ! is_wp_error( $this->rest_box ) ) {
- $this->field = $this->rest_box->field_can_read( $this->request->get_param( 'field_id' ), true );
- }
-
- return $this->get_item_permissions_check_filter();
- }
-
/**
* Check by filter if a given request has access to a field.
* By default, no special permissions needed, but filtering return value.
@@ -162,6 +147,7 @@ public function get_item_permissions_check( $request ) {
* @since 2.2.3
*
* @param bool $can_access Whether the current request has access to view the field by default.
+ *
* @return WP_Error|boolean
*/
public function get_item_permissions_check_filter( $can_access = true ) {
@@ -177,109 +163,215 @@ public function get_item_permissions_check_filter( $can_access = true ) {
}
/**
- * Get one CMB2 field from the collection.
+ * Get a specific field response.
*
* @since 2.2.3
*
- * @param WP_REST_Request $request Full data about the request.
- * @return WP_Error|WP_REST_Response
+ * @param CMB2_Field Field object.
+ *
+ * @return array Response array.
*/
- public function get_item( $request ) {
- $this->initiate_rest_read_box( $request, 'field_read' );
+ public function prepare_field_response() {
+ $field_data = $this->prepare_field_data( $this->field );
+ $response = rest_ensure_response( $field_data );
- if ( is_wp_error( $this->rest_box ) ) {
- return $this->rest_box;
+ $response->add_links( $this->prepare_links( $this->field ) );
+
+ return $response;
+ }
+
+ /**
+ * Prepare the field data array for JSON.
+ *
+ * @since 2.2.3
+ *
+ * @param CMB2_Field $field field object.
+ *
+ * @return array Array of field data.
+ */
+ protected function prepare_field_data( CMB2_Field $field ) {
+ $field_data = array();
+ $params_to_ignore = array( 'show_in_rest', 'options' );
+ $params_to_rename = array(
+ 'label_cb' => 'label',
+ 'options_cb' => 'options',
+ );
+
+ // Run this first so the js_dependencies arg is populated.
+ $rendered = ( $cb = $field->maybe_callback( 'render_row_cb' ) )
+ // Ok, callback is good, let's run it.
+ ? $this->get_cb_results( $cb, $field->args(), $field )
+ : false;
+
+ $field_args = $field->args();
+
+ foreach ( $field_args as $key => $value ) {
+ if ( in_array( $key, $params_to_ignore, true ) ) {
+ continue;
+ }
+
+ if ( 'options_cb' === $key ) {
+ $value = $field->options();
+ } elseif ( in_array( $key, CMB2_Field::$callable_fields, true ) ) {
+
+ if ( isset( $this->request['_rendered'] ) ) {
+ $value = $key === 'render_row_cb' ? $rendered : $field->get_param_callback_result( $key );
+ } elseif ( is_array( $value ) ) {
+ // We need to rewrite callbacks as string as they will cause
+ // JSON recursion errors.
+ $class = is_string( $value[0] ) ? $value[0] : get_class( $value[0] );
+ $value = $class . '::' . $value[1];
+ }
+ }
+
+ $key = isset( $params_to_rename[ $key ] ) ? $params_to_rename[ $key ] : $key;
+
+ if ( empty( $value ) || is_scalar( $value ) || is_array( $value ) ) {
+ $field_data[ $key ] = $value;
+ } else {
+ $field_data[ $key ] = sprintf( __( 'Value Error for %s', 'cmb2' ), $key );
+ }
}
- return $this->prepare_read_field( $this->request->get_param( 'field_id' ) );
+ if ( $this->request['object_id'] && $this->request['object_type'] ) {
+ $field_data['value'] = $field->get_data();
+ }
+
+ return $field_data;
}
/**
- * Check if a given request has access to update a field value.
- * By default, requires 'edit_others_posts' capability, but filtering return value.
+ * Return an array of contextual links for field/fields.
+ *
+ * @since 2.2.3
+ *
+ * @param CMB2_Field $field Field object to build links from.
+ *
+ * @return array Array of links
+ */
+ protected function prepare_links( $field ) {
+ $boxbase = $this->namespace_base . '/' . $this->rest_box->cmb->cmb_id;
+ $query_string = $this->get_query_string();
+
+ $links = array(
+ 'self' => array(
+ 'href' => rest_url( trailingslashit( $boxbase ) . 'fields/' . $field->_id() . $query_string ),
+ ),
+ 'collection' => array(
+ 'href' => rest_url( trailingslashit( $boxbase ) . 'fields' . $query_string ),
+ ),
+ 'up' => array(
+ 'embeddable' => true,
+ 'href' => rest_url( $boxbase . $query_string ),
+ ),
+ );
+
+ return $links;
+ }
+
+ /**
+ * Check if a given request has access to a field.
+ * By default, no special permissions needed, but filtering return value.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full details about the request.
+ *
* @return WP_Error|boolean
*/
- public function update_item_permissions_check( $request ) {
- $this->initiate_rest_read_box( $request, 'field_value_update' );
+ public function get_item_permissions_check( $request ) {
+ $this->initiate_rest_read_box( $request, 'field_read' );
if ( ! is_wp_error( $this->rest_box ) ) {
- $this->field = $this->rest_box->field_can_edit( $this->request->get_param( 'field_id' ), true );
+ $this->field = $this->rest_box->field_can_read( $this->request->get_param( 'field_id' ), true );
}
- $can_update = current_user_can( 'edit_others_posts' );
-
- /**
- * By default, 'edit_others_posts' is required capability.
- *
- * @since 2.2.3
- *
- * @param bool $can_update Whether this CMB2 endpoint can be accessed.
- * @param object $controller This CMB2_REST_Controller object.
- */
- return $this->maybe_hook_callback_and_apply_filters( 'cmb2_api_update_field_value_permissions_check', $can_update );
+ return $this->get_item_permissions_check_filter();
}
/**
- * Update CMB2 field value.
+ * Get one CMB2 field from the collection.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full data about the request.
+ *
* @return WP_Error|WP_REST_Response
*/
- public function update_item( $request ) {
- $this->initiate_rest_read_box( $request, 'field_value_update' );
+ public function get_item( $request ) {
+ $this->initiate_rest_read_box( $request, 'field_read' );
- if ( ! $this->request['value'] ) {
- return new WP_Error( 'cmb2_rest_update_field_error', __( 'CMB2 Field value cannot be updated without the value parameter specified.', 'cmb2' ), array( 'status' => 400 ) );
+ if ( is_wp_error( $this->rest_box ) ) {
+ return $this->rest_box;
}
- return $this->modify_field_value( 'updated' );
+ return $this->prepare_read_field( $this->request->get_param( 'field_id' ) );
}
/**
- * Check if a given request has access to delete a field value.
- * By default, requires 'delete_others_posts' capability, but filtering return value.
+ * Get a response object for a specific field ID.
+ *
+ * @since 2.2.3
+ *
+ * @param string\CMB2_Field Field id or Field object.
+ *
+ * @return WP_Error|WP_REST_Response
+ */
+ public function prepare_read_field( $field ) {
+ $this->field = $this->rest_box->field_can_read( $field, true );
+
+ if ( ! $this->field ) {
+ return new WP_Error( 'cmb2_rest_no_field_by_id_error', __( 'No field found by that id.', 'cmb2' ), array( 'status' => 403 ) );
+ }
+
+ return $this->prepare_item( $this->prepare_field_response() );
+ }
+
+ /**
+ * Check if a given request has access to update a field value.
+ * By default, requires 'edit_others_posts' capability, but filtering return value.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full details about the request.
+ *
* @return WP_Error|boolean
*/
- public function delete_item_permissions_check( $request ) {
- $this->initiate_rest_read_box( $request, 'field_value_delete' );
+ public function update_item_permissions_check( $request ) {
+ $this->initiate_rest_read_box( $request, 'field_value_update' );
if ( ! is_wp_error( $this->rest_box ) ) {
$this->field = $this->rest_box->field_can_edit( $this->request->get_param( 'field_id' ), true );
}
- $can_delete = current_user_can( 'delete_others_posts' );
+ $can_update = current_user_can( 'edit_others_posts' );
/**
- * By default, 'delete_others_posts' is required capability.
+ * By default, 'edit_others_posts' is required capability.
*
* @since 2.2.3
*
- * @param bool $can_delete Whether this CMB2 endpoint can be accessed.
+ * @param bool $can_update Whether this CMB2 endpoint can be accessed.
* @param object $controller This CMB2_REST_Controller object.
*/
- return $this->maybe_hook_callback_and_apply_filters( 'cmb2_api_delete_field_value_permissions_check', $can_delete );
+ return $this->maybe_hook_callback_and_apply_filters( 'cmb2_api_update_field_value_permissions_check', $can_update );
}
/**
- * Delete CMB2 field value.
+ * Update CMB2 field value.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full data about the request.
+ *
* @return WP_Error|WP_REST_Response
*/
- public function delete_item( $request ) {
- $this->initiate_rest_read_box( $request, 'field_value_delete' );
+ public function update_item( $request ) {
+ $this->initiate_rest_read_box( $request, 'field_value_update' );
- return $this->modify_field_value( 'deleted' );
+ if ( ! $this->request['value'] ) {
+ return new WP_Error( 'cmb2_rest_update_field_error', __( 'CMB2 Field value cannot be updated without the value parameter specified.', 'cmb2' ), array( 'status' => 400 ) );
+ }
+
+ return $this->modify_field_value( 'updated' );
}
/**
@@ -288,9 +380,10 @@ public function delete_item( $request ) {
* @since 2.2.3
*
* @param string $activity The modification activity (updated or deleted).
+ *
* @return WP_Error|WP_REST_Response
*/
- public function modify_field_value( $activity) {
+ public function modify_field_value( $activity ) {
if ( ! $this->request['object_id'] || ! $this->request['object_type'] ) {
return new WP_Error( 'cmb2_rest_modify_field_value_error', __( 'CMB2 Field value cannot be modified without the object_id and object_type parameters specified.', 'cmb2' ), array( 'status' => 400 ) );
@@ -322,127 +415,47 @@ public function modify_field_value( $activity) {
}
/**
- * Get a response object for a specific field ID.
- *
- * @since 2.2.3
- *
- * @param string\CMB2_Field Field id or Field object.
- * @return WP_Error|WP_REST_Response
- */
- public function prepare_read_field( $field ) {
- $this->field = $this->rest_box->field_can_read( $field, true );
-
- if ( ! $this->field ) {
- return new WP_Error( 'cmb2_rest_no_field_by_id_error', __( 'No field found by that id.', 'cmb2' ), array( 'status' => 403 ) );
- }
-
- return $this->prepare_item( $this->prepare_field_response() );
- }
-
- /**
- * Get a specific field response.
+ * Check if a given request has access to delete a field value.
+ * By default, requires 'delete_others_posts' capability, but filtering return value.
*
* @since 2.2.3
*
- * @param CMB2_Field Field object.
- * @return array Response array.
- */
- public function prepare_field_response() {
- $field_data = $this->prepare_field_data( $this->field );
- $response = rest_ensure_response( $field_data );
-
- $response->add_links( $this->prepare_links( $this->field ) );
-
- return $response;
- }
-
- /**
- * Prepare the field data array for JSON.
- *
- * @since 2.2.3
- *
- * @param CMB2_Field $field field object.
+ * @param WP_REST_Request $request Full details about the request.
*
- * @return array Array of field data.
+ * @return WP_Error|boolean
*/
- protected function prepare_field_data( CMB2_Field $field ) {
- $field_data = array();
- $params_to_ignore = array( 'show_in_rest', 'options' );
- $params_to_rename = array(
- 'label_cb' => 'label',
- 'options_cb' => 'options',
- );
-
- // Run this first so the js_dependencies arg is populated.
- $rendered = ( $cb = $field->maybe_callback( 'render_row_cb' ) )
- // Ok, callback is good, let's run it.
- ? $this->get_cb_results( $cb, $field->args(), $field )
- : false;
-
- $field_args = $field->args();
-
- foreach ( $field_args as $key => $value ) {
- if ( in_array( $key, $params_to_ignore, true ) ) {
- continue;
- }
-
- if ( 'options_cb' === $key ) {
- $value = $field->options();
- } elseif ( in_array( $key, CMB2_Field::$callable_fields, true ) ) {
-
- if ( isset( $this->request['_rendered'] ) ) {
- $value = $key === 'render_row_cb' ? $rendered : $field->get_param_callback_result( $key );
- } elseif ( is_array( $value ) ) {
- // We need to rewrite callbacks as string as they will cause
- // JSON recursion errors.
- $class = is_string( $value[0] ) ? $value[0] : get_class( $value[0] );
- $value = $class . '::' . $value[1];
- }
- }
-
- $key = isset( $params_to_rename[ $key ] ) ? $params_to_rename[ $key ] : $key;
-
- if ( empty( $value ) || is_scalar( $value ) || is_array( $value ) ) {
- $field_data[ $key ] = $value;
- } else {
- $field_data[ $key ] = sprintf( __( 'Value Error for %s', 'cmb2' ), $key );
- }
+ public function delete_item_permissions_check( $request ) {
+ $this->initiate_rest_read_box( $request, 'field_value_delete' );
+ if ( ! is_wp_error( $this->rest_box ) ) {
+ $this->field = $this->rest_box->field_can_edit( $this->request->get_param( 'field_id' ), true );
}
- if ( $this->request['object_id'] && $this->request['object_type'] ) {
- $field_data['value'] = $field->get_data();
- }
+ $can_delete = current_user_can( 'delete_others_posts' );
- return $field_data;
+ /**
+ * By default, 'delete_others_posts' is required capability.
+ *
+ * @since 2.2.3
+ *
+ * @param bool $can_delete Whether this CMB2 endpoint can be accessed.
+ * @param object $controller This CMB2_REST_Controller object.
+ */
+ return $this->maybe_hook_callback_and_apply_filters( 'cmb2_api_delete_field_value_permissions_check', $can_delete );
}
/**
- * Return an array of contextual links for field/fields.
+ * Delete CMB2 field value.
*
- * @since 2.2.3
+ * @since 2.2.3
*
- * @param CMB2_Field $field Field object to build links from.
+ * @param WP_REST_Request $request Full data about the request.
*
- * @return array Array of links
+ * @return WP_Error|WP_REST_Response
*/
- protected function prepare_links( $field ) {
- $boxbase = $this->namespace_base . '/' . $this->rest_box->cmb->cmb_id;
- $query_string = $this->get_query_string();
-
- $links = array(
- 'self' => array(
- 'href' => rest_url( trailingslashit( $boxbase ) . 'fields/' . $field->_id() . $query_string ),
- ),
- 'collection' => array(
- 'href' => rest_url( trailingslashit( $boxbase ) . 'fields' . $query_string ),
- ),
- 'up' => array(
- 'embeddable' => true,
- 'href' => rest_url( $boxbase . $query_string ),
- ),
- );
+ public function delete_item( $request ) {
+ $this->initiate_rest_read_box( $request, 'field_value_delete' );
- return $links;
+ return $this->modify_field_value( 'deleted' );
}
/**
diff --git a/includes/CMB2/includes/shim/WP_REST_Controller.php b/includes/CMB2/includes/shim/WP_REST_Controller.php
index 1be88de..fe6cdbe 100755
--- a/includes/CMB2/includes/shim/WP_REST_Controller.php
+++ b/includes/CMB2/includes/shim/WP_REST_Controller.php
@@ -28,6 +28,7 @@ public function register_routes() {
* Check if a given request has access to get items.
*
* @param WP_REST_Request $request Full data about the request.
+ *
* @return WP_Error|boolean
*/
public function get_items_permissions_check( $request ) {
@@ -38,6 +39,7 @@ public function get_items_permissions_check( $request ) {
* Get a collection of items.
*
* @param WP_REST_Request $request Full data about the request.
+ *
* @return WP_Error|WP_REST_Response
*/
public function get_items( $request ) {
@@ -48,6 +50,7 @@ public function get_items( $request ) {
* Check if a given request has access to get a specific item.
*
* @param WP_REST_Request $request Full data about the request.
+ *
* @return WP_Error|boolean
*/
public function get_item_permissions_check( $request ) {
@@ -58,6 +61,7 @@ public function get_item_permissions_check( $request ) {
* Get one item from the collection.
*
* @param WP_REST_Request $request Full data about the request.
+ *
* @return WP_Error|WP_REST_Response
*/
public function get_item( $request ) {
@@ -68,6 +72,7 @@ public function get_item( $request ) {
* Check if a given request has access to create items.
*
* @param WP_REST_Request $request Full data about the request.
+ *
* @return WP_Error|boolean
*/
public function create_item_permissions_check( $request ) {
@@ -78,6 +83,7 @@ public function create_item_permissions_check( $request ) {
* Create one item from the collection.
*
* @param WP_REST_Request $request Full data about the request.
+ *
* @return WP_Error|WP_REST_Response
*/
public function create_item( $request ) {
@@ -88,6 +94,7 @@ public function create_item( $request ) {
* Check if a given request has access to update a specific item.
*
* @param WP_REST_Request $request Full data about the request.
+ *
* @return WP_Error|boolean
*/
public function update_item_permissions_check( $request ) {
@@ -98,6 +105,7 @@ public function update_item_permissions_check( $request ) {
* Update one item from the collection.
*
* @param WP_REST_Request $request Full data about the request.
+ *
* @return WP_Error|WP_REST_Response
*/
public function update_item( $request ) {
@@ -108,6 +116,7 @@ public function update_item( $request ) {
* Check if a given request has access to delete a specific item.
*
* @param WP_REST_Request $request Full data about the request.
+ *
* @return WP_Error|boolean
*/
public function delete_item_permissions_check( $request ) {
@@ -118,27 +127,19 @@ public function delete_item_permissions_check( $request ) {
* Delete one item from the collection.
*
* @param WP_REST_Request $request Full data about the request.
+ *
* @return WP_Error|WP_REST_Response
*/
public function delete_item( $request ) {
return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be over-ridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );
}
- /**
- * Prepare the item for create or update operation.
- *
- * @param WP_REST_Request $request Request object.
- * @return WP_Error|object $prepared_item
- */
- protected function prepare_item_for_database( $request ) {
- return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be over-ridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );
- }
-
/**
* Prepare the item for the REST response.
*
- * @param mixed $item WordPress representation of the item.
+ * @param mixed $item WordPress representation of the item.
* @param WP_REST_Request $request Request object.
+ *
* @return WP_REST_Response $response
*/
public function prepare_item_for_response( $item, $request ) {
@@ -149,6 +150,7 @@ public function prepare_item_for_response( $item, $request ) {
* Prepare a response for inserting into a collection.
*
* @param WP_REST_Response $response Response object.
+ *
* @return array Response data, ready for insertion into collection data.
*/
public function prepare_response_for_collection( $response ) {
@@ -156,7 +158,7 @@ public function prepare_response_for_collection( $response ) {
return $response;
}
- $data = (array) $response->get_data();
+ $data = (array) $response->get_data();
$server = rest_get_server();
if ( method_exists( $server, 'get_compact_response_links' ) ) {
@@ -175,8 +177,9 @@ public function prepare_response_for_collection( $response ) {
/**
* Filter a response based on the context defined in the schema.
*
- * @param array $data
+ * @param array $data
* @param string $context
+ *
* @return array
*/
public function filter_response_by_context( $data, $context ) {
@@ -218,138 +221,6 @@ public function get_item_schema() {
return $this->add_additional_fields_schema( array() );
}
- /**
- * Get the item's schema for display / public consumption purposes.
- *
- * @return array
- */
- public function get_public_item_schema() {
-
- $schema = $this->get_item_schema();
-
- foreach ( $schema['properties'] as &$property ) {
- if ( isset( $property['arg_options'] ) ) {
- unset( $property['arg_options'] );
- }
- }
-
- return $schema;
- }
-
- /**
- * Get the query params for collections.
- *
- * @return array
- */
- public function get_collection_params() {
- return array(
- 'context' => $this->get_context_param(),
- 'page' => array(
- 'description' => __( 'Current page of the collection.' ),
- 'type' => 'integer',
- 'default' => 1,
- 'sanitize_callback' => 'absint',
- 'validate_callback' => 'rest_validate_request_arg',
- 'minimum' => 1,
- ),
- 'per_page' => array(
- 'description' => __( 'Maximum number of items to be returned in result set.' ),
- 'type' => 'integer',
- 'default' => 10,
- 'minimum' => 1,
- 'maximum' => 100,
- 'sanitize_callback' => 'absint',
- 'validate_callback' => 'rest_validate_request_arg',
- ),
- 'search' => array(
- 'description' => __( 'Limit results to those matching a string.' ),
- 'type' => 'string',
- 'sanitize_callback' => 'sanitize_text_field',
- 'validate_callback' => 'rest_validate_request_arg',
- ),
- );
- }
-
- /**
- * Get the magical context param.
- *
- * Ensures consistent description between endpoints, and populates enum from schema.
- *
- * @param array $args
- * @return array
- */
- public function get_context_param( $args = array() ) {
- $param_details = array(
- 'description' => __( 'Scope under which the request is made; determines fields present in response.' ),
- 'type' => 'string',
- 'sanitize_callback' => 'sanitize_key',
- 'validate_callback' => 'rest_validate_request_arg',
- );
- $schema = $this->get_item_schema();
- if ( empty( $schema['properties'] ) ) {
- return array_merge( $param_details, $args );
- }
- $contexts = array();
- foreach ( $schema['properties'] as $attributes ) {
- if ( ! empty( $attributes['context'] ) ) {
- $contexts = array_merge( $contexts, $attributes['context'] );
- }
- }
- if ( ! empty( $contexts ) ) {
- $param_details['enum'] = array_unique( $contexts );
- rsort( $param_details['enum'] );
- }
- return array_merge( $param_details, $args );
- }
-
- /**
- * Add the values from additional fields to a data object.
- *
- * @param array $object
- * @param WP_REST_Request $request
- * @return array modified object with additional fields.
- */
- protected function add_additional_fields_to_object( $object, $request ) {
-
- $additional_fields = $this->get_additional_fields();
-
- foreach ( $additional_fields as $field_name => $field_options ) {
-
- if ( ! $field_options['get_callback'] ) {
- continue;
- }
-
- $object[ $field_name ] = call_user_func( $field_options['get_callback'], $object, $field_name, $request, $this->get_object_type() );
- }
-
- return $object;
- }
-
- /**
- * Update the values of additional fields added to a data object.
- *
- * @param array $object
- * @param WP_REST_Request $request
- */
- protected function update_additional_fields_for_object( $object, $request ) {
-
- $additional_fields = $this->get_additional_fields();
-
- foreach ( $additional_fields as $field_name => $field_options ) {
-
- if ( ! $field_options['update_callback'] ) {
- continue;
- }
-
- // Don't run the update callbacks if the data wasn't passed in the request.
- if ( ! isset( $request[ $field_name ] ) ) {
- continue;
- }
-
- call_user_func( $field_options['update_callback'], $request[ $field_name ], $object, $field_name, $request, $this->get_object_type() );
- }
- }
-
/**
* Add the schema from additional fields to an schema array.
*
@@ -384,6 +255,7 @@ protected function add_additional_fields_schema( $schema ) {
* Get all the registered additional fields for a given object-type.
*
* @param string $object_type
+ *
* @return array
*/
protected function get_additional_fields( $object_type = null ) {
@@ -420,6 +292,92 @@ protected function get_object_type() {
return $schema['title'];
}
+ /**
+ * Get the item's schema for display / public consumption purposes.
+ *
+ * @return array
+ */
+ public function get_public_item_schema() {
+
+ $schema = $this->get_item_schema();
+
+ foreach ( $schema['properties'] as &$property ) {
+ if ( isset( $property['arg_options'] ) ) {
+ unset( $property['arg_options'] );
+ }
+ }
+
+ return $schema;
+ }
+
+ /**
+ * Get the query params for collections.
+ *
+ * @return array
+ */
+ public function get_collection_params() {
+ return array(
+ 'context' => $this->get_context_param(),
+ 'page' => array(
+ 'description' => __( 'Current page of the collection.' ),
+ 'type' => 'integer',
+ 'default' => 1,
+ 'sanitize_callback' => 'absint',
+ 'validate_callback' => 'rest_validate_request_arg',
+ 'minimum' => 1,
+ ),
+ 'per_page' => array(
+ 'description' => __( 'Maximum number of items to be returned in result set.' ),
+ 'type' => 'integer',
+ 'default' => 10,
+ 'minimum' => 1,
+ 'maximum' => 100,
+ 'sanitize_callback' => 'absint',
+ 'validate_callback' => 'rest_validate_request_arg',
+ ),
+ 'search' => array(
+ 'description' => __( 'Limit results to those matching a string.' ),
+ 'type' => 'string',
+ 'sanitize_callback' => 'sanitize_text_field',
+ 'validate_callback' => 'rest_validate_request_arg',
+ ),
+ );
+ }
+
+ /**
+ * Get the magical context param.
+ *
+ * Ensures consistent description between endpoints, and populates enum from schema.
+ *
+ * @param array $args
+ *
+ * @return array
+ */
+ public function get_context_param( $args = array() ) {
+ $param_details = array(
+ 'description' => __( 'Scope under which the request is made; determines fields present in response.' ),
+ 'type' => 'string',
+ 'sanitize_callback' => 'sanitize_key',
+ 'validate_callback' => 'rest_validate_request_arg',
+ );
+ $schema = $this->get_item_schema();
+ if ( empty( $schema['properties'] ) ) {
+ return array_merge( $param_details, $args );
+ }
+ $contexts = array();
+ foreach ( $schema['properties'] as $attributes ) {
+ if ( ! empty( $attributes['context'] ) ) {
+ $contexts = array_merge( $contexts, $attributes['context'] );
+ }
+ }
+ if ( ! empty( $contexts ) ) {
+ $param_details['enum'] = array_unique( $contexts );
+ rsort( $param_details['enum'] );
+ }
+
+ return array_merge( $param_details, $args );
+ }
+
/**
* Get an array of endpoint arguments from the item schema for the controller.
*
@@ -428,13 +386,14 @@ protected function get_object_type() {
* values and may fall-back to a given default, this
* is not done on `EDITABLE` requests. Default is
* WP_REST_Server::CREATABLE.
+ *
* @return array $endpoint_args
*/
public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CREATABLE ) {
- $schema = $this->get_item_schema();
- $schema_properties = ! empty( $schema['properties'] ) ? $schema['properties'] : array();
- $endpoint_args = array();
+ $schema = $this->get_item_schema();
+ $schema_properties = ! empty( $schema['properties'] ) ? $schema['properties'] : array();
+ $endpoint_args = array();
foreach ( $schema_properties as $field_id => $params ) {
@@ -471,7 +430,10 @@ public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CRE
// Only use required / default from arg_options on CREATABLE endpoints.
if ( WP_REST_Server::CREATABLE !== $method ) {
- $params['arg_options'] = array_diff_key( $params['arg_options'], array( 'required' => '', 'default' => '' ) );
+ $params['arg_options'] = array_diff_key( $params['arg_options'], array(
+ 'required' => '',
+ 'default' => ''
+ ) );
}
$endpoint_args[ $field_id ] = array_merge( $endpoint_args[ $field_id ], $params['arg_options'] );
@@ -490,9 +452,10 @@ public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CRE
* post that is used in the REST API.
*
* @see get_post()
- * @global WP_Query $wp_query
+ * @global WP_Query $wp_query
*
* @param int|WP_Post $post Post ID or post object. Defaults to global $post.
+ *
* @return WP_Post|null A `WP_Post` object when successful.
*/
public function get_post( $post ) {
@@ -503,11 +466,71 @@ public function get_post( $post ) {
*
* Allows plugins to filter the post object as returned by `\WP_REST_Controller::get_post()`.
*
- * @param WP_Post|null $post_obj The post object as returned by `get_post()`.
- * @param int|WP_Post $post The original value used to obtain the post object.
+ * @param WP_Post|null $post_obj The post object as returned by `get_post()`.
+ * @param int|WP_Post $post The original value used to obtain the post object.
*/
$post = apply_filters( 'rest_the_post', $post_obj, $post );
return $post;
}
+
+ /**
+ * Prepare the item for create or update operation.
+ *
+ * @param WP_REST_Request $request Request object.
+ *
+ * @return WP_Error|object $prepared_item
+ */
+ protected function prepare_item_for_database( $request ) {
+ return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be over-ridden in subclass." ), __METHOD__ ), array( 'status' => 405 ) );
+ }
+
+ /**
+ * Add the values from additional fields to a data object.
+ *
+ * @param array $object
+ * @param WP_REST_Request $request
+ *
+ * @return array modified object with additional fields.
+ */
+ protected function add_additional_fields_to_object( $object, $request ) {
+
+ $additional_fields = $this->get_additional_fields();
+
+ foreach ( $additional_fields as $field_name => $field_options ) {
+
+ if ( ! $field_options['get_callback'] ) {
+ continue;
+ }
+
+ $object[ $field_name ] = call_user_func( $field_options['get_callback'], $object, $field_name, $request, $this->get_object_type() );
+ }
+
+ return $object;
+ }
+
+ /**
+ * Update the values of additional fields added to a data object.
+ *
+ * @param array $object
+ * @param WP_REST_Request $request
+ */
+ protected function update_additional_fields_for_object( $object, $request ) {
+
+ $additional_fields = $this->get_additional_fields();
+
+ foreach ( $additional_fields as $field_name => $field_options ) {
+
+ if ( ! $field_options['update_callback'] ) {
+ continue;
+ }
+
+ // Don't run the update callbacks if the data wasn't passed in the request.
+ if ( ! isset( $request[ $field_name ] ) ) {
+ continue;
+ }
+
+ call_user_func( $field_options['update_callback'], $request[ $field_name ], $object, $field_name, $request, $this->get_object_type() );
+ }
+ }
}
diff --git a/includes/CMB2/includes/types/CMB2_Type_Base.php b/includes/CMB2/includes/types/CMB2_Type_Base.php
index 58739e0..af4de03 100755
--- a/includes/CMB2/includes/types/CMB2_Type_Base.php
+++ b/includes/CMB2/includes/types/CMB2_Type_Base.php
@@ -1,9 +1,10 @@
types = $types;
+ $this->types = $types;
$args['rendered'] = isset( $args['rendered'] ) ? (bool) $args['rendered'] : true;
- $this->args = $args;
+ $this->args = $args;
}
/**
* Handles rendering this field type.
+ *
* @since 2.2.2
* @return string Rendered field type.
*/
@@ -52,8 +59,11 @@ abstract public function render();
/**
* Stores the rendered field output.
+ *
* @since 2.2.2
+ *
* @param string|CMB2_Type_Base $rendered Rendered output.
+ *
* @return string|CMB2_Type_Base Rendered output or this object.
*/
public function rendered( $rendered ) {
@@ -68,6 +78,7 @@ public function rendered( $rendered ) {
/**
* Returns the stored rendered field output.
+ *
* @since 2.2.2
* @return string Stored rendered output (if 'rendered' argument is set to false).
*/
@@ -77,10 +88,13 @@ public function get_rendered() {
/**
* Handles parsing and filtering attributes while preserving any passed in via field config.
+ *
* @since 1.1.0
+ *
* @param string $element Element for filter
* @param array $type_defaults Type default arguments
* @param array $type_args Type override arguments
+ *
* @return array Parsed and filtered arguments
*/
public function parse_args( $element, $type_defaults, $type_args = array() ) {
@@ -95,9 +109,11 @@ public function parse_args( $element, $type_defaults, $type_args = array() ) {
/**
* Filter attributes for a field type.
* The dynamic portion of the hook name, $element, refers to the field type.
+ *
* @since 1.1.0
+ *
* @param array $args The array of attribute arguments.
- * @param array $type_defaults The array of default values.
+ * @param array $type_defaults The array of default values.
* @param array $field The `CMB2_Field` object.
* @param object $field_type_object This `CMB2_Types` object.
*/
@@ -108,7 +124,9 @@ public function parse_args( $element, $type_defaults, $type_args = array() ) {
/**
* Fall back to CMB2_Types methods
+ *
* @param string $field
+ *
* @throws Exception Throws an exception if the field is invalid.
* @return mixed
*/
@@ -127,7 +145,9 @@ public function __call( $name, $arguments ) {
/**
* Magic getter for our object.
+ *
* @param string $field
+ *
* @throws Exception Throws an exception if the field is invalid.
* @return mixed
*/
diff --git a/includes/CMB2/includes/types/CMB2_Type_Checkbox.php b/includes/CMB2/includes/types/CMB2_Type_Checkbox.php
index 5bdb20f..88cc295 100755
--- a/includes/CMB2/includes/types/CMB2_Type_Checkbox.php
+++ b/includes/CMB2/includes/types/CMB2_Type_Checkbox.php
@@ -1,9 +1,10 @@
$input_type,
- 'class' => 'cmb2-upload-file regular-text',
- 'size' => 45,
- 'desc' => '',
+ 'type' => $input_type,
+ 'class' => 'cmb2-upload-file regular-text',
+ 'size' => 45,
+ 'desc' => '',
'data-previewsize' => is_array( $img_size ) ? '[' . implode( ',', $img_size ) . ']' : 350,
'data-queryargs' => ! empty( $query_args ) ? json_encode( $query_args ) : '',
'js_dependencies' => 'media-editor',
@@ -72,7 +73,7 @@ public function render() {
if ( $_id_value ) {
$image = wp_get_attachment_image( $_id_value, $img_size, null, array( 'class' => 'cmb-file-field-image' ) );
} else {
- $size = is_array( $img_size ) ? $img_size[0] : 350;
+ $size = is_array( $img_size ) ? $img_size[0] : 350;
$image = '
+
+
+
+
_render(); ?>
-
-
-
-
-
+
+
+ - ';
diff --git a/includes/CMB2/includes/types/CMB2_Type_Multi_Base.php b/includes/CMB2/includes/types/CMB2_Type_Multi_Base.php
index 69ca9d4..1177750 100755
--- a/includes/CMB2/includes/types/CMB2_Type_Multi_Base.php
+++ b/includes/CMB2/includes/types/CMB2_Type_Multi_Base.php
@@ -1,9 +1,10 @@
%s', $args['value'], selected( isset( $args['checked'] ) && $args['checked'], true, false ), $args['label'] ) . "\n";
}
+ /**
+ * Generates html for list item with checkbox input
+ *
+ * @since 1.1.0
+ *
+ * @param array $args Override arguments
+ * @param int $i Iterator value
+ *
+ * @return string Gnerated list item html
+ */
+ public function list_input_checkbox( $args, $i ) {
+ $saved_value = $this->field->escaped_value();
+ if ( is_array( $saved_value ) && in_array( $args['value'], $saved_value ) ) {
+ $args['checked'] = 'checked';
+ }
+ $args['type'] = 'checkbox';
+
+ return $this->list_input( $args, $i );
+ }
+
/**
* Generates html for list item with input
+ *
* @since 1.1.0
- * @param array $args Override arguments
- * @param int $i Iterator value
+ *
+ * @param array $args Override arguments
+ * @param int $i Iterator value
+ *
* @return string Gnerated list item html
*/
public function list_input( $args = array(), $i ) {
@@ -43,26 +70,13 @@ public function list_input( $args = array(), $i ) {
return sprintf( "\t" . '
%s', parent::render( array( 'class' => 'cmb2-textarea-code', - 'desc' => '' . $this->_desc( true ), + 'desc' => '' . $this->_desc( true ), ) ) ) ); } diff --git a/includes/CMB2/includes/types/CMB2_Type_Title.php b/includes/CMB2/includes/types/CMB2_Type_Title.php index 18bc598..4ec1e4d 100755 --- a/includes/CMB2/includes/types/CMB2_Type_Title.php +++ b/includes/CMB2/includes/types/CMB2_Type_Title.php @@ -1,9 +1,10 @@ field; - $a = $this->parse_args( 'wysiwyg', array( + $a = $this->parse_args( 'wysiwyg', array( 'id' => $this->_id(), 'value' => $field->escaped_value( 'stripslashes' ), 'desc' => $this->_desc( true ), @@ -56,13 +58,14 @@ public function render() { protected function get_wp_editor( $args ) { ob_start(); wp_editor( $args['value'], $args['id'], $args['options'] ); + return ob_get_clean(); } public function add_wysiwyg_template_for_group() { - $group_id = $this->field->group->id(); - $field_id = $this->field->id( true ); - $options = $this->field->options(); + $group_id = $this->field->group->id(); + $field_id = $this->field->id( true ); + $options = $this->field->options(); $options['textarea_name'] = 'cmb2_n_' . $group_id . $field_id; // Initate the editor with special id/value/name so we can retrieve the options in JS. @@ -86,7 +89,7 @@ public function add_wysiwyg_template_for_group() { // And put the editor instance in a JS template wrapper. echo ''; } diff --git a/includes/CMB2/js/cmb2-wysiwyg.js b/includes/CMB2/js/cmb2-wysiwyg.js index 03b48ac..d8b5d28 100755 --- a/includes/CMB2/js/cmb2-wysiwyg.js +++ b/includes/CMB2/js/cmb2-wysiwyg.js @@ -4,328 +4,328 @@ window.CMB2 = window.CMB2 || {}; window.CMB2.wysiwyg = window.CMB2.wysiwyg || {}; -( function(window, document, $, wysiwyg, undefined ) { - 'use strict'; - - // Private variables - var toBeDestroyed = []; - var toBeInitialized = []; - var all = wysiwyg.all = {}; - - // Private functions - - /** - * Initializes any editors that weren't initialized because they didn't exist yet. - * - * @since 2.2.3 - * - * @return {void} - */ - function delayedInit() { - - // Don't initialize until they've all been destroyed. - if ( 0 === toBeDestroyed.length ) { - toBeInitialized.forEach( function ( toInit ) { - toBeInitialized.splice( toBeInitialized.indexOf( toInit ), 1 ); - wysiwyg.init.apply( wysiwyg, toInit ); - } ); - } else { - window.setTimeout( delayedInit, 100 ); - } - } - - /** - * Destroys any editors that weren't destroyed because they didn't exist yet. - * - * @since 2.2.3 - * - * @return {void} - */ - function delayedDestroy() { - toBeDestroyed.forEach( function( id ) { - toBeDestroyed.splice( toBeDestroyed.indexOf( id ), 1 ); - wysiwyg.destroy( id ); - } ); - } - - /** - * Gets the option data for a group (and initializes that data if it doesn't exist). - * - * @since 2.2.3 - * - * @param {object} data The group/field data. - * - * @return {object} Options data object for a group. - */ - function getGroupData( data ) { - var groupid = data.groupid; - var fieldid = data.fieldid; - - if ( ! all[ groupid ] || ! all[ groupid ][ fieldid ] ) { - all[ groupid ] = all[ groupid ] || {}; - all[ groupid ][ fieldid ] = { - template : wp.template( 'cmb2-wysiwyg-' + groupid + '-' + fieldid ), - defaults : { - - // Get the data from the template-wysiwyg initiation. - mce : $.extend( {}, tinyMCEPreInit.mceInit[ 'cmb2_i_' + groupid + fieldid ] ), - qt : $.extend( {}, tinyMCEPreInit.qtInit[ 'cmb2_i_' + groupid + fieldid ] ) - } - }; - // This is the template-wysiwyg data, and we do not want that to be initiated. - delete tinyMCEPreInit.mceInit[ 'cmb2_i_' + groupid + fieldid ]; - delete tinyMCEPreInit.qtInit[ 'cmb2_i_' + groupid + fieldid ]; - } - - return all[ groupid ][ fieldid ]; - } - - /** - * Initiates the tinyMCEPreInit options for a wysiwyg editor instance. - * - * @since 2.2.3 - * - * @param {object} options Options data object for the wysiwyg editor instance. - * - * @return {void} - */ - function initOptions( options ) { - var nameRegex = new RegExp( 'cmb2_n_' + options.groupid + options.fieldid, 'g' ); - var idRegex = new RegExp( 'cmb2_i_' + options.groupid + options.fieldid, 'g' ); - var prop, newSettings, newQTS; - - // If no settings for this field. Clone from placeholder. - if ( 'undefined' === typeof( tinyMCEPreInit.mceInit[ options.id ] ) ) { - newSettings = $.extend( {}, options.defaults.mce ); - for ( prop in newSettings ) { - if ( 'string' === typeof( newSettings[ prop ] ) ) { - newSettings[ prop ] = newSettings[ prop ] - .replace( idRegex, options.id ) - .replace( nameRegex, options.name ); - } - } - tinyMCEPreInit.mceInit[ options.id ] = newSettings; - } - - // If no Quicktag settings for this field. Clone from placeholder. - if ( 'undefined' === typeof( tinyMCEPreInit.qtInit[ options.id ] ) ) { - newQTS = $.extend( {}, options.defaults.qt ); - for ( prop in newQTS ) { - if ( 'string' === typeof( newQTS[ prop ] ) ) { - newQTS[ prop ] = newQTS[ prop ] - .replace( idRegex, options.id ) - .replace( nameRegex, options.name ); - } - } - tinyMCEPreInit.qtInit[ options.id ] = newQTS; - } - } - - /** - * Initializes all group wysiwyg editors. Hooked to cmb_init. - * - * @since 2.2.3 - * - * @return {void} - */ - wysiwyg.initAll = function() { - var $this,data,initiated; - - $( '.cmb2-wysiwyg-placeholder' ).each( function() { - $this = $( this ); - data = $this.data(); - - if ( data.groupid ) { - - data.id = $this.attr( 'id' ); - data.name = $this.attr( 'name' ); - data.value = $this.val(); - - wysiwyg.init( $this, data, false ); - initiated = true; - } - } ); - - if ( true === initiated ) { - if ( 'undefined' !== typeof window.QTags ) { - window.QTags._buttonsInit(); - } - - // Hook in our event callbacks. - $( document ) - .on( 'cmb2_add_row', wysiwyg.addRow ) - .on( 'cmb2_remove_group_row_start', wysiwyg.destroyRowEditors ) - .on( 'cmb2_shift_rows_start', wysiwyg.shiftStart ) - .on( 'cmb2_shift_rows_complete', wysiwyg.shiftComplete ); - } - }; - - /** - * Initiates wysiwyg editors in a new group row. Hooked to cmb2_add_row. - * - * @since 2.2.3 - * - * @param {object} evt A jQuery-normalized event object. - * @param {object} $row A jQuery dom element object for the group row. - * - * @return {void} - */ - wysiwyg.addRow = function( evt, $row ) { - wysiwyg.initRow( $row ); - }; - - /** - * Destroys wysiwyg editors in a group row when that row is removed. Hooked to cmb2_remove_group_row_start. - * - * @since 2.2.3 - * - * @param {object} evt A jQuery-normalized event object. - * @param {object} $btn A jQuery dom element object for the remove-row button. - * - * @return {void} - */ - wysiwyg.destroyRowEditors = function( evt, $btn ) { - wysiwyg.destroy( $btn.parents( '.cmb-repeatable-grouping' ).find( '.wp-editor-area' ).attr( 'id' ) ); - }; - - /** - * When a row-shift starts, we need to destroy the wysiwyg editors for the group-rows being shuffled. - * - * @since 2.2.3 - * - * @param {object} evt A jQuery-normalized event object. - * @param {object} $btn A jQuery dom element object for the remove-row button. - * @param {object} $from A jQuery dom element object for the row being shifted from. - * @param {object} $to A jQuery dom element object for the row being shifted to. - * - * @return {void} - */ - wysiwyg.shiftStart = function( evt, $btn, $from, $to ) { - $from.add( $to ).find( '.wp-editor-wrap textarea' ).each( function() { - wysiwyg.destroy( $( this ).attr( 'id' ) ); - } ); - }; - - /** - * When a row-shift completes, we need to re-init the wysiwyg editors for the group-rows being shuffled. - * - * @since 2.2.3 - * - * @param {object} evt A jQuery-normalized event object. - * @param {object} $btn A jQuery dom element object for the remove-row button. - * @param {object} $from A jQuery dom element object for the row being shifted from. - * @param {object} $to A jQuery dom element object for the row being shifted to. - * - * @return {void} - */ - wysiwyg.shiftComplete = function( evt, $btn, $from, $to ) { - $from.add( $to ).each( function() { - wysiwyg.initRow( $( this ) ); - } ); - }; - - /** - * Initializes editors for a new CMB row. - * - * @since 2.2.3 - * - * @param {object} $row A jQuery dom element object for the group row. - * - * @return {void} - */ - wysiwyg.initRow = function( $row ) { - var $toReplace, data; - - $row.find( '.cmb2-wysiwyg-inner-wrap' ).each( function() { - $toReplace = $( this ); - data = $toReplace.data(); - - data.iterator = $row.data( 'iterator' ); - data.fieldid = data.id; - data.id = data.groupid + '_' + data.iterator + '_' + data.fieldid; - data.name = data.groupid + '[' + data.iterator + '][' + data.fieldid + ']'; - data.value = $toReplace.find( '.wp-editor-area' ).length ? $toReplace.find( '.wp-editor-area' ).val() : ''; - - // The destroys might not have happened yet. Don't init until they have. - if ( 0 === toBeDestroyed.length ) { - - wysiwyg.init( $toReplace, data ); - - } else { - toBeInitialized.push( [$toReplace, data] ); - window.setTimeout( delayedInit, 100 ); - } - } ); - - }; - - /** - * Initiates a wysiwyg editor instance and replaces the passed dom element w/ the editor html. - * - * @since 2.2.3 - * - * @param {object} $toReplace A jQuery dom element which will be replaced with the wysiwyg editor. - * @param {object} data Data used to initate the editor. - * @param {bool} buttonsInit Whether to run QTags._buttonsInit() - * - * @return {void} - */ - wysiwyg.init = function( $toReplace, data, buttonsInit ) { - if ( ! data.groupid ) { - return false; - } - - $.extend( data, getGroupData( data ) ); - - initOptions( data ); - - $toReplace.replaceWith( data.template( data ) ); - - window.tinyMCE.init( tinyMCEPreInit.mceInit[ data.id ] ); - if ( 'function' === typeof window.quicktags ) { - window.quicktags( tinyMCEPreInit.qtInit[ data.id ] ); - } - - $( document.getElementById( data.id ) ).parents( '.wp-editor-wrap' ).removeClass( 'html-active' ).addClass( 'tmce-active' ); - - if ( false !== buttonsInit && 'undefined' !== typeof window.QTags ) { - window.QTags._buttonsInit(); - } - - }; - - /** - * Destroys a wysiwyg editor instance. - * - * @since 2.2.3 - * - * @param {string} id Editor id. - * - * @return {void} - */ - wysiwyg.destroy = function( id ) { - - // The editor might not be initialized yet. But we need to destroy it once it is. - var editor = tinyMCE.get( id ); - - if ( editor !== null && typeof( editor ) !== 'undefined' ) { - editor.destroy(); - - if ( 'undefined' === typeof( tinyMCEPreInit.mceInit[ id ] ) ) { - delete tinyMCEPreInit.mceInit[ id ]; - } - - if ( 'undefined' === typeof( tinyMCEPreInit.qtInit[ id ] ) ) { - delete tinyMCEPreInit.qtInit[ id ]; - } - - } else if ( -1 === toBeDestroyed.indexOf( id ) ) { - toBeDestroyed.push( id ); - window.setTimeout( delayedDestroy, 100 ); - } - }; - - // Hook in our event callbacks. - $( document ).on( 'cmb_init', wysiwyg.initAll ); - -} )( window, document, jQuery, window.CMB2.wysiwyg ); +(function (window, document, $, wysiwyg, undefined) { + 'use strict'; + + // Private variables + var toBeDestroyed = []; + var toBeInitialized = []; + var all = wysiwyg.all = {}; + + // Private functions + + /** + * Initializes any editors that weren't initialized because they didn't exist yet. + * + * @since 2.2.3 + * + * @return {void} + */ + function delayedInit() { + + // Don't initialize until they've all been destroyed. + if (0 === toBeDestroyed.length) { + toBeInitialized.forEach(function (toInit) { + toBeInitialized.splice(toBeInitialized.indexOf(toInit), 1); + wysiwyg.init.apply(wysiwyg, toInit); + }); + } else { + window.setTimeout(delayedInit, 100); + } + } + + /** + * Destroys any editors that weren't destroyed because they didn't exist yet. + * + * @since 2.2.3 + * + * @return {void} + */ + function delayedDestroy() { + toBeDestroyed.forEach(function (id) { + toBeDestroyed.splice(toBeDestroyed.indexOf(id), 1); + wysiwyg.destroy(id); + }); + } + + /** + * Gets the option data for a group (and initializes that data if it doesn't exist). + * + * @since 2.2.3 + * + * @param {object} data The group/field data. + * + * @return {object} Options data object for a group. + */ + function getGroupData(data) { + var groupid = data.groupid; + var fieldid = data.fieldid; + + if (!all[groupid] || !all[groupid][fieldid]) { + all[groupid] = all[groupid] || {}; + all[groupid][fieldid] = { + template: wp.template('cmb2-wysiwyg-' + groupid + '-' + fieldid), + defaults: { + + // Get the data from the template-wysiwyg initiation. + mce: $.extend({}, tinyMCEPreInit.mceInit['cmb2_i_' + groupid + fieldid]), + qt: $.extend({}, tinyMCEPreInit.qtInit['cmb2_i_' + groupid + fieldid]) + } + }; + // This is the template-wysiwyg data, and we do not want that to be initiated. + delete tinyMCEPreInit.mceInit['cmb2_i_' + groupid + fieldid]; + delete tinyMCEPreInit.qtInit['cmb2_i_' + groupid + fieldid]; + } + + return all[groupid][fieldid]; + } + + /** + * Initiates the tinyMCEPreInit options for a wysiwyg editor instance. + * + * @since 2.2.3 + * + * @param {object} options Options data object for the wysiwyg editor instance. + * + * @return {void} + */ + function initOptions(options) { + var nameRegex = new RegExp('cmb2_n_' + options.groupid + options.fieldid, 'g'); + var idRegex = new RegExp('cmb2_i_' + options.groupid + options.fieldid, 'g'); + var prop, newSettings, newQTS; + + // If no settings for this field. Clone from placeholder. + if ('undefined' === typeof( tinyMCEPreInit.mceInit[options.id] )) { + newSettings = $.extend({}, options.defaults.mce); + for (prop in newSettings) { + if ('string' === typeof( newSettings[prop] )) { + newSettings[prop] = newSettings[prop] + .replace(idRegex, options.id) + .replace(nameRegex, options.name); + } + } + tinyMCEPreInit.mceInit[options.id] = newSettings; + } + + // If no Quicktag settings for this field. Clone from placeholder. + if ('undefined' === typeof( tinyMCEPreInit.qtInit[options.id] )) { + newQTS = $.extend({}, options.defaults.qt); + for (prop in newQTS) { + if ('string' === typeof( newQTS[prop] )) { + newQTS[prop] = newQTS[prop] + .replace(idRegex, options.id) + .replace(nameRegex, options.name); + } + } + tinyMCEPreInit.qtInit[options.id] = newQTS; + } + } + + /** + * Initializes all group wysiwyg editors. Hooked to cmb_init. + * + * @since 2.2.3 + * + * @return {void} + */ + wysiwyg.initAll = function () { + var $this, data, initiated; + + $('.cmb2-wysiwyg-placeholder').each(function () { + $this = $(this); + data = $this.data(); + + if (data.groupid) { + + data.id = $this.attr('id'); + data.name = $this.attr('name'); + data.value = $this.val(); + + wysiwyg.init($this, data, false); + initiated = true; + } + }); + + if (true === initiated) { + if ('undefined' !== typeof window.QTags) { + window.QTags._buttonsInit(); + } + + // Hook in our event callbacks. + $(document) + .on('cmb2_add_row', wysiwyg.addRow) + .on('cmb2_remove_group_row_start', wysiwyg.destroyRowEditors) + .on('cmb2_shift_rows_start', wysiwyg.shiftStart) + .on('cmb2_shift_rows_complete', wysiwyg.shiftComplete); + } + }; + + /** + * Initiates wysiwyg editors in a new group row. Hooked to cmb2_add_row. + * + * @since 2.2.3 + * + * @param {object} evt A jQuery-normalized event object. + * @param {object} $row A jQuery dom element object for the group row. + * + * @return {void} + */ + wysiwyg.addRow = function (evt, $row) { + wysiwyg.initRow($row); + }; + + /** + * Destroys wysiwyg editors in a group row when that row is removed. Hooked to cmb2_remove_group_row_start. + * + * @since 2.2.3 + * + * @param {object} evt A jQuery-normalized event object. + * @param {object} $btn A jQuery dom element object for the remove-row button. + * + * @return {void} + */ + wysiwyg.destroyRowEditors = function (evt, $btn) { + wysiwyg.destroy($btn.parents('.cmb-repeatable-grouping').find('.wp-editor-area').attr('id')); + }; + + /** + * When a row-shift starts, we need to destroy the wysiwyg editors for the group-rows being shuffled. + * + * @since 2.2.3 + * + * @param {object} evt A jQuery-normalized event object. + * @param {object} $btn A jQuery dom element object for the remove-row button. + * @param {object} $from A jQuery dom element object for the row being shifted from. + * @param {object} $to A jQuery dom element object for the row being shifted to. + * + * @return {void} + */ + wysiwyg.shiftStart = function (evt, $btn, $from, $to) { + $from.add($to).find('.wp-editor-wrap textarea').each(function () { + wysiwyg.destroy($(this).attr('id')); + }); + }; + + /** + * When a row-shift completes, we need to re-init the wysiwyg editors for the group-rows being shuffled. + * + * @since 2.2.3 + * + * @param {object} evt A jQuery-normalized event object. + * @param {object} $btn A jQuery dom element object for the remove-row button. + * @param {object} $from A jQuery dom element object for the row being shifted from. + * @param {object} $to A jQuery dom element object for the row being shifted to. + * + * @return {void} + */ + wysiwyg.shiftComplete = function (evt, $btn, $from, $to) { + $from.add($to).each(function () { + wysiwyg.initRow($(this)); + }); + }; + + /** + * Initializes editors for a new CMB row. + * + * @since 2.2.3 + * + * @param {object} $row A jQuery dom element object for the group row. + * + * @return {void} + */ + wysiwyg.initRow = function ($row) { + var $toReplace, data; + + $row.find('.cmb2-wysiwyg-inner-wrap').each(function () { + $toReplace = $(this); + data = $toReplace.data(); + + data.iterator = $row.data('iterator'); + data.fieldid = data.id; + data.id = data.groupid + '_' + data.iterator + '_' + data.fieldid; + data.name = data.groupid + '[' + data.iterator + '][' + data.fieldid + ']'; + data.value = $toReplace.find('.wp-editor-area').length ? $toReplace.find('.wp-editor-area').val() : ''; + + // The destroys might not have happened yet. Don't init until they have. + if (0 === toBeDestroyed.length) { + + wysiwyg.init($toReplace, data); + + } else { + toBeInitialized.push([$toReplace, data]); + window.setTimeout(delayedInit, 100); + } + }); + + }; + + /** + * Initiates a wysiwyg editor instance and replaces the passed dom element w/ the editor html. + * + * @since 2.2.3 + * + * @param {object} $toReplace A jQuery dom element which will be replaced with the wysiwyg editor. + * @param {object} data Data used to initate the editor. + * @param {bool} buttonsInit Whether to run QTags._buttonsInit() + * + * @return {void} + */ + wysiwyg.init = function ($toReplace, data, buttonsInit) { + if (!data.groupid) { + return false; + } + + $.extend(data, getGroupData(data)); + + initOptions(data); + + $toReplace.replaceWith(data.template(data)); + + window.tinyMCE.init(tinyMCEPreInit.mceInit[data.id]); + if ('function' === typeof window.quicktags) { + window.quicktags(tinyMCEPreInit.qtInit[data.id]); + } + + $(document.getElementById(data.id)).parents('.wp-editor-wrap').removeClass('html-active').addClass('tmce-active'); + + if (false !== buttonsInit && 'undefined' !== typeof window.QTags) { + window.QTags._buttonsInit(); + } + + }; + + /** + * Destroys a wysiwyg editor instance. + * + * @since 2.2.3 + * + * @param {string} id Editor id. + * + * @return {void} + */ + wysiwyg.destroy = function (id) { + + // The editor might not be initialized yet. But we need to destroy it once it is. + var editor = tinyMCE.get(id); + + if (editor !== null && typeof( editor ) !== 'undefined') { + editor.destroy(); + + if ('undefined' === typeof( tinyMCEPreInit.mceInit[id] )) { + delete tinyMCEPreInit.mceInit[id]; + } + + if ('undefined' === typeof( tinyMCEPreInit.qtInit[id] )) { + delete tinyMCEPreInit.qtInit[id]; + } + + } else if (-1 === toBeDestroyed.indexOf(id)) { + toBeDestroyed.push(id); + window.setTimeout(delayedDestroy, 100); + } + }; + + // Hook in our event callbacks. + $(document).on('cmb_init', wysiwyg.initAll); + +})(window, document, jQuery, window.CMB2.wysiwyg); diff --git a/includes/CMB2/js/cmb2.js b/includes/CMB2/js/cmb2.js index f5f8108..34aedf5 100755 --- a/includes/CMB2/js/cmb2.js +++ b/includes/CMB2/js/cmb2.js @@ -5,968 +5,970 @@ * @see https://github.com/WebDevStudios/CMB2 */ - // TODO: fix this. - // JQMIGRATE: jQuery.fn.attr('value') no longer gets properties +// TODO: fix this. +// JQMIGRATE: jQuery.fn.attr('value') no longer gets properties /** * Custom jQuery for Custom Metaboxes and Fields */ window.CMB2 = window.CMB2 || {}; -(function(window, document, $, cmb, undefined){ - 'use strict'; - - // localization strings - var l10n = window.cmb2_l10; - var setTimeout = window.setTimeout; - var $document; - var $id = function( selector ) { - return $( document.getElementById( selector ) ); - }; - var defaults = { - idNumber : false, - repeatEls : 'input:not([type="button"],[id^=filelist]),select,textarea,.cmb2-media-status', - noEmpty : 'input:not([type="button"]):not([type="radio"]):not([type="checkbox"]),textarea', - repeatUpdate : 'input:not([type="button"]),select,textarea,label', - styleBreakPoint : 450, - mediaHandlers : {}, - defaults : { - time_picker : l10n.defaults.time_picker, - date_picker : l10n.defaults.date_picker, - color_picker : l10n.defaults.color_picker || {}, - }, - media : { - frames : {}, - }, - }; - - cmb.metabox = function() { - if ( cmb.$metabox ) { - return cmb.$metabox; - } - cmb.$metabox = $('.cmb2-wrap > .cmb2-metabox'); - return cmb.$metabox; - }; - - cmb.init = function() { - $document = $( document ); - - // Setup the CMB2 object defaults. - $.extend( cmb, defaults ); - - cmb.trigger( 'cmb_pre_init' ); - - var $metabox = cmb.metabox(); - var $repeatGroup = $metabox.find('.cmb-repeatable-group'); - - /** - * Initialize time/date/color pickers - */ - cmb.initPickers( $metabox.find('input[type="text"].cmb2-timepicker'), $metabox.find('input[type="text"].cmb2-datepicker'), $metabox.find('input[type="text"].cmb2-colorpicker') ); - - // Insert toggle button into DOM wherever there is multicheck. credit: Genesis Framework - $( '
' ).insertBefore( '.cmb2-checkbox-list:not(.no-select-all)' ); - - // Make File List drag/drop sortable: - cmb.makeListSortable(); - - $metabox - .on( 'change', '.cmb2_upload_file', function() { - cmb.media.field = $( this ).attr( 'id' ); - $id( cmb.media.field + '_id' ).val(''); - }) - // Media/file management - .on( 'click', '.cmb-multicheck-toggle', cmb.toggleCheckBoxes ) - .on( 'click', '.cmb2-upload-button', cmb.handleMedia ) - .on( 'click', '.cmb-attach-list li, .cmb2-media-status .img-status img, .cmb2-media-status .file-status > span', cmb.handleFileClick ) - .on( 'click', '.cmb2-remove-file-button', cmb.handleRemoveMedia ) - // Repeatable content - .on( 'click', '.cmb-add-group-row', cmb.addGroupRow ) - .on( 'click', '.cmb-add-row-button', cmb.addAjaxRow ) - .on( 'click', '.cmb-remove-group-row', cmb.removeGroupRow ) - .on( 'click', '.cmb-remove-row-button', cmb.removeAjaxRow ) - // Ajax oEmbed display - .on( 'keyup paste focusout', '.cmb2-oembed', cmb.maybeOembed ) - // Reset titles when removing a row - .on( 'cmb2_remove_row', '.cmb-repeatable-group', cmb.resetTitlesAndIterator ) - .on( 'click', '.cmbhandle, .cmbhandle + .cmbhandle-title', cmb.toggleHandle ); - - if ( $repeatGroup.length ) { - $repeatGroup - .filter('.sortable').each( function() { - // Add sorting arrows - $( this ).find( '.button.cmb-remove-group-row' ).before( ' ' ); - }) - .on( 'click', '.cmb-shift-rows', cmb.shiftRows ) - .on( 'cmb2_add_row', cmb.emptyValue ); - } - - // on pageload - setTimeout( cmb.resizeoEmbeds, 500); - // and on window resize - $( window ).on( 'resize', cmb.resizeoEmbeds ); - - cmb.trigger( 'cmb_init' ); - }; - - cmb.resetTitlesAndIterator = function( evt ) { - if ( ! evt.group ) { - return; - } - - // Loop repeatable group tables - $( '.cmb-repeatable-group' ).each( function() { - var $table = $( this ); - // Loop repeatable group table rows - $table.find( '.cmb-repeatable-grouping' ).each( function( rowindex ) { - var $row = $( this ); - // Reset rows iterator - $row.data( 'iterator', rowindex ); - // Reset rows title - $row.find( '.cmb-group-title h4' ).text( $table.find( '.cmb-add-group-row' ).data( 'grouptitle' ).replace( '{#}', ( rowindex + 1 ) ) ); - }); - }); - }; - - cmb.toggleHandle = function( evt ) { - evt.preventDefault(); - cmb.trigger( 'postbox-toggled', $( this ).parent('.postbox').toggleClass('closed') ); - }; - - cmb.toggleCheckBoxes = function( evt ) { - evt.preventDefault(); - var $this = $( this ); - var $multicheck = $this.closest( '.cmb-td' ).find( 'input[type=checkbox]:not([disabled])' ); - - // If the button has already been clicked once... - if ( $this.data( 'checked' ) ) { - // clear the checkboxes and remove the flag - $multicheck.prop( 'checked', false ); - $this.data( 'checked', false ); - } - // Otherwise mark the checkboxes and add a flag - else { - $multicheck.prop( 'checked', true ); - $this.data( 'checked', true ); - } - }; - - cmb.handleMedia = function( evt ) { - evt.preventDefault(); - - var $el = $( this ); - cmb.attach_id = ! $el.hasClass( 'cmb2-upload-list' ) ? $el.closest( '.cmb-td' ).find( '.cmb2-upload-file-id' ).val() : false; - // Clean up default 0 value - cmb.attach_id = '0' !== cmb.attach_id ? cmb.attach_id : false; - - cmb._handleMedia( $el.prev('input.cmb2-upload-file').attr('id'), $el.hasClass( 'cmb2-upload-list' ) ); - }; - - cmb.handleFileClick = function( evt ) { - evt.preventDefault(); - - var $el = $( this ); - var $td = $el.closest( '.cmb-td' ); - var isList = $td.find( '.cmb2-upload-button' ).hasClass( 'cmb2-upload-list' ); - cmb.attach_id = isList ? $el.find( 'input[type="hidden"]' ).data( 'id' ) : $td.find( '.cmb2-upload-file-id' ).val(); - - if ( cmb.attach_id ) { - cmb._handleMedia( $td.find( 'input.cmb2-upload-file' ).attr('id'), isList, cmb.attach_id ); - } - }; - - cmb._handleMedia = function( formfield, isList ) { - if ( ! wp ) { - return; - } - - var media = cmb.media; - media.field = formfield; - media.$field = $id( media.field ); - media.fieldData = media.$field.data(); - media.previewSize = media.fieldData.previewsize; - media.fieldName = media.$field.attr('name'); - media.isList = isList; - - var uploadStatus, attachment; - - // If this field's media frame already exists, reopen it. - if ( media.field in media.frames ) { - media.frames[ media.field ].open(); - return; - } - - // Create the media frame. - media.frames[ media.field ] = wp.media( { - title: cmb.metabox().find('label[for="' + media.field + '"]').text(), - library : media.fieldData.queryargs || {}, - button: { - text: l10n.strings[ isList ? 'upload_files' : 'upload_file' ] - }, - multiple: isList ? 'add' : false - } ); - - cmb.trigger( 'cmb_media_modal_init', media ); - - cmb.mediaHandlers.list = function( selection, returnIt ) { - // Get all of our selected files - attachment = selection.toJSON(); - - media.$field.val(attachment.url); - $id( media.field +'_id' ).val(attachment.id); - - // Setup our fileGroup array - var fileGroup = []; - - // Loop through each attachment - $( attachment ).each( function() { - if ( this.type && this.type === 'image' ) { - var width = media.previewSize[0] ? media.previewSize[0] : 50; - var height = media.previewSize[1] ? media.previewSize[1] : 50; - - // image preview - uploadStatus = '
'+ l10n.strings.file +' '+ attachment.filename +' ('+ l10n.strings.download +' / '+ l10n.strings.remove_file +')
';
- }
-
- // add/display our output
- media.$field.siblings('.cmb2-media-status').slideDown().html(uploadStatus);
- };
-
- cmb.mediaHandlers.selectFile = function() {
- var selection = media.frames[ media.field ].state().get('selection');
- var type = isList ? 'list' : 'single';
-
- if ( cmb.attach_id && isList ) {
- $( '[data-id="'+ cmb.attach_id +'"]' ).parents( 'li' ).replaceWith( cmb.mediaHandlers.list( selection, true ) );
- } else {
- cmb.mediaHandlers[type]( selection );
- }
-
- cmb.trigger( 'cmb_media_modal_select', selection, media );
- };
-
- cmb.mediaHandlers.openModal = function() {
- var selection = media.frames[ media.field ].state().get('selection');
- var attach;
-
- if ( ! cmb.attach_id ) {
- selection.reset();
- } else {
- attach = wp.media.attachment( cmb.attach_id );
- attach.fetch();
- selection.set( attach ? [ attach ] : [] );
- }
-
- cmb.trigger( 'cmb_media_modal_open', selection, media );
- };
-
- // When a file is selected, run a callback.
- media.frames[ media.field ]
- .on( 'select', cmb.mediaHandlers.selectFile )
- .on( 'open', cmb.mediaHandlers.openModal );
-
- // Finally, open the modal
- media.frames[ media.field ].open();
- };
-
- cmb.handleRemoveMedia = function( evt ) {
- evt.preventDefault();
- var $this = $( this );
- if ( $this.is( '.cmb-attach-list .cmb2-remove-file-button' ) ){
- $this.parents('li').remove();
- return false;
- }
-
- cmb.media.field = $this.attr('rel');
-
- cmb.metabox().find( 'input#' + cmb.media.field ).val('');
- cmb.metabox().find( 'input#' + cmb.media.field + '_id' ).val('');
- $this.parents('.cmb2-media-status').html('');
-
- return false;
- };
-
- cmb.cleanRow = function( $row, prevNum, group ) {
- var $elements = $row.find( cmb.repeatUpdate );
- if ( group ) {
-
- var $other = $row.find( '[id]' ).not( cmb.repeatUpdate );
-
- // Remove extra ajaxed rows
- $row.find('.cmb-repeat-table .cmb-repeat-row:not(:first-child)').remove();
-
- // Update all elements w/ an ID
- if ( $other.length ) {
- $other.each( function() {
- var $_this = $( this );
- var oldID = $_this.attr( 'id' );
- var newID = oldID.replace( '_'+ prevNum, '_'+ cmb.idNumber );
- var $buttons = $row.find('[data-selector="'+ oldID +'"]');
- $_this.attr( 'id', newID );
-
- // Replace data-selector vars
- if ( $buttons.length ) {
- $buttons.attr( 'data-selector', newID ).data( 'selector', newID );
- }
- });
- }
- }
-
- $elements.filter(':checked').prop( 'checked', false );
- $elements.filter(':selected').prop( 'selected', false );
-
- if ( $row.find('h3.cmb-group-title').length ) {
- $row.find( 'h3.cmb-group-title' ).text( $row.data( 'title' ).replace( '{#}', ( cmb.idNumber + 1 ) ) );
- }
-
- $elements.each( function() {
- cmb.elReplacements( $( this ), prevNum );
- } );
-
- return cmb;
- };
-
- cmb.elReplacements = function( $newInput, prevNum ) {
- var oldFor = $newInput.attr( 'for' );
- var oldVal = $newInput.val();
- var type = $newInput.prop( 'type' );
- var checkable = 'radio' === type || 'checkbox' === type ? oldVal : false;
- // var $next = $newInput.next();
- var attrs = {};
- var newID, oldID;
- if ( oldFor ) {
- attrs = { 'for' : oldFor.replace( '_'+ prevNum, '_'+ cmb.idNumber ) };
- } else {
- var oldName = $newInput.attr( 'name' );
- // Replace 'name' attribute key
- var newName = oldName ? oldName.replace( '['+ prevNum +']', '['+ cmb.idNumber +']' ) : '';
- oldID = $newInput.attr( 'id' );
- newID = oldID ? oldID.replace( '_'+ prevNum, '_'+ cmb.idNumber ) : '';
- attrs = {
- id: newID,
- name: newName,
- // value: '',
- 'data-iterator': cmb.idNumber,
- };
-
- }
-
- // Clear out old values
- if ( undefined !== typeof( oldVal ) && oldVal || checkable ) {
- attrs.value = checkable ? checkable : '';
- }
-
- // Clear out textarea values
- if ( 'TEXTAREA' === $newInput.prop('tagName') ) {
- $newInput.html( '' );
- }
-
- if ( checkable ) {
- $newInput.removeAttr( 'checked' );
- }
-
- $newInput
- .removeClass( 'hasDatepicker' )
- .attr( attrs ).val( checkable ? checkable : '' );
-
- return $newInput;
- };
-
- cmb.newRowHousekeeping = function( $row ) {
-
- var $colorPicker = $row.find( '.wp-picker-container' );
- var $list = $row.find( '.cmb2-media-status' );
+(function (window, document, $, cmb, undefined) {
+ 'use strict';
+
+ // localization strings
+ var l10n = window.cmb2_l10;
+ var setTimeout = window.setTimeout;
+ var $document;
+ var $id = function (selector) {
+ return $(document.getElementById(selector));
+ };
+ var defaults = {
+ idNumber: false,
+ repeatEls: 'input:not([type="button"],[id^=filelist]),select,textarea,.cmb2-media-status',
+ noEmpty: 'input:not([type="button"]):not([type="radio"]):not([type="checkbox"]),textarea',
+ repeatUpdate: 'input:not([type="button"]),select,textarea,label',
+ styleBreakPoint: 450,
+ mediaHandlers: {},
+ defaults: {
+ time_picker: l10n.defaults.time_picker,
+ date_picker: l10n.defaults.date_picker,
+ color_picker: l10n.defaults.color_picker || {},
+ },
+ media: {
+ frames: {},
+ },
+ };
+
+ cmb.metabox = function () {
+ if (cmb.$metabox) {
+ return cmb.$metabox;
+ }
+ cmb.$metabox = $('.cmb2-wrap > .cmb2-metabox');
+ return cmb.$metabox;
+ };
+
+ cmb.init = function () {
+ $document = $(document);
+
+ // Setup the CMB2 object defaults.
+ $.extend(cmb, defaults);
+
+ cmb.trigger('cmb_pre_init');
+
+ var $metabox = cmb.metabox();
+ var $repeatGroup = $metabox.find('.cmb-repeatable-group');
+
+ /**
+ * Initialize time/date/color pickers
+ */
+ cmb.initPickers($metabox.find('input[type="text"].cmb2-timepicker'), $metabox.find('input[type="text"].cmb2-datepicker'), $metabox.find('input[type="text"].cmb2-colorpicker'));
+
+ // Insert toggle button into DOM wherever there is multicheck. credit: Genesis Framework
+ $('').insertBefore('.cmb2-checkbox-list:not(.no-select-all)'); + + // Make File List drag/drop sortable: + cmb.makeListSortable(); + + $metabox + .on('change', '.cmb2_upload_file', function () { + cmb.media.field = $(this).attr('id'); + $id(cmb.media.field + '_id').val(''); + }) + // Media/file management + .on('click', '.cmb-multicheck-toggle', cmb.toggleCheckBoxes) + .on('click', '.cmb2-upload-button', cmb.handleMedia) + .on('click', '.cmb-attach-list li, .cmb2-media-status .img-status img, .cmb2-media-status .file-status > span', cmb.handleFileClick) + .on('click', '.cmb2-remove-file-button', cmb.handleRemoveMedia) + // Repeatable content + .on('click', '.cmb-add-group-row', cmb.addGroupRow) + .on('click', '.cmb-add-row-button', cmb.addAjaxRow) + .on('click', '.cmb-remove-group-row', cmb.removeGroupRow) + .on('click', '.cmb-remove-row-button', cmb.removeAjaxRow) + // Ajax oEmbed display + .on('keyup paste focusout', '.cmb2-oembed', cmb.maybeOembed) + // Reset titles when removing a row + .on('cmb2_remove_row', '.cmb-repeatable-group', cmb.resetTitlesAndIterator) + .on('click', '.cmbhandle, .cmbhandle + .cmbhandle-title', cmb.toggleHandle); + + if ($repeatGroup.length) { + $repeatGroup + .filter('.sortable').each(function () { + // Add sorting arrows + $(this).find('.button.cmb-remove-group-row').before(' '); + }) + .on('click', '.cmb-shift-rows', cmb.shiftRows) + .on('cmb2_add_row', cmb.emptyValue); + } + + // on pageload + setTimeout(cmb.resizeoEmbeds, 500); + // and on window resize + $(window).on('resize', cmb.resizeoEmbeds); + + cmb.trigger('cmb_init'); + }; + + cmb.resetTitlesAndIterator = function (evt) { + if (!evt.group) { + return; + } + + // Loop repeatable group tables + $('.cmb-repeatable-group').each(function () { + var $table = $(this); + // Loop repeatable group table rows + $table.find('.cmb-repeatable-grouping').each(function (rowindex) { + var $row = $(this); + // Reset rows iterator + $row.data('iterator', rowindex); + // Reset rows title + $row.find('.cmb-group-title h4').text($table.find('.cmb-add-group-row').data('grouptitle').replace('{#}', ( rowindex + 1 ))); + }); + }); + }; + + cmb.toggleHandle = function (evt) { + evt.preventDefault(); + cmb.trigger('postbox-toggled', $(this).parent('.postbox').toggleClass('closed')); + }; + + cmb.toggleCheckBoxes = function (evt) { + evt.preventDefault(); + var $this = $(this); + var $multicheck = $this.closest('.cmb-td').find('input[type=checkbox]:not([disabled])'); + + // If the button has already been clicked once... + if ($this.data('checked')) { + // clear the checkboxes and remove the flag + $multicheck.prop('checked', false); + $this.data('checked', false); + } + // Otherwise mark the checkboxes and add a flag + else { + $multicheck.prop('checked', true); + $this.data('checked', true); + } + }; + + cmb.handleMedia = function (evt) { + evt.preventDefault(); + + var $el = $(this); + cmb.attach_id = !$el.hasClass('cmb2-upload-list') ? $el.closest('.cmb-td').find('.cmb2-upload-file-id').val() : false; + // Clean up default 0 value + cmb.attach_id = '0' !== cmb.attach_id ? cmb.attach_id : false; + + cmb._handleMedia($el.prev('input.cmb2-upload-file').attr('id'), $el.hasClass('cmb2-upload-list')); + }; + + cmb.handleFileClick = function (evt) { + evt.preventDefault(); + + var $el = $(this); + var $td = $el.closest('.cmb-td'); + var isList = $td.find('.cmb2-upload-button').hasClass('cmb2-upload-list'); + cmb.attach_id = isList ? $el.find('input[type="hidden"]').data('id') : $td.find('.cmb2-upload-file-id').val(); + + if (cmb.attach_id) { + cmb._handleMedia($td.find('input.cmb2-upload-file').attr('id'), isList, cmb.attach_id); + } + }; + + cmb._handleMedia = function (formfield, isList) { + if (!wp) { + return; + } + + var media = cmb.media; + media.field = formfield; + media.$field = $id(media.field); + media.fieldData = media.$field.data(); + media.previewSize = media.fieldData.previewsize; + media.fieldName = media.$field.attr('name'); + media.isList = isList; + + var uploadStatus, attachment; + + // If this field's media frame already exists, reopen it. + if (media.field in media.frames) { + media.frames[media.field].open(); + return; + } + + // Create the media frame. + media.frames[media.field] = wp.media({ + title: cmb.metabox().find('label[for="' + media.field + '"]').text(), + library: media.fieldData.queryargs || {}, + button: { + text: l10n.strings[isList ? 'upload_files' : 'upload_file'] + }, + multiple: isList ? 'add' : false + }); + + cmb.trigger('cmb_media_modal_init', media); + + cmb.mediaHandlers.list = function (selection, returnIt) { + // Get all of our selected files + attachment = selection.toJSON(); + + media.$field.val(attachment.url); + $id(media.field + '_id').val(attachment.id); + + // Setup our fileGroup array + var fileGroup = []; + + // Loop through each attachment + $(attachment).each(function () { + if (this.type && this.type === 'image') { + var width = media.previewSize[0] ? media.previewSize[0] : 50; + var height = media.previewSize[1] ? media.previewSize[1] : 50; + + // image preview + uploadStatus = '
' + l10n.strings.file + ' ' + attachment.filename + ' (' + l10n.strings.download + ' / ' + l10n.strings.remove_file + ')
';
+ }
+
+ // add/display our output
+ media.$field.siblings('.cmb2-media-status').slideDown().html(uploadStatus);
+ };
+
+ cmb.mediaHandlers.selectFile = function () {
+ var selection = media.frames[media.field].state().get('selection');
+ var type = isList ? 'list' : 'single';
+
+ if (cmb.attach_id && isList) {
+ $('[data-id="' + cmb.attach_id + '"]').parents('li').replaceWith(cmb.mediaHandlers.list(selection, true));
+ } else {
+ cmb.mediaHandlers[type](selection);
+ }
+
+ cmb.trigger('cmb_media_modal_select', selection, media);
+ };
+
+ cmb.mediaHandlers.openModal = function () {
+ var selection = media.frames[media.field].state().get('selection');
+ var attach;
+
+ if (!cmb.attach_id) {
+ selection.reset();
+ } else {
+ attach = wp.media.attachment(cmb.attach_id);
+ attach.fetch();
+ selection.set(attach ? [attach] : []);
+ }
+
+ cmb.trigger('cmb_media_modal_open', selection, media);
+ };
+
+ // When a file is selected, run a callback.
+ media.frames[media.field]
+ .on('select', cmb.mediaHandlers.selectFile)
+ .on('open', cmb.mediaHandlers.openModal);
+
+ // Finally, open the modal
+ media.frames[media.field].open();
+ };
+
+ cmb.handleRemoveMedia = function (evt) {
+ evt.preventDefault();
+ var $this = $(this);
+ if ($this.is('.cmb-attach-list .cmb2-remove-file-button')) {
+ $this.parents('li').remove();
+ return false;
+ }
+
+ cmb.media.field = $this.attr('rel');
+
+ cmb.metabox().find('input#' + cmb.media.field).val('');
+ cmb.metabox().find('input#' + cmb.media.field + '_id').val('');
+ $this.parents('.cmb2-media-status').html('');
+
+ return false;
+ };
+
+ cmb.cleanRow = function ($row, prevNum, group) {
+ var $elements = $row.find(cmb.repeatUpdate);
+ if (group) {
+
+ var $other = $row.find('[id]').not(cmb.repeatUpdate);
+
+ // Remove extra ajaxed rows
+ $row.find('.cmb-repeat-table .cmb-repeat-row:not(:first-child)').remove();
+
+ // Update all elements w/ an ID
+ if ($other.length) {
+ $other.each(function () {
+ var $_this = $(this);
+ var oldID = $_this.attr('id');
+ var newID = oldID.replace('_' + prevNum, '_' + cmb.idNumber);
+ var $buttons = $row.find('[data-selector="' + oldID + '"]');
+ $_this.attr('id', newID);
+
+ // Replace data-selector vars
+ if ($buttons.length) {
+ $buttons.attr('data-selector', newID).data('selector', newID);
+ }
+ });
+ }
+ }
+
+ $elements.filter(':checked').prop('checked', false);
+ $elements.filter(':selected').prop('selected', false);
+
+ if ($row.find('h3.cmb-group-title').length) {
+ $row.find('h3.cmb-group-title').text($row.data('title').replace('{#}', ( cmb.idNumber + 1 )));
+ }
+
+ $elements.each(function () {
+ cmb.elReplacements($(this), prevNum);
+ });
+
+ return cmb;
+ };
+
+ cmb.elReplacements = function ($newInput, prevNum) {
+ var oldFor = $newInput.attr('for');
+ var oldVal = $newInput.val();
+ var type = $newInput.prop('type');
+ var checkable = 'radio' === type || 'checkbox' === type ? oldVal : false;
+ // var $next = $newInput.next();
+ var attrs = {};
+ var newID, oldID;
+ if (oldFor) {
+ attrs = {'for': oldFor.replace('_' + prevNum, '_' + cmb.idNumber)};
+ } else {
+ var oldName = $newInput.attr('name');
+ // Replace 'name' attribute key
+ var newName = oldName ? oldName.replace('[' + prevNum + ']', '[' + cmb.idNumber + ']') : '';
+ oldID = $newInput.attr('id');
+ newID = oldID ? oldID.replace('_' + prevNum, '_' + cmb.idNumber) : '';
+ attrs = {
+ id: newID,
+ name: newName,
+ // value: '',
+ 'data-iterator': cmb.idNumber,
+ };
+
+ }
+
+ // Clear out old values
+ if (undefined !== typeof( oldVal ) && oldVal || checkable) {
+ attrs.value = checkable ? checkable : '';
+ }
+
+ // Clear out textarea values
+ if ('TEXTAREA' === $newInput.prop('tagName')) {
+ $newInput.html('');
+ }
+
+ if (checkable) {
+ $newInput.removeAttr('checked');
+ }
+
+ $newInput
+ .removeClass('hasDatepicker')
+ .attr(attrs).val(checkable ? checkable : '');
+
+ return $newInput;
+ };
+
+ cmb.newRowHousekeeping = function ($row) {
+
+ var $colorPicker = $row.find('.wp-picker-container');
+ var $list = $row.find('.cmb2-media-status');
- if ( $colorPicker.length ) {
- // Need to clean-up colorpicker before appending
- $colorPicker.each( function() {
- var $td = $( this ).parent();
- $td.html( $td.find( 'input[type="text"].cmb2-colorpicker' ).attr('style', '') );
- });
- }
+ if ($colorPicker.length) {
+ // Need to clean-up colorpicker before appending
+ $colorPicker.each(function () {
+ var $td = $(this).parent();
+ $td.html($td.find('input[type="text"].cmb2-colorpicker').attr('style', ''));
+ });
+ }
- // Need to clean-up colorpicker before appending
- if ( $list.length ) {
- $list.empty();
- }
+ // Need to clean-up colorpicker before appending
+ if ($list.length) {
+ $list.empty();
+ }
- return cmb;
- };
-
- cmb.afterRowInsert = function( $row ) {
- // Init pickers from new row
- cmb.initPickers( $row.find('input[type="text"].cmb2-timepicker'), $row.find('input[type="text"].cmb2-datepicker'), $row.find('input[type="text"].cmb2-colorpicker') );
- };
-
- cmb.updateNameAttr = function () {
+ return cmb;
+ };
+
+ cmb.afterRowInsert = function ($row) {
+ // Init pickers from new row
+ cmb.initPickers($row.find('input[type="text"].cmb2-timepicker'), $row.find('input[type="text"].cmb2-datepicker'), $row.find('input[type="text"].cmb2-colorpicker'));
+ };
+
+ cmb.updateNameAttr = function () {
- var $this = $( this );
- var name = $this.attr( 'name' ); // get current name
+ var $this = $(this);
+ var name = $this.attr('name'); // get current name
- // If name is defined
- if ( typeof name !== 'undefined' ) {
- var prevNum = parseInt( $this.parents( '.cmb-repeatable-grouping' ).data( 'iterator' ), 10 );
- var newNum = prevNum - 1; // Subtract 1 to get new iterator number
+ // If name is defined
+ if (typeof name !== 'undefined') {
+ var prevNum = parseInt($this.parents('.cmb-repeatable-grouping').data('iterator'), 10);
+ var newNum = prevNum - 1; // Subtract 1 to get new iterator number
- // Update field name attributes so data is not orphaned when a row is removed and post is saved
- var $newName = name.replace( '[' + prevNum + ']', '[' + newNum + ']' );
+ // Update field name attributes so data is not orphaned when a row is removed and post is saved
+ var $newName = name.replace('[' + prevNum + ']', '[' + newNum + ']');
- // New name with replaced iterator
- $this.attr( 'name', $newName );
- }
+ // New name with replaced iterator
+ $this.attr('name', $newName);
+ }
- };
+ };
- cmb.emptyValue = function( evt, row ) {
- $( cmb.noEmpty, row ).val( '' );
- };
+ cmb.emptyValue = function (evt, row) {
+ $(cmb.noEmpty, row).val('');
+ };
- cmb.addGroupRow = function( evt ) {
- evt.preventDefault();
+ cmb.addGroupRow = function (evt) {
+ evt.preventDefault();
- var $this = $( this );
+ var $this = $(this);
- // before anything significant happens
- cmb.triggerElement( $this, 'cmb2_add_group_row_start', $this );
+ // before anything significant happens
+ cmb.triggerElement($this, 'cmb2_add_group_row_start', $this);
- var $table = $id( $this.data('selector') );
- var $oldRow = $table.find('.cmb-repeatable-grouping').last();
- var prevNum = parseInt( $oldRow.data('iterator'), 10 );
- cmb.idNumber = parseInt( prevNum, 10 ) + 1;
- var $row = $oldRow.clone();
+ var $table = $id($this.data('selector'));
+ var $oldRow = $table.find('.cmb-repeatable-grouping').last();
+ var prevNum = parseInt($oldRow.data('iterator'), 10);
+ cmb.idNumber = parseInt(prevNum, 10) + 1;
+ var $row = $oldRow.clone();
- // Make sure the next number doesn't exist.
- while ( $table.find( '.cmb-repeatable-grouping[data-iterator="'+ cmb.idNumber +'"]' ).length > 0 ) {
- cmb.idNumber++;
- }
+ // Make sure the next number doesn't exist.
+ while ($table.find('.cmb-repeatable-grouping[data-iterator="' + cmb.idNumber + '"]').length > 0) {
+ cmb.idNumber++;
+ }
- cmb.newRowHousekeeping( $row.data( 'title', $this.data( 'grouptitle' ) ) ).cleanRow( $row, prevNum, true );
- $row.find( '.cmb-add-row-button' ).prop( 'disabled', false );
+ cmb.newRowHousekeeping($row.data('title', $this.data('grouptitle'))).cleanRow($row, prevNum, true);
+ $row.find('.cmb-add-row-button').prop('disabled', false);
- var $newRow = $( ''+ $row.html() +'
' );
- $oldRow.after( $newRow );
+ var $newRow = $('' + $row.html() + '
');
+ $oldRow.after($newRow);
- cmb.afterRowInsert( $newRow );
+ cmb.afterRowInsert($newRow);
- if ( $table.find('.cmb-repeatable-grouping').length <= 1 ) {
- $table.find('.cmb-remove-group-row').prop( 'disabled', true );
- } else {
- $table.find('.cmb-remove-group-row').prop( 'disabled', false );
- }
+ if ($table.find('.cmb-repeatable-grouping').length <= 1) {
+ $table.find('.cmb-remove-group-row').prop('disabled', true);
+ } else {
+ $table.find('.cmb-remove-group-row').prop('disabled', false);
+ }
- cmb.triggerElement( $table, { type: 'cmb2_add_row', group: true }, $newRow );
+ cmb.triggerElement($table, {type: 'cmb2_add_row', group: true}, $newRow);
- };
+ };
- cmb.addAjaxRow = function( evt ) {
- evt.preventDefault();
+ cmb.addAjaxRow = function (evt) {
+ evt.preventDefault();
- var $this = $( this );
- var $table = $id( $this.data('selector') );
- var $emptyrow = $table.find('.empty-row');
- var prevNum = parseInt( $emptyrow.find('[data-iterator]').data('iterator'), 10 );
- cmb.idNumber = parseInt( prevNum, 10 ) + 1;
- var $row = $emptyrow.clone();
+ var $this = $(this);
+ var $table = $id($this.data('selector'));
+ var $emptyrow = $table.find('.empty-row');
+ var prevNum = parseInt($emptyrow.find('[data-iterator]').data('iterator'), 10);
+ cmb.idNumber = parseInt(prevNum, 10) + 1;
+ var $row = $emptyrow.clone();
- cmb.newRowHousekeeping( $row ).cleanRow( $row, prevNum );
+ cmb.newRowHousekeeping($row).cleanRow($row, prevNum);
- $emptyrow.removeClass('empty-row hidden').addClass('cmb-repeat-row');
- $emptyrow.after( $row );
+ $emptyrow.removeClass('empty-row hidden').addClass('cmb-repeat-row');
+ $emptyrow.after($row);
- cmb.afterRowInsert( $row );
+ cmb.afterRowInsert($row);
- cmb.triggerElement( $table, { type: 'cmb2_add_row', group: false }, $row );
+ cmb.triggerElement($table, {type: 'cmb2_add_row', group: false}, $row);
- $table.find( '.cmb-remove-row-button' ).removeClass( 'button-disabled' );
+ $table.find('.cmb-remove-row-button').removeClass('button-disabled');
- };
+ };
- cmb.removeGroupRow = function( evt ) {
- evt.preventDefault();
+ cmb.removeGroupRow = function (evt) {
+ evt.preventDefault();
- var $this = $( this );
- var $table = $id( $this.data('selector') );
- var $parent = $this.parents('.cmb-repeatable-grouping');
- var number = $table.find('.cmb-repeatable-grouping').length;
+ var $this = $(this);
+ var $table = $id($this.data('selector'));
+ var $parent = $this.parents('.cmb-repeatable-grouping');
+ var number = $table.find('.cmb-repeatable-grouping').length;
- // Needs to always be at least one group.
- if ( number < 2 ) {
- return;
- }
+ // Needs to always be at least one group.
+ if (number < 2) {
+ return;
+ }
- cmb.triggerElement( $table, 'cmb2_remove_group_row_start', $this );
+ cmb.triggerElement($table, 'cmb2_remove_group_row_start', $this);
- // when a group is removed loop through all next groups and update fields names
- $parent.nextAll( '.cmb-repeatable-grouping' ).find( cmb.repeatEls ).each( cmb.updateNameAttr );
+ // when a group is removed loop through all next groups and update fields names
+ $parent.nextAll('.cmb-repeatable-grouping').find(cmb.repeatEls).each(cmb.updateNameAttr);
- $parent.remove();
+ $parent.remove();
- if ( number <= 2 ) {
- $table.find('.cmb-remove-group-row').prop( 'disabled', true );
- } else {
- $table.find('.cmb-remove-group-row').prop( 'disabled', false );
- }
+ if (number <= 2) {
+ $table.find('.cmb-remove-group-row').prop('disabled', true);
+ } else {
+ $table.find('.cmb-remove-group-row').prop('disabled', false);
+ }
- cmb.triggerElement( $table, { type: 'cmb2_remove_row', group: true } );
+ cmb.triggerElement($table, {type: 'cmb2_remove_row', group: true});
- };
+ };
- cmb.removeAjaxRow = function( evt ) {
- evt.preventDefault();
+ cmb.removeAjaxRow = function (evt) {
+ evt.preventDefault();
- var $this = $( this );
-
- // Check if disabled
- if ( $this.hasClass( 'button-disabled' ) ) {
- return;
- }
-
- var $parent = $this.parents('.cmb-row');
- var $table = $this.parents('.cmb-repeat-table');
- var number = $table.find('.cmb-row').length;
-
- if ( number > 2 ) {
- if ( $parent.hasClass('empty-row') ) {
- $parent.prev().addClass( 'empty-row' ).removeClass('cmb-repeat-row');
- }
- $this.parents('.cmb-repeat-table .cmb-row').remove();
- if ( number === 3 ) {
- $table.find( '.cmb-remove-row-button' ).addClass( 'button-disabled' );
- }
-
- cmb.triggerElement( $table, { type: 'cmb2_remove_row', group: false } );
-
- } else {
- $this.addClass( 'button-disabled' );
- }
- };
-
- cmb.shiftRows = function( evt ) {
-
- evt.preventDefault();
-
- var $this = $( this );
- var $from = $this.parents( '.cmb-repeatable-grouping' );
- var $goto = $this.hasClass( 'move-up' ) ? $from.prev( '.cmb-repeatable-grouping' ) : $from.next( '.cmb-repeatable-grouping' );
-
- // Before shift occurs.
- cmb.triggerElement( $this, 'cmb2_shift_rows_enter', $this, $from, $goto );
-
- if ( ! $goto.length ) {
- return;
- }
-
- // About to shift
- cmb.triggerElement( $this, 'cmb2_shift_rows_start', $this, $from, $goto );
-
- var inputVals = [];
- // Loop this item's fields
- $from.find( cmb.repeatEls ).each( function() {
- var $element = $( this );
- var elType = $element.attr( 'type' );
- var val;
-
- if ( $element.hasClass('cmb2-media-status') ) {
- // special case for image previews
- val = $element.html();
- } else if ( 'checkbox' === elType || 'radio' === elType ) {
- val = $element.is(':checked');
- } else if ( 'select' === $element.prop('tagName') ) {
- val = $element.is(':selected');
- } else {
- val = $element.val();
- }
-
- // Get all the current values per element
- inputVals.push( { val: val, $: $element } );
- });
- // And swap them all
- $goto.find( cmb.repeatEls ).each( function( index ) {
- var $element = $( this );
- var elType = $element.attr( 'type' );
- var val;
-
- if ( $element.hasClass('cmb2-media-status') ) {
- var toRowId = $element.closest('.cmb-repeatable-grouping').attr('data-iterator');
- var fromRowId = inputVals[ index ].$.closest('.cmb-repeatable-grouping').attr('data-iterator');
-
- // special case for image previews
- val = $element.html();
- $element.html( inputVals[ index ].val );
- inputVals[ index ].$.html( val );
-
- inputVals[ index ].$.find( 'input' ).each(function() {
- var name = $( this ).attr( 'name' );
- name = name.replace( '['+toRowId+']', '['+fromRowId+']' );
- $( this ).attr( 'name', name );
- });
- $element.find('input').each(function() {
- var name = $( this ).attr('name');
- name = name.replace('['+fromRowId+']', '['+toRowId+']');
- $( this ).attr('name', name);
- });
-
- }
- // handle checkbox swapping
- else if ( 'checkbox' === elType ) {
- inputVals[ index ].$.prop( 'checked', $element.is(':checked') );
- $element.prop( 'checked', inputVals[ index ].val );
- }
- // handle radio swapping
- else if ( 'radio' === elType ) {
- if ( $element.is( ':checked' ) ) {
- inputVals[ index ].$.attr( 'data-checked', 'true' );
- }
- if ( inputVals[ index ].$.is( ':checked' ) ) {
- $element.attr( 'data-checked', 'true' );
- }
- }
- // handle select swapping
- else if ( 'select' === $element.prop('tagName') ) {
- inputVals[ index ].$.prop( 'selected', $element.is(':selected') );
- $element.prop( 'selected', inputVals[ index ].val );
- }
- // handle normal input swapping
- else {
- inputVals[ index ].$.val( $element.val() );
- $element.val( inputVals[ index ].val );
- }
- });
-
- $from.find( 'input[data-checked=true]' ).prop( 'checked', true ).removeAttr( 'data-checked' );
- $goto.find( 'input[data-checked=true]' ).prop( 'checked', true ).removeAttr( 'data-checked' );
-
- // trigger color picker change event
- $from.find( 'input[type="text"].cmb2-colorpicker' ).trigger( 'change' );
- $goto.find( 'input[type="text"].cmb2-colorpicker' ).trigger( 'change' );
-
- // shift done
- cmb.triggerElement( $this, 'cmb2_shift_rows_complete', $this, $from, $goto );
- };
-
- cmb.initPickers = function( $timePickers, $datePickers, $colorPickers ) {
- // Initialize jQuery UI timepickers
- cmb.initDateTimePickers( $timePickers, 'timepicker', 'time_picker' );
- // Initialize jQuery UI datepickers
- cmb.initDateTimePickers( $datePickers, 'datepicker', 'date_picker' );
- // Initialize color picker
- cmb.initColorPickers( $colorPickers );
- };
-
- cmb.initDateTimePickers = function( $selector, method, defaultKey ) {
- if ( $selector.length ) {
- $selector[ method ]( 'destroy' ).each( function() {
- var $this = $( this );
- var fieldOpts = $this.data( method ) || {};
- var options = $.extend( {}, cmb.defaults[ defaultKey ], fieldOpts );
- $this[ method ]( cmb.datePickerSetupOpts( fieldOpts, options, method ) );
- } );
- }
- };
-
- cmb.datePickerSetupOpts = function( fieldOpts, options, method ) {
- var existing = $.extend( {}, options );
-
- options.beforeShow = function( input, inst ) {
- if ( 'timepicker' === method ) {
- cmb.addTimePickerClasses( inst.dpDiv );
- }
-
- // Wrap datepicker w/ class to narrow the scope of jQuery UI CSS and prevent conflicts
- $id( 'ui-datepicker-div' ).addClass( 'cmb2-element' );
-
- // Let's be sure to call beforeShow if it was added
- if ( 'function' === typeof existing.beforeShow ) {
- existing.beforeShow( input, inst );
- }
- };
-
- if ( 'timepicker' === method ) {
- options.onChangeMonthYear = function( year, month, inst, picker ) {
- cmb.addTimePickerClasses( inst.dpDiv );
-
- // Let's be sure to call onChangeMonthYear if it was added
- if ( 'function' === typeof existing.onChangeMonthYear ) {
- existing.onChangeMonthYear( year, month, inst, picker );
- }
- };
- }
-
- options.onClose = function( dateText, inst ) {
- // Remove the class when we're done with it (and hide to remove FOUC).
- $id( 'ui-datepicker-div' ).removeClass( 'cmb2-element' ).hide();
-
- // Let's be sure to call onClose if it was added
- if ( 'function' === typeof existing.onClose ) {
- existing.onClose( dateText, inst );
- }
- };
-
- return options;
- };
-
- // Adds classes to timepicker buttons.
- cmb.addTimePickerClasses = function( $picker ) {
- var func = cmb.addTimePickerClasses;
- func.count = func.count || 0;
-
- // Wait a bit to let the timepicker render, since these are pre-render events.
- setTimeout( function() {
- if ( $picker.find( '.ui-priority-secondary' ).length ) {
- $picker.find( '.ui-priority-secondary' ).addClass( 'button-secondary' );
- $picker.find( '.ui-priority-primary' ).addClass( 'button-primary' );
- func.count = 0;
- } else if ( func.count < 5 ) {
- func.count++;
- func( $picker );
- }
- }, 10 );
- };
-
- cmb.initColorPickers = function( $selector ) {
- if ( ! $selector.length ) {
- return;
- }
- if ( typeof jQuery.wp === 'object' && typeof jQuery.wp.wpColorPicker === 'function' ) {
-
- $selector.each( function() {
- var $this = $( this );
- var fieldOpts = $this.data( 'colorpicker' ) || {};
- $this.wpColorPicker( $.extend( {}, cmb.defaults.color_picker, fieldOpts ) );
- } );
-
- } else {
- $selector.each( function( i ) {
- $( this ).after( '' );
- $id( 'picker-' + i ).hide().farbtastic( $( this ) );
- } )
- .focus( function() {
- $( this ).next().show();
- } )
- .blur( function() {
- $( this ).next().hide();
- } );
- }
- };
-
- cmb.makeListSortable = function() {
- var $filelist = cmb.metabox().find( '.cmb2-media-status.cmb-attach-list' );
- if ( $filelist.length ) {
- $filelist.sortable({ cursor: 'move' }).disableSelection();
- }
- };
-
- cmb.maybeOembed = function( evt ) {
- var $this = $( this );
-
- var m = {
- focusout : function() {
- setTimeout( function() {
- // if it's been 2 seconds, hide our spinner
- cmb.spinner( '.postbox .cmb2-metabox', true );
- }, 2000);
- },
- keyup : function() {
- var betw = function( min, max ) {
- return ( evt.which <= max && evt.which >= min );
- };
- // Only Ajax on normal keystrokes
- if ( betw( 48, 90 ) || betw( 96, 111 ) || betw( 8, 9 ) || evt.which === 187 || evt.which === 190 ) {
- // fire our ajax function
- cmb.doAjax( $this, evt );
- }
- },
- paste : function() {
- // paste event is fired before the value is filled, so wait a bit
- setTimeout( function() { cmb.doAjax( $this ); }, 100);
- }
- };
-
- m[ evt.type ]();
- };
-
- /**
- * Resize oEmbed videos to fit in their respective metaboxes
- */
- cmb.resizeoEmbeds = function() {
- cmb.metabox().each( function() {
- var $this = $( this );
- var $tableWrap = $this.parents('.inside');
- var isSide = $this.parents('.inner-sidebar').length || $this.parents( '#side-sortables' ).length;
- var isSmall = isSide;
- var isSmallest = false;
- if ( ! $tableWrap.length ) {
- return true; // continue
- }
-
- // Calculate new width
- var tableW = $tableWrap.width();
-
- if ( cmb.styleBreakPoint > tableW ) {
- isSmall = true;
- isSmallest = ( cmb.styleBreakPoint - 62 ) > tableW;
- }
-
- tableW = isSmall ? tableW : Math.round(($tableWrap.width() * 0.82)*0.97);
- var newWidth = tableW - 30;
- if ( isSmall && ! isSide && ! isSmallest ) {
- newWidth = newWidth - 75;
- }
- if ( newWidth > 639 ) {
- return true; // continue
- }
-
- var $embeds = $this.find('.cmb-type-oembed .embed-status');
- var $children = $embeds.children().not('.cmb2-remove-wrapper');
- if ( ! $children.length ) {
- return true; // continue
- }
-
- $children.each( function() {
- var $this = $( this );
- var iwidth = $this.width();
- var iheight = $this.height();
- var _newWidth = newWidth;
- if ( $this.parents( '.cmb-repeat-row' ).length && ! isSmall ) {
- // Make room for our repeatable "remove" button column
- _newWidth = newWidth - 91;
- _newWidth = 785 > tableW ? _newWidth - 15 : _newWidth;
- }
- // Calc new height
- var newHeight = Math.round((_newWidth * iheight)/iwidth);
- $this.width(_newWidth).height(newHeight);
- });
-
- });
- };
-
- /**
- * Safely log things if query var is set
- * @since 1.0.0
- */
- cmb.log = function() {
- if ( l10n.script_debug && console && typeof console.log === 'function' ) {
- console.log.apply(console, arguments);
- }
- };
-
- cmb.spinner = function( $context, hide ) {
- if ( hide ) {
- $('.cmb-spinner', $context ).hide();
- }
- else {
- $('.cmb-spinner', $context ).show();
- }
- };
-
- // function for running our ajax
- cmb.doAjax = function( $obj ) {
- // get typed value
- var oembed_url = $obj.val();
- // only proceed if the field contains more than 6 characters
- if ( oembed_url.length < 6 ) {
- return;
- }
-
- // get field id
- var field_id = $obj.attr('id');
- var $context = $obj.closest( '.cmb-td' );
- var $embed_container = $context.find( '.embed-status' );
- var $embed_wrap = $context.find( '.embed_wrap' );
- var $child_el = $embed_container.find( ':first-child' );
- var oembed_width = $embed_container.length && $child_el.length ? $child_el.width() : $obj.width();
-
- cmb.log( 'oembed_url', oembed_url, field_id );
-
- // show our spinner
- cmb.spinner( $context );
- // clear out previous results
- $embed_wrap.html('');
- // and run our ajax function
- setTimeout( function() {
- // if they haven't typed in 500 ms
- if ( $( '.cmb2-oembed:focus' ).val() !== oembed_url ) {
- return;
- }
- $.ajax({
- type : 'post',
- dataType : 'json',
- url : l10n.ajaxurl,
- data : {
- 'action' : 'cmb2_oembed_handler',
- 'oembed_url' : oembed_url,
- 'oembed_width' : oembed_width > 300 ? oembed_width : 300,
- 'field_id' : field_id,
- 'object_id' : $obj.data( 'objectid' ),
- 'object_type' : $obj.data( 'objecttype' ),
- 'cmb2_ajax_nonce' : l10n.ajax_nonce
- },
- success: function(response) {
- cmb.log( response );
- // hide our spinner
- cmb.spinner( $context, true );
- // and populate our results from ajax response
- $embed_wrap.html( response.data );
- }
- });
-
- }, 500);
-
- };
-
- cmb.trigger = function( evtName ) {
- var args = Array.prototype.slice.call( arguments, 1 );
- args.push( cmb );
- $document.trigger( evtName, args );
- };
-
- cmb.triggerElement = function( $el, evtName ) {
- var args = Array.prototype.slice.call( arguments, 2 );
- args.push( cmb );
- $el.trigger( evtName, args );
- };
-
- $( cmb.init );
+ var $this = $(this);
+
+ // Check if disabled
+ if ($this.hasClass('button-disabled')) {
+ return;
+ }
+
+ var $parent = $this.parents('.cmb-row');
+ var $table = $this.parents('.cmb-repeat-table');
+ var number = $table.find('.cmb-row').length;
+
+ if (number > 2) {
+ if ($parent.hasClass('empty-row')) {
+ $parent.prev().addClass('empty-row').removeClass('cmb-repeat-row');
+ }
+ $this.parents('.cmb-repeat-table .cmb-row').remove();
+ if (number === 3) {
+ $table.find('.cmb-remove-row-button').addClass('button-disabled');
+ }
+
+ cmb.triggerElement($table, {type: 'cmb2_remove_row', group: false});
+
+ } else {
+ $this.addClass('button-disabled');
+ }
+ };
+
+ cmb.shiftRows = function (evt) {
+
+ evt.preventDefault();
+
+ var $this = $(this);
+ var $from = $this.parents('.cmb-repeatable-grouping');
+ var $goto = $this.hasClass('move-up') ? $from.prev('.cmb-repeatable-grouping') : $from.next('.cmb-repeatable-grouping');
+
+ // Before shift occurs.
+ cmb.triggerElement($this, 'cmb2_shift_rows_enter', $this, $from, $goto);
+
+ if (!$goto.length) {
+ return;
+ }
+
+ // About to shift
+ cmb.triggerElement($this, 'cmb2_shift_rows_start', $this, $from, $goto);
+
+ var inputVals = [];
+ // Loop this item's fields
+ $from.find(cmb.repeatEls).each(function () {
+ var $element = $(this);
+ var elType = $element.attr('type');
+ var val;
+
+ if ($element.hasClass('cmb2-media-status')) {
+ // special case for image previews
+ val = $element.html();
+ } else if ('checkbox' === elType || 'radio' === elType) {
+ val = $element.is(':checked');
+ } else if ('select' === $element.prop('tagName')) {
+ val = $element.is(':selected');
+ } else {
+ val = $element.val();
+ }
+
+ // Get all the current values per element
+ inputVals.push({val: val, $: $element});
+ });
+ // And swap them all
+ $goto.find(cmb.repeatEls).each(function (index) {
+ var $element = $(this);
+ var elType = $element.attr('type');
+ var val;
+
+ if ($element.hasClass('cmb2-media-status')) {
+ var toRowId = $element.closest('.cmb-repeatable-grouping').attr('data-iterator');
+ var fromRowId = inputVals[index].$.closest('.cmb-repeatable-grouping').attr('data-iterator');
+
+ // special case for image previews
+ val = $element.html();
+ $element.html(inputVals[index].val);
+ inputVals[index].$.html(val);
+
+ inputVals[index].$.find('input').each(function () {
+ var name = $(this).attr('name');
+ name = name.replace('[' + toRowId + ']', '[' + fromRowId + ']');
+ $(this).attr('name', name);
+ });
+ $element.find('input').each(function () {
+ var name = $(this).attr('name');
+ name = name.replace('[' + fromRowId + ']', '[' + toRowId + ']');
+ $(this).attr('name', name);
+ });
+
+ }
+ // handle checkbox swapping
+ else if ('checkbox' === elType) {
+ inputVals[index].$.prop('checked', $element.is(':checked'));
+ $element.prop('checked', inputVals[index].val);
+ }
+ // handle radio swapping
+ else if ('radio' === elType) {
+ if ($element.is(':checked')) {
+ inputVals[index].$.attr('data-checked', 'true');
+ }
+ if (inputVals[index].$.is(':checked')) {
+ $element.attr('data-checked', 'true');
+ }
+ }
+ // handle select swapping
+ else if ('select' === $element.prop('tagName')) {
+ inputVals[index].$.prop('selected', $element.is(':selected'));
+ $element.prop('selected', inputVals[index].val);
+ }
+ // handle normal input swapping
+ else {
+ inputVals[index].$.val($element.val());
+ $element.val(inputVals[index].val);
+ }
+ });
+
+ $from.find('input[data-checked=true]').prop('checked', true).removeAttr('data-checked');
+ $goto.find('input[data-checked=true]').prop('checked', true).removeAttr('data-checked');
+
+ // trigger color picker change event
+ $from.find('input[type="text"].cmb2-colorpicker').trigger('change');
+ $goto.find('input[type="text"].cmb2-colorpicker').trigger('change');
+
+ // shift done
+ cmb.triggerElement($this, 'cmb2_shift_rows_complete', $this, $from, $goto);
+ };
+
+ cmb.initPickers = function ($timePickers, $datePickers, $colorPickers) {
+ // Initialize jQuery UI timepickers
+ cmb.initDateTimePickers($timePickers, 'timepicker', 'time_picker');
+ // Initialize jQuery UI datepickers
+ cmb.initDateTimePickers($datePickers, 'datepicker', 'date_picker');
+ // Initialize color picker
+ cmb.initColorPickers($colorPickers);
+ };
+
+ cmb.initDateTimePickers = function ($selector, method, defaultKey) {
+ if ($selector.length) {
+ $selector[method]('destroy').each(function () {
+ var $this = $(this);
+ var fieldOpts = $this.data(method) || {};
+ var options = $.extend({}, cmb.defaults[defaultKey], fieldOpts);
+ $this[method](cmb.datePickerSetupOpts(fieldOpts, options, method));
+ });
+ }
+ };
+
+ cmb.datePickerSetupOpts = function (fieldOpts, options, method) {
+ var existing = $.extend({}, options);
+
+ options.beforeShow = function (input, inst) {
+ if ('timepicker' === method) {
+ cmb.addTimePickerClasses(inst.dpDiv);
+ }
+
+ // Wrap datepicker w/ class to narrow the scope of jQuery UI CSS and prevent conflicts
+ $id('ui-datepicker-div').addClass('cmb2-element');
+
+ // Let's be sure to call beforeShow if it was added
+ if ('function' === typeof existing.beforeShow) {
+ existing.beforeShow(input, inst);
+ }
+ };
+
+ if ('timepicker' === method) {
+ options.onChangeMonthYear = function (year, month, inst, picker) {
+ cmb.addTimePickerClasses(inst.dpDiv);
+
+ // Let's be sure to call onChangeMonthYear if it was added
+ if ('function' === typeof existing.onChangeMonthYear) {
+ existing.onChangeMonthYear(year, month, inst, picker);
+ }
+ };
+ }
+
+ options.onClose = function (dateText, inst) {
+ // Remove the class when we're done with it (and hide to remove FOUC).
+ $id('ui-datepicker-div').removeClass('cmb2-element').hide();
+
+ // Let's be sure to call onClose if it was added
+ if ('function' === typeof existing.onClose) {
+ existing.onClose(dateText, inst);
+ }
+ };
+
+ return options;
+ };
+
+ // Adds classes to timepicker buttons.
+ cmb.addTimePickerClasses = function ($picker) {
+ var func = cmb.addTimePickerClasses;
+ func.count = func.count || 0;
+
+ // Wait a bit to let the timepicker render, since these are pre-render events.
+ setTimeout(function () {
+ if ($picker.find('.ui-priority-secondary').length) {
+ $picker.find('.ui-priority-secondary').addClass('button-secondary');
+ $picker.find('.ui-priority-primary').addClass('button-primary');
+ func.count = 0;
+ } else if (func.count < 5) {
+ func.count++;
+ func($picker);
+ }
+ }, 10);
+ };
+
+ cmb.initColorPickers = function ($selector) {
+ if (!$selector.length) {
+ return;
+ }
+ if (typeof jQuery.wp === 'object' && typeof jQuery.wp.wpColorPicker === 'function') {
+
+ $selector.each(function () {
+ var $this = $(this);
+ var fieldOpts = $this.data('colorpicker') || {};
+ $this.wpColorPicker($.extend({}, cmb.defaults.color_picker, fieldOpts));
+ });
+
+ } else {
+ $selector.each(function (i) {
+ $(this).after('');
+ $id('picker-' + i).hide().farbtastic($(this));
+ })
+ .focus(function () {
+ $(this).next().show();
+ })
+ .blur(function () {
+ $(this).next().hide();
+ });
+ }
+ };
+
+ cmb.makeListSortable = function () {
+ var $filelist = cmb.metabox().find('.cmb2-media-status.cmb-attach-list');
+ if ($filelist.length) {
+ $filelist.sortable({cursor: 'move'}).disableSelection();
+ }
+ };
+
+ cmb.maybeOembed = function (evt) {
+ var $this = $(this);
+
+ var m = {
+ focusout: function () {
+ setTimeout(function () {
+ // if it's been 2 seconds, hide our spinner
+ cmb.spinner('.postbox .cmb2-metabox', true);
+ }, 2000);
+ },
+ keyup: function () {
+ var betw = function (min, max) {
+ return ( evt.which <= max && evt.which >= min );
+ };
+ // Only Ajax on normal keystrokes
+ if (betw(48, 90) || betw(96, 111) || betw(8, 9) || evt.which === 187 || evt.which === 190) {
+ // fire our ajax function
+ cmb.doAjax($this, evt);
+ }
+ },
+ paste: function () {
+ // paste event is fired before the value is filled, so wait a bit
+ setTimeout(function () {
+ cmb.doAjax($this);
+ }, 100);
+ }
+ };
+
+ m[evt.type]();
+ };
+
+ /**
+ * Resize oEmbed videos to fit in their respective metaboxes
+ */
+ cmb.resizeoEmbeds = function () {
+ cmb.metabox().each(function () {
+ var $this = $(this);
+ var $tableWrap = $this.parents('.inside');
+ var isSide = $this.parents('.inner-sidebar').length || $this.parents('#side-sortables').length;
+ var isSmall = isSide;
+ var isSmallest = false;
+ if (!$tableWrap.length) {
+ return true; // continue
+ }
+
+ // Calculate new width
+ var tableW = $tableWrap.width();
+
+ if (cmb.styleBreakPoint > tableW) {
+ isSmall = true;
+ isSmallest = ( cmb.styleBreakPoint - 62 ) > tableW;
+ }
+
+ tableW = isSmall ? tableW : Math.round(($tableWrap.width() * 0.82) * 0.97);
+ var newWidth = tableW - 30;
+ if (isSmall && !isSide && !isSmallest) {
+ newWidth = newWidth - 75;
+ }
+ if (newWidth > 639) {
+ return true; // continue
+ }
+
+ var $embeds = $this.find('.cmb-type-oembed .embed-status');
+ var $children = $embeds.children().not('.cmb2-remove-wrapper');
+ if (!$children.length) {
+ return true; // continue
+ }
+
+ $children.each(function () {
+ var $this = $(this);
+ var iwidth = $this.width();
+ var iheight = $this.height();
+ var _newWidth = newWidth;
+ if ($this.parents('.cmb-repeat-row').length && !isSmall) {
+ // Make room for our repeatable "remove" button column
+ _newWidth = newWidth - 91;
+ _newWidth = 785 > tableW ? _newWidth - 15 : _newWidth;
+ }
+ // Calc new height
+ var newHeight = Math.round((_newWidth * iheight) / iwidth);
+ $this.width(_newWidth).height(newHeight);
+ });
+
+ });
+ };
+
+ /**
+ * Safely log things if query var is set
+ * @since 1.0.0
+ */
+ cmb.log = function () {
+ if (l10n.script_debug && console && typeof console.log === 'function') {
+ console.log.apply(console, arguments);
+ }
+ };
+
+ cmb.spinner = function ($context, hide) {
+ if (hide) {
+ $('.cmb-spinner', $context).hide();
+ }
+ else {
+ $('.cmb-spinner', $context).show();
+ }
+ };
+
+ // function for running our ajax
+ cmb.doAjax = function ($obj) {
+ // get typed value
+ var oembed_url = $obj.val();
+ // only proceed if the field contains more than 6 characters
+ if (oembed_url.length < 6) {
+ return;
+ }
+
+ // get field id
+ var field_id = $obj.attr('id');
+ var $context = $obj.closest('.cmb-td');
+ var $embed_container = $context.find('.embed-status');
+ var $embed_wrap = $context.find('.embed_wrap');
+ var $child_el = $embed_container.find(':first-child');
+ var oembed_width = $embed_container.length && $child_el.length ? $child_el.width() : $obj.width();
+
+ cmb.log('oembed_url', oembed_url, field_id);
+
+ // show our spinner
+ cmb.spinner($context);
+ // clear out previous results
+ $embed_wrap.html('');
+ // and run our ajax function
+ setTimeout(function () {
+ // if they haven't typed in 500 ms
+ if ($('.cmb2-oembed:focus').val() !== oembed_url) {
+ return;
+ }
+ $.ajax({
+ type: 'post',
+ dataType: 'json',
+ url: l10n.ajaxurl,
+ data: {
+ 'action': 'cmb2_oembed_handler',
+ 'oembed_url': oembed_url,
+ 'oembed_width': oembed_width > 300 ? oembed_width : 300,
+ 'field_id': field_id,
+ 'object_id': $obj.data('objectid'),
+ 'object_type': $obj.data('objecttype'),
+ 'cmb2_ajax_nonce': l10n.ajax_nonce
+ },
+ success: function (response) {
+ cmb.log(response);
+ // hide our spinner
+ cmb.spinner($context, true);
+ // and populate our results from ajax response
+ $embed_wrap.html(response.data);
+ }
+ });
+
+ }, 500);
+
+ };
+
+ cmb.trigger = function (evtName) {
+ var args = Array.prototype.slice.call(arguments, 1);
+ args.push(cmb);
+ $document.trigger(evtName, args);
+ };
+
+ cmb.triggerElement = function ($el, evtName) {
+ var args = Array.prototype.slice.call(arguments, 2);
+ args.push(cmb);
+ $el.trigger(evtName, args);
+ };
+
+ $(cmb.init);
})(window, document, jQuery, window.CMB2);
diff --git a/includes/admin-functions.php b/includes/admin-functions.php
index cc26a98..a7f993a 100755
--- a/includes/admin-functions.php
+++ b/includes/admin-functions.php
@@ -165,7 +165,10 @@ function wpfc_sermon_order( $vars ) {
break;
case 'preached':
$vars = array_merge( $vars, array(
- 'orderby' => 'date'
+ 'meta_key' => 'sermon_date',
+ 'orderby' => 'meta_value_num',
+ 'meta_value_num' => time(),
+ 'meta_compare' => '<=',
) );
break;
}
@@ -235,7 +238,7 @@ function wpfc_sermon_columns( $column ) {
$data = wpfc_entry_views_get( array( 'post_id' => $post->ID ) );
break;
case "preached":
- $data = get_the_date();
+ $data = sm_get_the_date( '', $post );
break;
case "passage":
$data = get_post_meta( $post->ID, 'bible_passage', true );
diff --git a/includes/class-sm-dates-wp.php b/includes/class-sm-dates-wp.php
new file mode 100644
index 0000000..e31e338
--- /dev/null
+++ b/includes/class-sm-dates-wp.php
@@ -0,0 +1,44 @@
+) Sermon Manager versions will save
+ * the date as Unix timestamp so sanitation is not required
+ *
+ * @return string|false Date when sermon was preached. False on failure
+ */
+ public static function get( $format = '', $post = null, $force_unix_sanitation = false ) {
+ // Reset the variable
+ $has_time = $sanitized = false;
+
+ // Get the sermon
+ $post = get_post( $post );
+
+ // If we are working on right post type
+ if ( ! $post || $post->post_type !== 'wpfc_sermon' ) {
+ return false;
+ }
+
+ // Check if date is set
+ if ( ! $date = get_post_meta( $post->ID, 'sermon_date', true ) ) {
+ return false;
+ }
+
+ // Save original date to a variable to allow later filtering
+ $orig_date = $date;
+
+ // If it's already an Unix timestamp, don't convert it
+ if ( is_numeric( $date ) && $date = intval( trim( $date ) ) ) {
+ $dt = DateTime::createFromFormat( 'U', $date );
+ if ( $dt->format( 'H' ) !== '00' && $dt->format( 'i' ) !== '00' ) {
+ $has_time = true;
+ }
+ } else {
+ $date = self::sanitize( $date );
+ $sanitized = true;
+ update_post_meta( $post->ID, 'sermon_date', $date );
+ }
+
+ // Check if we need to force it
+ if ( $sanitized === false && $force_unix_sanitation === true ) {
+ $date = self::sanitize( $date );
+ }
+
+ // Add the time if time is not set. The way this is done is that it checks for post time, takes it, converts to
+ // seconds and adds to Unix timestamp. It's so we don't have 00:00 time set for all sermons with old date format.
+ if ( ! $has_time ) {
+ $dt = DateTime::createFromFormat( 'U', get_post_time( 'U', true, $post->ID ) );
+
+ $time = array(
+ $dt->format( 'H' ),
+ $dt->format( 'm' ),
+ $dt->format( 's' )
+ );
+
+ // convert all to ints
+ $time = array_map( 'intval', $time );
+
+ list( $hours, $minutes, $seconds ) = $time;
+
+ $date += $hours * HOUR_IN_SECONDS + $minutes * MINUTE_IN_SECONDS + $seconds;
+ }
+
+ // Check if format is set. If not, set to WP defined, or in super rare cases
+ // when WP format is not defined, set it to Unix timestamp
+ if ( empty( $format ) ) {
+ $format = get_option( 'date_format', 'U' );
+ }
+
+ // Format it
+ $date = date( $format, $date );
+
+ /**
+ * Filters the date a post was preached
+ *
+ * @since 2.6
+ *
+ * @param string $date Modified and sanitized date
+ * @param string $orig_date Original date from the database
+ * @param string $format Date format
+ * @param bool $force_unix_sanitation If the sanitation is forced
+ */
+ return apply_filters( 'sm_dates_get', $date, $orig_date, $format, $force_unix_sanitation );
+ }
+
+ /**
+ * Tries to convert the textual date to Unix timestamp
+ *
+ * @param string $date
+ *
+ * @return int Unix timestamp
+ */
+ protected static function sanitize( $date ) {
+ $sanitized_date = strtotime( $date );
+
+ /**
+ * Allow modification of the sanitized date
+ *
+ * @since 2.6
+ *
+ * @param int $sanitized_date Unix timestamp
+ * @param string $date The raw date, usually in "mm/dd/YYYY" format, but could be "dd/mm/YYYY" as well.
+ * Unfortunately, this function could return wrong time. But, we assume that all
+ * dates have been saved to the database in "mm/dd/YYYY" format.
+ * Warning: there could be other formats that we are not aware of yet.
+ */
+ return apply_filters( 'sm_sanitize_date', $sanitized_date, $date );
+ }
+
+ public static function set( $date, $post ) {
+
+ }
+}
\ No newline at end of file
diff --git a/includes/img/sm-icon.svg b/includes/img/sm-icon.svg
index 2a40926..8630209 100644
--- a/includes/img/sm-icon.svg
+++ b/includes/img/sm-icon.svg
@@ -1,7 +1,9 @@
-