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

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

includes/rest-api/CMB2_REST.php

Doc Comments +7 added lines, -6 removed lines

@@ -197,6 +197,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
 	 */
@@ -391,7 +392,7 @@ 
 	 *
 	 * @since  2.2.4
 	 *
-	 * @param  mixed           $value       The value of the field
+	 * @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
@@ -410,7 +411,7 @@ 
 	 *
 	 * @since  2.2.4
 	 *
-	 * @param  mixed           $value       The value of the field
+	 * @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
@@ -429,7 +430,7 @@ 
 	 *
 	 * @since  2.2.4
 	 *
-	 * @param  mixed           $value       The value of the field
+	 * @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
@@ -448,7 +449,7 @@ 
 	 *
 	 * @since  2.2.4
 	 *
-	 * @param  mixed           $value       The value of the field
+	 * @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
@@ -467,7 +468,7 @@ 
 	 *
 	 * @since  2.2.4
 	 *
-	 * @param  mixed           $value            The value of the field
+	 * @param  mixed           $values            The value of the field
 	 * @param  object          $object           The object from the response
 	 * @param  WP_REST_Request $request          Current request
 	 * @param  string          $object_type      The request object type
@@ -665,7 +666,7 @@ 
 	 * Retrieve all CMB2_REST instances from the registry.
 	 *
 	 * @since  2.2.4
-	 * @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/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
 	 */