sc0ttkclark / wordpress-fields-api

includes/class-wp-fields-api-field.php

Doc Comments +3 added lines, -6 removed lines

@@ -133,10 +133,8 @@ 
 	 * Check user capabilities and theme supports, and then save
 	 * the value of the field.
 	 *
-	 * @param mixed $value   The value to save.
-	 * @param int   $item_id The Item ID.
 	 *
-	 * @return false|mixed False if cap check fails or value isn't set.
+	 * @return null|boolean False if cap check fails or value isn't set.
 	 */
 	public function save() {
 
@@ -188,9 +186,8 @@ 
 	 * Save the value of the field, using the related API.
 	 *
 	 * @param mixed $value The value to update.
-	 * @param int $item_id Item ID.
 	 *
-	 * @return mixed The result of saving the value.
+	 * @return null|boolean The result of saving the value.
 	 */
 	protected function update( $value ) {
 
@@ -538,7 +535,7 @@ 
 	 *
 	 * @param       $root
 	 * @param       $keys
-	 * @param mixed $default A default value which is used as a fallback. Default is null.
+	 * @param string $default A default value which is used as a fallback. Default is null.
 	 *
 	 * @return mixed The requested value or the default value.
 	 */

includes/class-wp-fields-api.php

Doc Comments +4 added lines, -5 removed lines

@@ -132,7 +132,7 @@ 
 	 * @access public
 	 *
 	 * @param string|null         $object_type   Object type. Null for all containers for all object types.
-	 * @param string|boolean|null $object_name   Object name (for post types and taxonomies).
+	 * @param string|boolean $object_name   Object name (for post types and taxonomies).
 	 *                                           True for all containers for all object names.
 	 *
 	 * @return WP_Fields_API_Screen[]|WP_Fields_API_Section[]
@@ -226,7 +226,7 @@ 
 	 * @access public
 	 *
 	 * @param string                      $object_type Object type.
-	 * @param WP_Fields_API_Screen|string $id          Field Screen object, or Screen ID.
+	 * @param string|null $id          Field Screen object, or Screen ID.
 	 * @param string                      $object_name Object name (for post types and taxonomies).
 	 * @param array                       $args        Optional. Screen arguments. Default empty array.
 	 */
@@ -498,7 +498,7 @@ 
 	 * @access public
 	 *
 	 * @param string                       $object_type Object type.
-	 * @param WP_Fields_API_Section|string $id          Field Section object, or Section ID.
+	 * @param string $id          Field Section object, or Section ID.
 	 * @param string                       $object_name Object name (for post types and taxonomies).
 	 * @param array                        $args        Section arguments.
 	 */
@@ -730,7 +730,7 @@ 
 	 * @access public
 	 *
 	 * @param string                     $object_type Object type.
-	 * @param WP_Fields_API_Field|string $id          Fields API Field object, or ID.
+	 * @param string $id          Fields API Field object, or ID.
 	 * @param string                     $object_name Object name (for post types and taxonomies).
 	 * @param array                      $args        Field arguments; passed to WP_Fields_API_Field
 	 *                                                constructor.
@@ -908,7 +908,6 @@ 
 	 * @see    WP_Fields_API_Field
 	 *
 	 * @param string $type         Field type ID.
-	 * @param string $screen_class Name of a custom field type which is a subclass of WP_Fields_API_Field.
 	 */
 	public function register_field_type( $type, $field_class = null ) {
 

tests/test-wp-fields-api.php

Doc Comments -1 removed lines

@@ -124,7 +124,6 @@
 	 * Test WP_Fields_API::add_screen()
 	 *
 	 * @param string $object_type
-	 * @param string $object_name
 	 */
 	public function test_add_screen_invalid( $object_type = 'post' ) {