WebDevStudios / CMB2

includes/CMB2.php

Doc Comments +2 added lines, -2 removed lines

@@ -866,7 +866,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 ) {
@@ -925,7 +925,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_hookup.php

Doc Comments +1 added lines, -1 removed lines

@@ -267,7 +267,7 @@
 	 * Add 'closed' class to metabox
 	 * @since  2.0.0
 	 * @param  array  $classes Array of classes
-	 * @return array           Modified array of classes
+	 * @return string[]           Modified array of classes
 	 */
 	public function close_metabox_class( $classes ) {
 		$classes[] = 'closed';

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/CMB2_Types.php

Doc Comments +1 added lines, -1 removed lines

@@ -175,7 +175,7 @@
 	 * 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  string[]  $attr_exclude Attributes that should NOT be concatenated
 	 * @return string               String of attributes for form element
 	 */
 	public function concat_attrs( $attrs, $attr_exclude = array() ) {

example-functions.php

Braces +15 added lines, -15 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,10 +57,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>';

 	}

 }

@@ -69,7 +69,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_';

 

 	/**

@@ -372,7 +372,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_';

 

 	/**

@@ -401,7 +401,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_';

 

 	/**

@@ -465,7 +465,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_';

 

 	/**

@@ -535,7 +535,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_';

 

 	/**

@@ -577,7 +577,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 +2 added lines, -1 removed lines

@@ -110,7 +110,8 @@
 		$current_offset = get_option( 'gmt_offset' );
 		$tzstring       = get_option( 'timezone_string' );
 
-		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 ) {