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 );

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 ) {

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',

includes/types/CMB2_Type_Textarea_Code.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() {

includes/CMB2.php

Doc Comments +3 added lines, -2 removed lines

@@ -408,6 +408,7 @@ 
 	 * Add a hidden field to the list of hidden fields to be rendered later
 	 * @since 2.0.0
 	 * @param array  $field_args Array of field arguments to be passed to CMB2_Field
+	 * @param CMB2_Field $field_group
 	 */
 	public function add_hidden_field( $field_args, $field_group = null ) {
 		if ( isset( $field_args['field_args'] ) ) {
@@ -851,7 +852,7 @@ 
 	 * @param  mixed  $field_id     Field (or group field) ID
 	 * @param  mixed  $field_args   Array of field arguments
 	 * @param  mixed  $sub_field_id Sub field ID (if field_group exists)
-	 * @param  mixed  $field_group  If a sub-field, will be the parent group CMB2_Field object
+	 * @param  CMB2_Field|null  $field_group  If a sub-field, will be the parent group CMB2_Field object
 	 * @return array                Array of CMB2_Field arguments
 	 */
 	public function get_field_args( $field_id, $field_args, $sub_field_id, $field_group ) {
@@ -938,7 +939,7 @@ 
 	 * @since  2.0.0
 	 * @param  array  $field           Metabox field config array
 	 * @param  int    $position        (optional) Position of metabox. 1 for first, etc
-	 * @return mixed                   Field id or false
+	 * @return string                   Field id or false
 	 */
 	public function add_field( array $field, $position = 0 ) {
 		if ( ! is_array( $field ) || ! array_key_exists( 'id', $field ) ) {

includes/CMB2_Field.php

Doc Comments +2 added lines, -2 removed lines

@@ -735,7 +735,7 @@ 
 	 * Return a formatted timestamp for a field
 	 * @since  2.0.0
 	 * @param  string $format     Either date_format or time_format
-	 * @param  string $meta_value Optional meta value to check
+	 * @param  integer $meta_value Optional meta value to check
 	 * @return string             Formatted date
 	 */
 	public function get_timestamp_format( $format = 'date_format', $meta_value = 0 ) {
@@ -1007,7 +1007,7 @@ 
 	 * Retrieve options args. Calls options_cb if it exists.
 	 * @since  2.0.0
 	 * @param  string  $key Specific option to retrieve
-	 * @return array        Array of options
+	 * @return string        Array of options
 	 */
 	public function options( $key = '' ) {
 		if ( ! empty( $this->field_options ) ) {

example-functions.php

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_Utils.php

Braces +3 added lines, -2 removed lines

@@ -122,7 +122,8 @@ 
 			$tzstring = '';
 		}
 
-		if ( empty( $tzstring ) ) { // Create a UTC+- zone if no timezone string exists
+		if ( empty( $tzstring ) ) {
+// Create a UTC+- zone if no timezone string exists
 			if ( 0 == $current_offset ) {
 				$tzstring = 'UTC+0';
 			} elseif ( $current_offset < 0 ) {
@@ -179,7 +180,7 @@ 
 	 * @param  mixed $value Value to check
 	 * @return bool         True or false
 	 */
-	public static function notempty( $value ){
+	public static function notempty( $value ) {
 		return null !== $value && '' !== $value && false !== $value;
 	}
 

includes/CMB2_Base.php

Braces +2 added lines, -4 removed lines

@@ -370,15 +370,13 @@
 			if ( function_exists( '__' ) ) {
 				if ( ! is_null( $message ) ) {
 					trigger_error( sprintf( __( '%1$s was called with a parameter that is <strong>deprecated</strong> since version %2$s! %3$s', 'cmb2' ), $function, $version, $message ) );
-				}
-				else {
+				} else {
 					trigger_error( sprintf( __( '%1$s was called with a parameter that is <strong>deprecated</strong> since version %2$s with no alternative available.', 'cmb2' ), $function, $version ) );
 				}
 			} else {
 				if ( ! is_null( $message ) ) {
 					trigger_error( sprintf( '%1$s was called with a parameter that is <strong>deprecated</strong> since version %2$s! %3$s', $function, $version, $message ) );
-				}
-				else {
+				} else {
 					trigger_error( sprintf( '%1$s was called with a parameter that is <strong>deprecated</strong> since version %2$s with no alternative available.', $function, $version ) );
 				}
 			}

Doc Comments +1 added lines, -1 removed lines

@@ -159,7 +159,7 @@
 	 * Get object property and optionally set a fallback
 	 * @since  2.0.0
 	 * @param  string $property Metabox config property to retrieve
-	 * @param  mixed  $fallback Fallback value to set if no value found
+	 * @param  boolean|null  $fallback Fallback value to set if no value found
 	 * @return mixed            Metabox config property value or false
 	 */
 	public function prop( $property, $fallback = null ) {