sc0ttkclark / wordpress-fields-api

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

Indentation +7 added lines, -7 removed lines

@@ -1,12 +1,12 @@
 <?php
 /**
- * Fields API Field Class
- *
- * Handles saving and sanitizing of fields.
- *
- * @package    WordPress
- * @subpackage Fields_API
- */
+	 * Fields API Field Class
+	 *
+	 * Handles saving and sanitizing of fields.
+	 *
+	 * @package    WordPress
+	 * @subpackage Fields_API
+	 */
 class WP_Fields_API_Field {
 
 	/**

Doc Comments +3 added lines, -7 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 ) {
 
@@ -325,7 +322,6 @@ 
 	/**
 	 * Fetch the value of the field.
 	 *
-	 * @param int $item_id (optional) The Item ID.
 	 *
 	 * @return mixed The value.
 	 */
@@ -582,7 +578,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.
 	 */

Spacing +107 added lines, -107 removed lines

@@ -74,7 +74,7 @@ 
 
 		$args = func_get_args();
 
-		call_user_func_array( array( $this, 'init' ), $args );
+		call_user_func_array(array($this, 'init'), $args);
 
 	}
 
@@ -88,11 +88,11 @@ 
 	 *
 	 * @return WP_Fields_API_Field $field
 	 */
-	public function init( $object_type, $id, $args = array() ) {
+	public function init($object_type, $id, $args = array()) {
 
 		$this->object_type = $object_type;
 
-		if ( is_array( $id ) ) {
+		if (is_array($id)) {
 			$args = $id;
 
 			$id = '';
@@ -100,31 +100,31 @@ 
 			$this->id = $id;
 		}
 
-		$keys = array_keys( get_object_vars( $this ) );
+		$keys = array_keys(get_object_vars($this));
 
-		foreach ( $keys as $key ) {
-			if ( isset( $args[ $key ] ) ) {
-				$this->$key = $args[ $key ];
+		foreach ($keys as $key) {
+			if (isset($args[$key])) {
+				$this->$key = $args[$key];
 			}
 		}
 
 		// Parse the ID for array keys.
-		$this->id_data['keys'] = preg_split( '/\[/', str_replace( ']', '', $this->id ) );
-		$this->id_data['base'] = array_shift( $this->id_data['keys'] );
+		$this->id_data['keys'] = preg_split('/\[/', str_replace(']', '', $this->id));
+		$this->id_data['base'] = array_shift($this->id_data['keys']);
 
 		// Rebuild the ID.
 		$this->id = $this->id_data['base'];
 
-		if ( ! empty( $this->id_data['keys'] ) ) {
-			$this->id .= '[' . implode( '][', $this->id_data['keys'] ) . ']';
+		if ( ! empty($this->id_data['keys'])) {
+			$this->id .= '['.implode('][', $this->id_data['keys']).']';
 		}
 
-		if ( $this->sanitize_callback ) {
-			add_filter( "fields_sanitize_{$this->object_type}_{$this->object_name}_{$this->id}", $this->sanitize_callback, 10, 2 );
+		if ($this->sanitize_callback) {
+			add_filter("fields_sanitize_{$this->object_type}_{$this->object_name}_{$this->id}", $this->sanitize_callback, 10, 2);
 		}
 
-		if ( $this->sanitize_js_callback ) {
-			add_filter( "fields_sanitize_js_{$this->object_type}_{$this->object_name}_{$this->id}", $this->sanitize_js_callback, 10, 2 );
+		if ($this->sanitize_js_callback) {
+			add_filter("fields_sanitize_js_{$this->object_type}_{$this->object_name}_{$this->id}", $this->sanitize_js_callback, 10, 2);
 		}
 
 	}
@@ -143,7 +143,7 @@ 
 		$value   = func_get_arg(0);
 		$item_id = func_get_arg(1);
 
-		if ( ! $this->check_capabilities() || false === $value ) {
+		if ( ! $this->check_capabilities() || false === $value) {
 			return false;
 		}
 
@@ -157,9 +157,9 @@ 
 		 *
 		 * @param WP_Fields_API_Field $this {@see WP_Fields_API_Field} instance.
 		 */
-		do_action( 'field_save_' . $this->object_type . ' _' . $this->id_data[ 'base' ], $this, $value, $item_id );
+		do_action('field_save_'.$this->object_type.' _'.$this->id_data['base'], $this, $value, $item_id);
 
-		return $this->update( $value, $item_id );
+		return $this->update($value, $item_id);
 
 	}
 
@@ -170,9 +170,9 @@ 
 	 *
 	 * @return mixed Null if an input isn't valid, otherwise the sanitized value.
 	 */
-	public function sanitize( $value ) {
+	public function sanitize($value) {
 
-		$value = wp_unslash( $value );
+		$value = wp_unslash($value);
 
 		/**
 		 * Filter a Customize field value in un-slashed form.
@@ -180,7 +180,7 @@ 
 		 * @param mixed                $value Value of the field.
 		 * @param WP_Fields_API_Field $this  WP_Fields_API_Field instance.
 		 */
-		return apply_filters( "fields_sanitize_{$this->object_type}_{$this->object_name}_{$this->id}", $value, $this );
+		return apply_filters("fields_sanitize_{$this->object_type}_{$this->object_name}_{$this->id}", $value, $this);
 
 	}
 
@@ -192,24 +192,24 @@ 
 	 *
 	 * @return mixed The result of saving the value.
 	 */
-	protected function update( $value ) {
+	protected function update($value) {
 
 		// @todo Support post / term / user / comment object field updates
 
 		$item_id = func_get_arg(1);
 
-		switch ( $this->object_type ) {
+		switch ($this->object_type) {
 			case 'customizer' :
-				return $this->_update_theme_mod( $value );
+				return $this->_update_theme_mod($value);
 
 			case 'settings' :
-				return $this->_update_option( $value );
+				return $this->_update_option($value);
 
 			case 'post' :
 			case 'term' :
 			case 'user' :
 			case 'comment' :
-				return $this->_update_meta( $this->object_type, $value, $item_id );
+				return $this->_update_meta($this->object_type, $value, $item_id);
 
 			default :
 
@@ -223,7 +223,7 @@ 
 				 * @param int                 $item_id Item ID.
 				 * @param WP_Fields_API_Field $this    WP_Fields_API_Field instance.
 				 */
-				do_action( "fields_update_{$this->object_type}", $value, $item_id, $this );
+				do_action("fields_update_{$this->object_type}", $value, $item_id, $this);
 		}
 
 		return null;
@@ -237,22 +237,22 @@ 
 	 *
 	 * @return null
 	 */
-	protected function _update_theme_mod( $value ) {
+	protected function _update_theme_mod($value) {
 
-		if ( is_null( $value ) ) {
-			remove_theme_mod( $this->id_data['base'] );
+		if (is_null($value)) {
+			remove_theme_mod($this->id_data['base']);
 		}
 
 		// Handle non-array theme mod.
-		if ( empty( $this->id_data['keys'] ) ) {
-			set_theme_mod( $this->id_data['base'], $value );
+		if (empty($this->id_data['keys'])) {
+			set_theme_mod($this->id_data['base'], $value);
 		} else {
 			// Handle array-based theme mod.
-			$mods = get_theme_mod( $this->id_data['base'] );
-			$mods = $this->multidimensional_replace( $mods, $this->id_data['keys'], $value );
+			$mods = get_theme_mod($this->id_data['base']);
+			$mods = $this->multidimensional_replace($mods, $this->id_data['keys'], $value);
 
-			if ( isset( $mods ) ) {
-				set_theme_mod( $this->id_data['base'], $mods );
+			if (isset($mods)) {
+				set_theme_mod($this->id_data['base'], $mods);
 			}
 		}
 
@@ -267,23 +267,23 @@ 
 	 *
 	 * @return bool|null The result of saving the value.
 	 */
-	protected function _update_option( $value ) {
+	protected function _update_option($value) {
 
-		if ( is_null( $value ) ) {
-			delete_option( $this->id_data['base'] );
+		if (is_null($value)) {
+			delete_option($this->id_data['base']);
 		}
 
 		// Handle non-array option.
-		if ( empty( $this->id_data['keys'] ) ) {
-			return update_option( $this->id_data['base'], $value );
+		if (empty($this->id_data['keys'])) {
+			return update_option($this->id_data['base'], $value);
 		}
 
 		// Handle array-based options.
-		$options = get_option( $this->id_data['base'] );
-		$options = $this->multidimensional_replace( $options, $this->id_data['keys'], $value );
+		$options = get_option($this->id_data['base']);
+		$options = $this->multidimensional_replace($options, $this->id_data['keys'], $value);
 
-		if ( isset( $options ) ) {
-			return update_option( $this->id_data['base'], $options );
+		if (isset($options)) {
+			return update_option($this->id_data['base'], $options);
 		}
 
 		return null;
@@ -299,23 +299,23 @@ 
 	 *
 	 * @return bool|null The result of saving the value.
 	 */
-	protected function _update_meta( $meta_type, $value, $item_id = 0 ) {
+	protected function _update_meta($meta_type, $value, $item_id = 0) {
 
-		if ( is_null( $value ) ) {
-			delete_metadata( $meta_type, $item_id, $this->id_data['base'] );
+		if (is_null($value)) {
+			delete_metadata($meta_type, $item_id, $this->id_data['base']);
 		}
 
 		// Handle non-array option.
-		if ( empty( $this->id_data['keys'] ) ) {
-			return update_metadata( $meta_type, $item_id, $this->id_data['base'], $value );
+		if (empty($this->id_data['keys'])) {
+			return update_metadata($meta_type, $item_id, $this->id_data['base'], $value);
 		}
 
 		// Handle array-based keys.
-		$keys = get_metadata( $meta_type, 0, $this->id_data['base'] );
-		$keys = $this->multidimensional_replace( $keys, $this->id_data['keys'], $value );
+		$keys = get_metadata($meta_type, 0, $this->id_data['base']);
+		$keys = $this->multidimensional_replace($keys, $this->id_data['keys'], $value);
 
-		if ( isset( $keys ) ) {
-			return update_metadata( $meta_type, $item_id, $this->id_data['base'], $keys );
+		if (isset($keys)) {
+			return update_metadata($meta_type, $item_id, $this->id_data['base'], $keys);
 		}
 
 		return null;
@@ -333,19 +333,19 @@ 
 
 		$item_id = func_get_arg(0);
 
-		switch ( $this->object_type ) {
+		switch ($this->object_type) {
 			case 'post' :
 			case 'term' :
 			case 'user' :
 			case 'comment' :
-				$value = $this->get_object_value( $item_id );
-				$value = $this->multidimensional_get( $value, $this->id_data['keys'], $this->default );
+				$value = $this->get_object_value($item_id);
+				$value = $this->multidimensional_get($value, $this->id_data['keys'], $this->default);
 				break;
 
 			case 'customizer' :
 			case 'settings' :
 				$value = $this->get_option_value();
-				$value = $this->multidimensional_get( $value, $this->id_data['keys'], $this->default );
+				$value = $this->multidimensional_get($value, $this->id_data['keys'], $this->default);
 				break;
 
 			default :
@@ -361,7 +361,7 @@ 
 				 * @param mixed $default The field default value. Default empty.
 				 * @param int   $item_id (optional) The Item ID.
 				 */
-				$value = apply_filters( 'fields_value_' . $this->object_type . '_' . $this->object_name . '_' . $this->id_data['base'], $this->default, $item_id );
+				$value = apply_filters('fields_value_'.$this->object_type.'_'.$this->object_name.'_'.$this->id_data['base'], $this->default, $item_id);
 				break;
 		}
 
@@ -376,37 +376,37 @@ 
 	 *
 	 * @return mixed|null
 	 */
-	public function get_object_value( $item_id ) {
+	public function get_object_value($item_id) {
 
 		$value = null;
 		$object = null;
 
 		$field_key = $this->id_data['base'];
 
-		switch ( $this->object_type ) {
+		switch ($this->object_type) {
 			case 'post' :
-				$object = get_post( $item_id );
+				$object = get_post($item_id);
 				break;
 
 			case 'term' :
-				$object = get_term( $item_id );
+				$object = get_term($item_id);
 				break;
 
 			case 'user' :
-				$object = get_userdata( $item_id );
+				$object = get_userdata($item_id);
 				break;
 
 			case 'comment' :
-				$object = get_comment( $item_id );
+				$object = get_comment($item_id);
 				break;
 		}
 
-		if ( $object && ! is_wp_error( $object ) && isset( $object->{$field_key} ) ) {
+		if ($object && ! is_wp_error($object) && isset($object->{$field_key} )) {
 			// Get value from object
 			$value = $object->{$field_key};
 		} else {
 			// Get value from meta
-			$value = get_metadata( $this->object_type, $item_id, $field_key );
+			$value = get_metadata($this->object_type, $item_id, $field_key);
 		}
 
 		return $value;
@@ -423,7 +423,7 @@ 
 		$function = '';
 		$value = null;
 
-		switch ( $this->object_type ) {
+		switch ($this->object_type) {
 			case 'customizer' :
 				$function = 'get_theme_mod';
 				break;
@@ -433,14 +433,14 @@ 
 				break;
 		}
 
-		if ( is_callable( $function ) ) {
+		if (is_callable($function)) {
 			// Handle non-array value
-			if ( empty( $this->id_data['keys'] ) ) {
-				return $function( $this->id_data['base'], $this->default );
+			if (empty($this->id_data['keys'])) {
+				return $function($this->id_data['base'], $this->default);
 			}
 
 			// Handle array-based value
-			$value = $function( $this->id_data['base'] );
+			$value = $function($this->id_data['base']);
 		}
 
 		return $value;
@@ -464,10 +464,10 @@ 
 		 * @param mixed                $value The field value.
 		 * @param WP_Fields_API_Field $this  {@see WP_Fields_API_Field} instance.
 		 */
-		$value = apply_filters( "fields_sanitize_js_{$this->object_type}_{$this->object_name}_{$this->id}", $value, $this );
+		$value = apply_filters("fields_sanitize_js_{$this->object_type}_{$this->object_name}_{$this->id}", $value, $this);
 
-		if ( is_string( $value ) ) {
-			return html_entity_decode( $value, ENT_QUOTES, 'UTF-8' );
+		if (is_string($value)) {
+			return html_entity_decode($value, ENT_QUOTES, 'UTF-8');
 		}
 
 		return $value;
@@ -481,11 +481,11 @@ 
 	 */
 	public function check_capabilities() {
 
-		if ( $this->capability && ! call_user_func_array( 'current_user_can', (array) $this->capability ) ) {
+		if ($this->capability && ! call_user_func_array('current_user_can', (array) $this->capability)) {
 			return false;
 		}
 
-		if ( $this->theme_supports && ! call_user_func_array( 'current_theme_supports', (array) $this->theme_supports ) ) {
+		if ($this->theme_supports && ! call_user_func_array('current_theme_supports', (array) $this->theme_supports)) {
 			return false;
 		}
 
@@ -502,42 +502,42 @@ 
 	 *
 	 * @return null|array Keys are 'root', 'node', and 'key'.
 	 */
-	final protected function multidimensional( &$root, $keys, $create = false ) {
+	final protected function multidimensional(&$root, $keys, $create = false) {
 
-		if ( $create && empty( $root ) ) {
+		if ($create && empty($root)) {
 			$root = array();
 		}
 
-		if ( ! isset( $root ) || empty( $keys ) ) {
+		if ( ! isset($root) || empty($keys)) {
 			return null;
 		}
 
-		$last = array_pop( $keys );
+		$last = array_pop($keys);
 		$node = &$root;
 
-		foreach ( $keys as $key ) {
-			if ( $create && ! isset( $node[ $key ] ) ) {
-				$node[ $key ] = array();
+		foreach ($keys as $key) {
+			if ($create && ! isset($node[$key])) {
+				$node[$key] = array();
 			}
 
-			if ( ! is_array( $node ) || ! isset( $node[ $key ] ) ) {
+			if ( ! is_array($node) || ! isset($node[$key])) {
 				return null;
 			}
 
-			$node = &$node[ $key ];
+			$node = &$node[$key];
 		}
 
-		if ( $create ) {
-			if ( ! is_array( $node ) ) {
+		if ($create) {
+			if ( ! is_array($node)) {
 				// account for an array overriding a string or object value
 				$node = array();
 			}
-			if ( ! isset( $node[ $last ] ) ) {
-				$node[ $last ] = array();
+			if ( ! isset($node[$last])) {
+				$node[$last] = array();
 			}
 		}
 
-		if ( ! isset( $node[ $last ] ) ) {
+		if ( ! isset($node[$last])) {
 			return null;
 		}
 
@@ -558,19 +558,19 @@ 
 	 *
 	 * @return
 	 */
-	final protected function multidimensional_replace( $root, $keys, $value ) {
+	final protected function multidimensional_replace($root, $keys, $value) {
 
-		if ( ! isset( $value ) ) {
+		if ( ! isset($value)) {
 			return $root;
-		} elseif ( empty( $keys ) ) {
+		} elseif (empty($keys)) {
 			// If there are no keys, we're replacing the root.
 			return $value;
 		}
 
-		$result = $this->multidimensional( $root, $keys, true );
+		$result = $this->multidimensional($root, $keys, true);
 
-		if ( isset( $result ) ) {
-			$result['node'][ $result['key'] ] = $value;
+		if (isset($result)) {
+			$result['node'][$result['key']] = $value;
 		}
 
 		return $root;
@@ -586,18 +586,18 @@ 
 	 *
 	 * @return mixed The requested value or the default value.
 	 */
-	final protected function multidimensional_get( $root, $keys, $default = null ) {
+	final protected function multidimensional_get($root, $keys, $default = null) {
 
 		// If there are no keys, test the root.
-		if ( empty( $keys ) ) {
-			if ( isset( $root ) ) {
+		if (empty($keys)) {
+			if (isset($root)) {
 				return $root;
 			}
 		} else {
-			$result = $this->multidimensional( $root, $keys );
+			$result = $this->multidimensional($root, $keys);
 
-			if ( isset( $result ) ) {
-				return $result['node'][ $result['key'] ];
+			if (isset($result)) {
+				return $result['node'][$result['key']];
 			}
 		}
 
@@ -613,11 +613,11 @@ 
 	 *
 	 * @return bool True if value is set, false if not.
 	 */
-	final protected function multidimensional_isset( $root, $keys ) {
+	final protected function multidimensional_isset($root, $keys) {
 
-		$result = $this->multidimensional_get( $root, $keys );
+		$result = $this->multidimensional_get($root, $keys);
 
-		return isset( $result );
+		return isset($result);
 
 	}
 }
@@ -639,7 +639,7 @@ 
 	 *
 	 * @return mixed The result of saving the value.
 	 */
-	public function update( $value ) {
+	public function update($value) {
 
 		return null;