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

includes/rest-api/CMB2_REST_Controller.php

Doc Comments +1 added lines, -2 removed lines

@@ -198,7 +198,7 @@ 
 	 * @since  2.2.3
 	 *
 	 * @param  mixed $cb Callable function/method.
-	 * @return mixed     Results of output buffer after calling function/method.
+	 * @return string     Results of output buffer after calling function/method.
 	 */
 	public function get_cb_results( $cb ) {
 		$args = func_get_args();
@@ -214,7 +214,6 @@ 
 	 *
 	 * @since 2.2.3
 	 *
-	 * @param  mixed            $item     WordPress representation of the item.
 	 * @param  WP_REST_Request  $request  Request object.
 	 * @return WP_REST_Response $response
 	 */

includes/CMB2_Base.php

Indentation +4 added lines, -4 removed lines

@@ -315,10 +315,10 @@
 	 * which is callable. If so, it registers the callback, and if not,
 	 * converts the maybe-modified $val to a boolean for return.
 	 *
- 	 * The registered handlers will have a parameter name which matches the filter, except:
- 	 * - The 'cmb2_api' prefix will be removed
- 	 * - A '_cb' suffix will be added (to stay inline with other '*_cb' parameters).
- 	 *
+	 * The registered handlers will have a parameter name which matches the filter, except:
+	 * - The 'cmb2_api' prefix will be removed
+	 * - A '_cb' suffix will be added (to stay inline with other '*_cb' parameters).
+	 *
 	 * @since  2.2.3
 	 *
 	 * @param  string $hook_name     The hook name.

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

includes/rest-api/CMB2_REST.php

Doc Comments +2 added lines, -1 removed lines

@@ -202,6 +202,7 @@ 
 	 * @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_type
 	 *
 	 * @return void
 	 */
@@ -701,7 +702,7 @@ 
 	 * Retrieve all CMB2_REST instances from the registry.
 	 *
 	 * @since  2.2.3
-	 * @return CMB2[] Array of all registered CMB2_REST instances.
+	 * @return CMB2_REST[] Array of all registered CMB2_REST instances.
 	 */
 	public static function get_all() {
 		return self::$boxes;

includes/CMB2_hookup.php

Doc Comments +2 added lines, -2 removed lines

@@ -465,7 +465,7 @@ 
 	 * Modify metabox postbox classes.
 	 * @since  2.2.4
 	 * @param  array  $classes Array of classes
-	 * @return array           Modified array of classes
+	 * @return string[]           Modified array of classes
 	 */
 	public function postbox_classes( $classes ) {
 		if ( $this->cmb->prop( 'closed' ) && ! in_array( 'closed', $classes ) ) {
@@ -485,7 +485,7 @@ 
 	 * Modify metabox altnernate context postbox classes.
 	 * @since  2.2.4
 	 * @param  array  $classes Array of classes
-	 * @return array           Modified array of classes
+	 * @return string[]           Modified array of classes
 	 */
 	protected function alternate_context_postbox_classes( $classes ) {
 		$classes[] = 'context-box';

includes/CMB2_Types.php

Doc Comments +1 added lines, -1 removed lines

@@ -226,7 +226,7 @@
 	 * @since  2.2.4
 	 * @param  string          $render_class_name The default field type class to use. Defaults to null.
 	 * @param  array          $args              Optional arguments to pass to type class.
-	 * @param  mixed          $additional        Optional additional argument to pass to type class.
+	 * @param  string          $additional        Optional additional argument to pass to type class.
 	 * @return CMB2_Type_Base                    Type object.
 	 */
 	public function get_new_render_type( $render_class_name = null, $args = array(), $additional = '' ) {