WebDevStudios / CMB2

includes/CMB2_Sanitize.php

Doc Comments +3 added lines

@@ -357,6 +357,7 @@ 
 	/**
 	 * Gets the values for the `file` field type from the data being saved.
 	 * @since  2.2.0
+	 * @param string $id_key
 	 */
 	public function _get_group_file_value_array( $id_key ) {
 		$alldata = $this->field->group->data_to_save;
@@ -378,6 +379,7 @@ 
 	/**
 	 * Peforms saving of `file` attachement's ID
 	 * @since  1.1.0
+	 * @param string $file_id_key
 	 */
 	public function _save_file_id_value( $file_id_key ) {
 		$id_field = $this->_new_supporting_field( $file_id_key );
@@ -398,6 +400,7 @@ 
 	/**
 	 * Peforms saving of `text_datetime_timestamp_timezone` utc timestamp
 	 * @since  2.2.0
+	 * @param string $utc_key
 	 */
 	public function _save_utc_value( $utc_key, $utc_stamp ) {
 		return $this->_new_supporting_field( $utc_key )->save_field( $utc_stamp );

Spacing +8 added lines, -8 removed lines

@@ -172,7 +172,7 @@ 
 
 		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
@@ -215,8 +215,8 @@ 
 			return $repeat_value;
 		}
 
-		if ( isset( $this->value['date'], $this->value['time'] ) ) {
-			$this->value = $this->field->get_timestamp_from_value( $this->value['date'] . ' ' . $this->value['time'] );
+		if ( isset( $this->value[ 'date' ], $this->value[ 'time' ] ) ) {
+			$this->value = $this->field->get_timestamp_from_value( $this->value[ 'date' ] . ' ' . $this->value[ 'time' ] );
 		}
 
 		if ( $tz_offset = $this->field->field_timezone_offset() ) {
@@ -254,7 +254,7 @@ 
 		$tzstring = null;
 
 		if ( is_array( $this->value ) && array_key_exists( 'timezone', $this->value ) ) {
-			$tzstring = $this->value['timezone'];
+			$tzstring = $this->value[ 'timezone' ];
 		}
 
 		if ( empty( $tzstring ) ) {
@@ -274,8 +274,8 @@ 
 			$tzstring = false !== $tzstring ? $tzstring : timezone_name_from_abbr( '', 0, 0 );
 		}
 
-		$full_format = $this->field->args['date_format'] . ' ' . $this->field->args['time_format'];
-		$full_date   = $this->value['date'] . ' ' . $this->value['time'];
+		$full_format = $this->field->args[ 'date_format' ] . ' ' . $this->field->args[ 'time_format' ];
+		$full_date   = $this->value[ 'date' ] . ' ' . $this->value[ 'time' ];
 
 		try {
 
@@ -298,7 +298,7 @@ 
 			} else {
 				// Save the utc timestamp supporting field
 				if ( $repeat ) {
-					$utc_values[ $utc_key ][] = $utc_stamp;
+					$utc_values[ $utc_key ][ ] = $utc_stamp;
 				} else {
 					$this->_save_utc_value( $utc_key, $utc_stamp );
 				}
@@ -433,7 +433,7 @@ 
 			if ( $this->value ) {
 				$val = $this->$method( true );
 				if ( ! empty( $val ) ) {
-					$new_value[] = $val;
+					$new_value[ ] = $val;
 				}
 			}
 		}

example-functions.php

Spacing +5 added lines, -5 removed lines

@@ -78,7 +78,7 @@ 
 	$cmb_demo = new_cmb2_box( array(

 		'id'            => $prefix . 'metabox',

 		'title'         => __( 'Test Metabox', 'cmb2' ),

-		'object_types'  => array( 'page', ), // Post type

+		'object_types'  => array( 'page',), // Post type

 		// 'show_on_cb' => 'yourprefix_show_if_front_page', // function should return a bool value

 		// 'context'    => 'normal',

 		// 'priority'   => 'high',

@@ -329,7 +329,7 @@ 
 		'desc'    => __( 'field description (optional)', 'cmb2' ),

 		'id'      => $prefix . 'wysiwyg',

 		'type'    => 'wysiwyg',

-		'options' => array( 'textarea_rows' => 5, ),

+		'options' => array( 'textarea_rows' => 5,),

 	) );

 

 	$cmb_demo->add_field( array(

@@ -381,11 +381,11 @@ 
 	$cmb_about_page = new_cmb2_box( array(

 		'id'           => $prefix . 'metabox',

 		'title'        => __( 'About Page Metabox', 'cmb2' ),

-		'object_types' => array( 'page', ), // Post type

+		'object_types' => array( 'page',), // Post type

 		'context'      => 'normal',

 		'priority'     => 'high',

 		'show_names'   => true, // Show field names on the left

-		'show_on'      => array( 'id' => array( 2, ) ), // Specific post IDs to display this metabox

+		'show_on'      => array( 'id' => array( 2,) ), // Specific post IDs to display this metabox

 	) );

 

 	$cmb_about_page->add_field( array(

@@ -410,7 +410,7 @@ 
 	$cmb_group = new_cmb2_box( array(

 		'id'           => $prefix . 'metabox',

 		'title'        => __( 'Repeating Field Group', 'cmb2' ),

-		'object_types' => array( 'page', ),

+		'object_types' => array( 'page',),

 	) );

 

 	// $group_field_id is the field id string, so in this case: $prefix . 'demo'

Braces +17 added lines, -17 removed lines

@@ -15,9 +15,9 @@ 
  * Get the bootstrap! If using the plugin from wordpress.org, REMOVE THIS!

  */

 

-if ( file_exists( dirname( __FILE__ ) . '/cmb2/init.php' ) ) {

+if ( file_exists( dirname( __FILE__ ) . '/cmb2/init.php' ) ) {
 	require_once dirname( __FILE__ ) . '/cmb2/init.php';

-} elseif ( file_exists( dirname( __FILE__ ) . '/CMB2/init.php' ) ) {

+} elseif ( file_exists( dirname( __FILE__ ) . '/CMB2/init.php' ) ) {
 	require_once dirname( __FILE__ ) . '/CMB2/init.php';

 }

 

@@ -28,9 +28,9 @@ 
  *

  * @return bool             True if metabox should show

  */

-function yourprefix_show_if_front_page( $cmb ) {

+function yourprefix_show_if_front_page( $cmb ) {
 	// Don't show this metabox if it's not the front page template

-	if ( $cmb->object_id !== get_option( 'page_on_front' ) ) {

+	if ( $cmb->object_id !== get_option( 'page_on_front' ) ) {
 		return false;

 	}

 	return true;

@@ -43,9 +43,9 @@ 
  *

  * @return bool                     True if metabox should show

  */

-function yourprefix_hide_if_no_cats( $field ) {

+function yourprefix_hide_if_no_cats( $field ) {
 	// Don't show this field if not in the cats category

-	if ( ! has_tag( 'cats', $field->object_id ) ) {

+	if ( ! has_tag( 'cats', $field->object_id ) ) {
 		return false;

 	}

 	return true;

@@ -57,7 +57,7 @@ 
  * @param  array      $field_args Array of field arguments.

  * @param  CMB2_Field $field      The field object

  */

-function yourprefix_render_row_cb( $field_args, $field ) {

+function yourprefix_render_row_cb( $field_args, $field ) {
 	$classes     = $field->row_classes();

 	$id          = $field->args( 'id' );

 	$label       = $field->args( 'name' );

@@ -79,7 +79,7 @@ 
  * @param  array      $field_args Array of field arguments.

  * @param  CMB2_Field $field      The field object

  */

-function yourprefix_display_text_small_column( $field_args, $field ) {

+function yourprefix_display_text_small_column( $field_args, $field ) {
 	?>

 	<div class="custom-column-display <?php echo $field->row_classes(); ?>">

 		<p><?php echo $field->escaped_value(); ?></p>

@@ -94,10 +94,10 @@ 
  * @param  array             $field_args Array of field parameters

  * @param  CMB2_Field object $field      Field object

  */

-function yourprefix_before_row_if_2( $field_args, $field ) {

-	if ( 2 == $field->object_id ) {

+function yourprefix_before_row_if_2( $field_args, $field ) {
+	if ( 2 == $field->object_id ) {
 		echo '<p>Testing <b>"before_row"</b> parameter (on $post_id 2)</p>';

-	} else {

+	} else {
 		echo '<p>Testing <b>"before_row"</b> parameter (<b>NOT</b> on $post_id 2)</p>';

 	}

 }

@@ -106,7 +106,7 @@ 
 /**

  * Hook in and add a demo metabox. Can only happen on the 'cmb2_admin_init' or 'cmb2_init' hook.

  */

-function yourprefix_register_demo_metabox() {

+function yourprefix_register_demo_metabox() {
 	$prefix = 'yourprefix_demo_';

 

 	/**

@@ -416,7 +416,7 @@ 
 /**

  * Hook in and add a metabox that only appears on the 'About' page

  */

-function yourprefix_register_about_page_metabox() {

+function yourprefix_register_about_page_metabox() {
 	$prefix = 'yourprefix_about_';

 

 	/**

@@ -445,7 +445,7 @@ 
 /**

  * Hook in and add a metabox to demonstrate repeatable grouped fields

  */

-function yourprefix_register_repeatable_group_field_metabox() {

+function yourprefix_register_repeatable_group_field_metabox() {
 	$prefix = 'yourprefix_group_';

 

 	/**

@@ -509,7 +509,7 @@ 
 /**

  * Hook in and add a metabox to add fields to the user profile pages

  */

-function yourprefix_register_user_profile_metabox() {

+function yourprefix_register_user_profile_metabox() {
 	$prefix = 'yourprefix_user_';

 

 	/**

@@ -579,7 +579,7 @@ 
 /**

  * Hook in and add a metabox to add fields to taxonomy terms

  */

-function yourprefix_register_taxonomy_metabox() {

+function yourprefix_register_taxonomy_metabox() {
 	$prefix = 'yourprefix_term_';

 

 	/**

@@ -621,7 +621,7 @@ 
 /**

  * Hook in and register a metabox to handle a theme options page

  */

-function yourprefix_register_theme_options_metabox() {

+function yourprefix_register_theme_options_metabox() {
 

 	$option_key = 'yourprefix_theme_options';

 

includes/CMB2_Options.php

Spacing +1 added lines, -1 removed lines

@@ -131,7 +131,7 @@
 
 			if ( ! $single ) {
 				// If multiple, add to array
-				$this->options[ $field_id ][] = $value;
+				$this->options[ $field_id ][ ] = $value;
 			} else {
 				$this->options[ $field_id ] = $value;
 			}

includes/CMB2_Show_Filters.php

Spacing +9 added lines, -9 removed lines

@@ -27,15 +27,15 @@ 
 	 * @return mixed                show_on key or false
 	 */
 	private static function get_show_on_key( $meta_box_args ) {
-		$show_on = isset( $meta_box_args['show_on'] ) ? (array) $meta_box_args['show_on'] : false;
+		$show_on = isset( $meta_box_args[ 'show_on' ] ) ? (array) $meta_box_args[ 'show_on' ] : false;
 		if ( $show_on && is_array( $show_on ) ) {
 
 			if ( array_key_exists( 'key', $show_on ) ) {
-				return $show_on['key'];
+				return $show_on[ 'key' ];
 			}
 
 			$keys = array_keys( $show_on );
-			return $keys[0];
+			return $keys[ 0 ];
 		}
 
 		return false;
@@ -51,17 +51,17 @@ 
 	 * @return mixed                show_on value or false
 	 */
 	private static function get_show_on_value( $meta_box_args ) {
-		$show_on = isset( $meta_box_args['show_on'] ) ? (array) $meta_box_args['show_on'] : false;
+		$show_on = isset( $meta_box_args[ 'show_on' ] ) ? (array) $meta_box_args[ 'show_on' ] : false;
 
 		if ( $show_on && is_array( $show_on ) ) {
 
 			if ( array_key_exists( 'value', $show_on ) ) {
-				return $show_on['value'];
+				return $show_on[ 'value' ];
 			}
 
 			$keys = array_keys( $show_on );
 
-			return $show_on[ $keys[0] ];
+			return $show_on[ $keys[ 0 ] ];
 		}
 
 		return array();
@@ -141,7 +141,7 @@ 
 		if ( is_admin() ) {
 
 			// If there is no 'page' query var, our filter isn't applicable
-			if ( ! isset( $_GET['page'] ) ) {
+			if ( ! isset( $_GET[ 'page' ] ) ) {
 				return $display;
 			}
 
@@ -153,12 +153,12 @@ 
 
 			if ( is_array( $show_on ) ) {
 				foreach ( $show_on as $page ) {
-					if ( $_GET['page'] == $page ) {
+					if ( $_GET[ 'page' ] == $page ) {
 						return true;
 					}
 				}
 			} else {
-				if ( $_GET['page'] == $show_on ) {
+				if ( $_GET[ 'page' ] == $show_on ) {
 					return true;
 				}
 			}

includes/types/CMB2_Type_Base.php

Doc Comments +1 added lines, -2 removed lines

@@ -84,7 +84,6 @@ 
 
 	/**
 	 * Fall back to CMB2_Types methods
-	 * @param string $field
 	 * @throws Exception Throws an exception if the field is invalid.
 	 * @return mixed
 	 */
@@ -105,7 +104,7 @@ 
 	 * Magic getter for our object.
 	 * @param string $field
 	 * @throws Exception Throws an exception if the field is invalid.
-	 * @return mixed
+	 * @return CMB2_Field
 	 */
 	public function __get( $field ) {
 		switch ( $field ) {

Spacing +2 added lines, -2 removed lines

@@ -38,7 +38,7 @@ 
 	 */
 	public function __construct( CMB2_Types $types, $args = array() ) {
 		$this->types = $types;
-		$args['rendered'] = isset( $args['rendered'] ) ? (bool) $args['rendered'] : true;
+		$args[ 'rendered' ] = isset( $args[ 'rendered' ] ) ? (bool) $args[ 'rendered' ] : true;
 		$this->args = $args;
 	}
 
@@ -56,7 +56,7 @@ 
 	 * @return string|CMB2_Type_Base           Rendered output or this object.
 	 */
 	public function rendered( $rendered ) {
-		if ( $this->args['rendered'] ) {
+		if ( $this->args[ 'rendered' ] ) {
 			return is_a( $rendered, __CLASS__ ) ? $rendered->rendered : $rendered;
 		}
 

includes/types/CMB2_Type_Text_Datetime_Timestamp.php

Doc Comments +6 added lines

@@ -38,6 +38,9 @@ 
 		return $date_input . "\n" . $time_input;
 	}
 
+	/**
+	 * @param boolean $has_good_value
+	 */
 	public function date_args( $args, $has_good_value ) {
 		$date_args = wp_parse_args( $args['datepicker'], array(
 			'class' => 'cmb2-text-small cmb2-datepicker',
@@ -51,6 +54,9 @@ 
 		return $this->parse_picker_options( 'date', $date_args );
 	}
 
+	/**
+	 * @param boolean $has_good_value
+	 */
 	public function time_args( $args, $has_good_value ) {
 		$time_args = wp_parse_args( $args['timepicker'], array(
 			'class' => 'cmb2-timepicker text-time',

Spacing +11 added lines, -11 removed lines

@@ -22,16 +22,16 @@ 
 			'timepicker' => array(),
 		) );
 
-		if ( empty( $args['value'] ) ) {
-			$args['value'] = $field->escaped_value();
+		if ( empty( $args[ 'value' ] ) ) {
+			$args[ 'value' ] = $field->escaped_value();
 			// This will be used if there is a select_timezone set for this field
 			$tz_offset = $field->field_timezone_offset();
 			if ( ! empty( $tz_offset ) ) {
-				$args['value'] -= $tz_offset;
+				$args[ 'value' ] -= $tz_offset;
 			}
 		}
 
-		$has_good_value = ! empty( $args['value'] ) && ! is_array( $args['value'] );
+		$has_good_value = ! empty( $args[ 'value' ] ) && ! is_array( $args[ 'value' ] );
 
 		$date_input = parent::render( $this->date_args( $args, $has_good_value ) );
 		$time_input = parent::render( $this->time_args( $args, $has_good_value ) );
@@ -40,31 +40,31 @@ 
 	}
 
 	public function date_args( $args, $has_good_value ) {
-		$date_args = wp_parse_args( $args['datepicker'], array(
+		$date_args = wp_parse_args( $args[ 'datepicker' ], array(
 			'class' => 'cmb2-text-small cmb2-datepicker',
 			'name'  => $this->_name( '[date]' ),
 			'id'    => $this->_id( '_date' ),
-			'value' => $has_good_value ? $this->field->get_timestamp_format( 'date_format', $args['value'] ) : '',
+			'value' => $has_good_value ? $this->field->get_timestamp_format( 'date_format', $args[ 'value' ] ) : '',
 			'desc'  => '',
 		) );
 
-		$date_args['rendered'] = true;
+		$date_args[ 'rendered' ] = true;
 
 		// Let's get the date-format, and set it up as a data attr for the field.
 		return $this->parse_picker_options( 'date', $date_args );
 	}
 
 	public function time_args( $args, $has_good_value ) {
-		$time_args = wp_parse_args( $args['timepicker'], array(
+		$time_args = wp_parse_args( $args[ 'timepicker' ], array(
 			'class' => 'cmb2-timepicker text-time',
 			'name'  => $this->_name( '[time]' ),
 			'id'    => $this->_id( '_time' ),
-			'value' => $has_good_value ? $this->field->get_timestamp_format( 'time_format', $args['value'] ) : '',
-			'desc'  => $args['desc'],
+			'value' => $has_good_value ? $this->field->get_timestamp_format( 'time_format', $args[ 'value' ] ) : '',
+			'desc'  => $args[ 'desc' ],
 			'js_dependencies' => array( 'jquery-ui-core', 'jquery-ui-datepicker', 'jquery-ui-datetimepicker' ),
 		) );
 
-		$time_args['rendered'] = true;
+		$time_args[ 'rendered' ] = true;
 
 		// Let's get the time-format, and set it up as a data attr for the field.
 		return $this->parse_picker_options( 'time', $time_args );

includes/types/CMB2_Type_Wysiwyg.php

Doc Comments -1 removed lines

@@ -15,7 +15,6 @@
 	/**
 	 * Handles outputting a 'wysiwyg' element
 	 * @since  1.1.0
-	 * @param  array  $args Override arguments
 	 * @return string       Form wysiwyg element
 	 */
 	public function render() {

Spacing +4 added lines, -4 removed lines

@@ -28,7 +28,7 @@ 
 		) );
 
 		if ( ! $field->group ) {
-			return $this->rendered( $this->get_wp_editor( $a ) . $a['desc'] );
+			return $this->rendered( $this->get_wp_editor( $a ) . $a[ 'desc' ] );
 		}
 
 		// wysiwyg fields in a group need some special handling.
@@ -52,7 +52,7 @@ 
 
 	protected function get_wp_editor( $args ) {
 		ob_start();
-		wp_editor( $args['value'], $args['id'], $args['options'] );
+		wp_editor( $args[ 'value' ], $args[ 'id' ], $args[ 'options' ] );
 		return ob_get_clean();
 	}
 
@@ -60,7 +60,7 @@ 
 		$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;
+		$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.
 		$editor = $this->get_wp_editor( array(
@@ -83,7 +83,7 @@ 
 		// And put the editor instance in a JS template wrapper.
 		echo '<script type="text/template" id="tmpl-cmb2-wysiwyg-' . $group_id . '-' . $field_id . '">';
 		// Need to wrap the template in a wrapper div w/ specific data attributes which will be used when adding/removing rows.
-		echo '<div class="cmb2-wysiwyg-inner-wrap" data-iterator="{{ data.iterator }}" data-groupid="'. $group_id .'" data-id="'. $field_id .'">'. $editor .'</div>';
+		echo '<div class="cmb2-wysiwyg-inner-wrap" data-iterator="{{ data.iterator }}" data-groupid="' . $group_id . '" data-id="' . $field_id . '">' . $editor . '</div>';
 		echo '</script>';
 	}
 

includes/types/CMB2_Type_Oembed.php

Spacing +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
 			'data-objecttype' => $field->object_type,
 		) )
 		. '<p class="cmb-spinner spinner" style="display:none;"></p>'
-		. '<div id="'. $this->_id( '-status' ). '" class="cmb2-media-status ui-helper-clearfix embed_wrap">' . $oembed . '</div>';
+		. '<div id="' . $this->_id( '-status' ) . '" class="cmb2-media-status ui-helper-clearfix embed_wrap">' . $oembed . '</div>';
 	}
 
 }

includes/types/CMB2_Type_Select_Timezone.php

Spacing +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 
 	public function render() {
 
-		$this->field->args['default'] = $this->field->get_default()
+		$this->field->args[ 'default' ] = $this->field->get_default()
 			? $this->field->get_default()
 			: cmb2_utils()->timezone_string();