gravityview / GravityView

includes/class-admin-approve-entries.php

Doc Comments +1 added lines, -1 removed lines

@@ -278,7 +278,7 @@
 	 * Capture bulk actions - gf_entries table
 	 *
 	 * @uses  GravityView_frontend::get_search_criteria() Convert the $_POST search request into a properly formatted request.
-	 * @return void|boolean
+	 * @return false|null
 	 */
 	public function process_bulk_action() {
 

includes/class-api.php

Doc Comments +4 added lines, -1 removed lines

@@ -232,7 +232,6 @@ 
 	 * @deprecated Use \GV\Field_Template::render() or the more low-level \GV\Field::get_value()
 	 *
 	 * @param array $entry
-	 * @param array $field
 	 * @return null|string
 	 */
 	public static function field_value( $entry, $field_settings, $format = 'html' ) {
@@ -851,6 +850,9 @@ 
 	return $value;
 }
 
+/**
+ * @param GV\Template_Context $context
+ */
 function gv_directory_link( $post = NULL, $add_pagination = true, $context = null ) {
 	return GravityView_API::directory_link( $post, $add_pagination, $context );
 }
@@ -1359,6 +1361,7 @@ 
  * @param  array $passed_args Associative array with field data. `field` and `form` are required.
  * @since  2.0
  * @param  \GV\Template_Context The template context.
+ * @param GV\Template_Context $context
  * @return string Field output. If empty value and hide empty is true, return empty.
  */
 function gravityview_field_output( $passed_args, $context = null ) {

includes/class-common.php

Doc Comments +5 added lines, -5 removed lines

@@ -281,7 +281,7 @@ 
 	/**
 	 * Return array of fields' id and label, for a given Form ID
 	 *
-	 * @param string|array $form_id (default: '') or $form object
+	 * @param string|array $form (default: '') or $form object
 	 * @param bool $add_default_properties
 	 * @param bool $include_parent_field
 	 * @return array
@@ -1034,7 +1034,7 @@ 
 	 *
 	 * @param array $form Gravity Forms form array
 	 * @param string $field_id ID of the field. If an input, full input ID (like `1.3`)
-	 * @param string|array $field_value Raw value of the field.
+	 * @param string $field_value Raw value of the field.
 	 * @return string
 	 */
 	public static function get_field_label( $form = array(), $field_id = '', $field_value = '' ) {
@@ -1555,7 +1555,7 @@ 
 	 *
 	 * Do the same than parse_str without max_input_vars limitation:
 	 * Parses $string as if it were the query string passed via a URL and sets variables in the current scope.
-	 * @param $string string string to parse (not altered like in the original parse_str(), use the second parameter!)
+	 * @param string $string string string to parse (not altered like in the original parse_str(), use the second parameter!)
 	 * @param $result array  If the second parameter is present, variables are stored in this variable as array elements
 	 * @return bool true or false if $string is an empty string
 	 * @since  1.5.3
@@ -1791,9 +1791,9 @@ 
 	 * @param string $message            Message body (required)
 	 * @param string $from_name          Displayed name of the sender
 	 * @param string $message_format     If "html", sent text as `text/html`. Otherwise, `text/plain`. Default: "html".
-	 * @param string|array $attachments  Optional. Files to attach. {@see wp_mail()} for usage. Default: "".
+	 * @param string $attachments  Optional. Files to attach. {@see wp_mail()} for usage. Default: "".
 	 * @param array|false $entry         Gravity Forms entry array, related to the email. Default: false.
-	 * @param array|false $notification  Gravity Forms notification that triggered the email. {@see GFCommon::send_notification}. Default:false.
+	 * @param boolean $notification  Gravity Forms notification that triggered the email. {@see GFCommon::send_notification}. Default:false.
 	 */
 	public static function send_email( $from, $to, $bcc, $reply_to, $subject, $message, $from_name = '', $message_format = 'html', $attachments = '', $entry = false, $notification = false ) {
 

includes/class-frontend-views.php

Doc Comments +3 added lines, -4 removed lines

@@ -227,7 +227,7 @@ 
 	 *
 	 *
 	 *
-	 * @param null $view_id
+	 * @param string $view_id
 	 */
 	public function set_context_view_id( $view_id = null ) {
 		$multiple_views = $this->getGvOutputData() && $this->getGvOutputData()->has_multiple_views();
@@ -922,7 +922,7 @@ 
 	 *
 	 *
 	 * @uses  gravityview_get_entries()
-	 * @param array $args\n
+	 * @param array $args
 	 *   - $id - View id
 	 *   - $page_size - Page
 	 *   - $sort_field - form field id to sort
@@ -1051,7 +1051,6 @@ 
 	 * @since 1.19.5
 	 *
 	 * @param $args
-	 * @param int $form_id
 	 */
 	public static function get_search_criteria_paging( $args ) {
 
@@ -1553,7 +1552,7 @@ 
 	/**
 	 * Checks if field (column) is sortable
 	 *
-	 * @param string $field Field settings
+	 * @param string $field_id Field settings
 	 * @param array $form Gravity Forms form array
 	 *
 	 * @since 1.7

includes/connector-functions.php

Doc Comments +1 added lines, -2 removed lines

@@ -58,7 +58,7 @@ 
  * Return array of fields' id and label, for a given Form ID
  *
  * @see GVCommon::get_form_fields()
- * @param string|array $form_id (default: '') or $form object
+ * @param string|array $form (default: '') or $form object
  * @return array
  */
 function gravityview_get_form_fields( $form = '', $add_default_properties = false, $include_parent_field = true ) {
@@ -216,7 +216,6 @@ 
  *
  * @see GravityView_Template::template_id
  *
- * @param int $view_id The ID of the View to get the layout of
  *
  * @return string GravityView_Template::template_id value. Empty string if not.
  */

includes/extensions/edit-entry/class-edit-entry-user-registration.php

Indentation +257 added lines, -257 removed lines

@@ -11,7 +11,7 @@ 
  */
 
 if ( ! defined( 'WPINC' ) ) {
-    die;
+	die;
 }
 
 /**
@@ -22,103 +22,103 @@ 
 	/**
 	 * @var GravityView_Edit_Entry $loader
 	 */
-    protected $loader;
+	protected $loader;
 
-    /**
-     * @var WP_User|null Temporary storage used by restore_user_details()
-     */
-    private $_user_before_update = null;
+	/**
+	 * @var WP_User|null Temporary storage used by restore_user_details()
+	 */
+	private $_user_before_update = null;
 
-    function __construct( GravityView_Edit_Entry $loader ) {
-        $this->loader = $loader;
-    }
+	function __construct( GravityView_Edit_Entry $loader ) {
+		$this->loader = $loader;
+	}
 
 	/**
 	 * @since 1.11
 	 */
 	public function load() {
 		add_action( 'wp', array( $this, 'add_hooks' ), 10 );
-    }
+	}
 
 	/**
 	 * Add hooks to trigger updating the user
 	 *
 	 * @since 1.18
 	 */
-    public function add_hooks() {
-
-	    /**
-	     * @filter `gravityview/edit_entry/user_registration/trigger_update` Choose whether to update user information via User Registration add-on when an entry is updated?
-	     * @since 1.11
-	     * @param boolean $boolean Whether to trigger update on user registration (default: true)
-	     */
-	    if( apply_filters( 'gravityview/edit_entry/user_registration/trigger_update', true ) ) {
-
-	    	add_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10, 2 );
-
-		    // last resort in case the current user display name don't match any of the defaults
-		    add_action( 'gform_user_updated', array( $this, 'restore_display_name' ), 10, 4 );
-	    }
-    }
-
-    /**
-     * Update the WordPress user profile based on the GF User Registration create feed
-     *
-     * @since 1.11
-     *
-     * @param array $form Gravity Forms form array
-     * @param string $entry_id Gravity Forms entry ID
-     * @return void
-     */
-    public function update_user( $form = array(), $entry_id = 0 ) {
-
-        if( ! class_exists( 'GFAPI' ) || ! class_exists( 'GF_User_Registration' ) ) {
-	        gravityview()->log->error( 'GFAPI or User Registration class not found; not updating the user' );
-	        return;
-        } elseif( empty( $entry_id ) ) {
-        	gravityview()->log->error( 'Entry ID is empty [{entry_id}]; not updating the user', array( 'entry_id' => $entry_id ) );
-	        return;
-        }
-
-        $gf_user_registration = GF_User_Registration::get_instance();
-
-        $entry = GFAPI::get_entry( $entry_id );
-
-	    /**
-	     * @filter `gravityview/edit_entry/user_registration/entry` Modify entry details before updating the user via User Registration add-on
-	     * @since 1.11
-	     * @param array $entry Gravity Forms entry
-	     * @param array $form Gravity Forms form
-	     */
-        $entry = apply_filters( 'gravityview/edit_entry/user_registration/entry', $entry, $form );
-
-	    $config = $this->get_feed_configuration( $entry, $form );
-
-        // Make sure the feed is active
-	    if ( ! \GV\Utils::get( $config, 'is_active', false ) ) {
+	public function add_hooks() {
+
+		/**
+		 * @filter `gravityview/edit_entry/user_registration/trigger_update` Choose whether to update user information via User Registration add-on when an entry is updated?
+		 * @since 1.11
+		 * @param boolean $boolean Whether to trigger update on user registration (default: true)
+		 */
+		if( apply_filters( 'gravityview/edit_entry/user_registration/trigger_update', true ) ) {
+
+			add_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10, 2 );
+
+			// last resort in case the current user display name don't match any of the defaults
+			add_action( 'gform_user_updated', array( $this, 'restore_display_name' ), 10, 4 );
+		}
+	}
+
+	/**
+	 * Update the WordPress user profile based on the GF User Registration create feed
+	 *
+	 * @since 1.11
+	 *
+	 * @param array $form Gravity Forms form array
+	 * @param string $entry_id Gravity Forms entry ID
+	 * @return void
+	 */
+	public function update_user( $form = array(), $entry_id = 0 ) {
+
+		if( ! class_exists( 'GFAPI' ) || ! class_exists( 'GF_User_Registration' ) ) {
+			gravityview()->log->error( 'GFAPI or User Registration class not found; not updating the user' );
 			return;
-	    }
+		} elseif( empty( $entry_id ) ) {
+			gravityview()->log->error( 'Entry ID is empty [{entry_id}]; not updating the user', array( 'entry_id' => $entry_id ) );
+			return;
+		}
+
+		$gf_user_registration = GF_User_Registration::get_instance();
+
+		$entry = GFAPI::get_entry( $entry_id );
 
-	    // If an Update feed, make sure the conditions are met.
-	    if ( \GV\Utils::get( $config, 'meta/feedType' ) === 'update' ) {
-	    	if( ! $gf_user_registration->is_feed_condition_met( $config, $form, $entry ) ) {
-			    return;
-		    }
-	    }
+		/**
+		 * @filter `gravityview/edit_entry/user_registration/entry` Modify entry details before updating the user via User Registration add-on
+		 * @since 1.11
+		 * @param array $entry Gravity Forms entry
+		 * @param array $form Gravity Forms form
+		 */
+		$entry = apply_filters( 'gravityview/edit_entry/user_registration/entry', $entry, $form );
+
+		$config = $this->get_feed_configuration( $entry, $form );
+
+		// Make sure the feed is active
+		if ( ! \GV\Utils::get( $config, 'is_active', false ) ) {
+			return;
+		}
 
-        // The priority is set to 3 so that default priority (10) will still override it
-        add_filter( 'send_password_change_email', '__return_false', 3 );
-        add_filter( 'send_email_change_email', '__return_false', 3 );
+		// If an Update feed, make sure the conditions are met.
+		if ( \GV\Utils::get( $config, 'meta/feedType' ) === 'update' ) {
+			if( ! $gf_user_registration->is_feed_condition_met( $config, $form, $entry ) ) {
+				return;
+			}
+		}
 
-        // Trigger the User Registration update user method
-        $gf_user_registration->update_user( $entry, $form, $config );
+		// The priority is set to 3 so that default priority (10) will still override it
+		add_filter( 'send_password_change_email', '__return_false', 3 );
+		add_filter( 'send_email_change_email', '__return_false', 3 );
 
-        remove_filter( 'send_password_change_email', '__return_false', 3 );
-        remove_filter( 'send_email_change_email', '__return_false', 3 );
+		// Trigger the User Registration update user method
+		$gf_user_registration->update_user( $entry, $form, $config );
 
-        // Prevent double-triggering by removing the hook
-	    remove_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10 );
-    }
+		remove_filter( 'send_password_change_email', '__return_false', 3 );
+		remove_filter( 'send_email_change_email', '__return_false', 3 );
+
+		// Prevent double-triggering by removing the hook
+		remove_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10 );
+	}
 
 	/**
 	 * Get the User Registration feed configuration for the entry & form
@@ -133,184 +133,184 @@ 
 	 *
 	 * @return array
 	 */
-    public function get_feed_configuration( $entry, $form ) {
-
-	    $gf_user_registration = GF_User_Registration::get_instance();
-
-	    $config = $gf_user_registration->get_single_submission_feed( $entry, $form );
-
-	    /**
-	     * @filter `gravityview/edit_entry/user_registration/preserve_role` Keep the current user role or override with the role defined in the Create feed
-	     * @since 1.15
-	     * @param[in,out] boolean $preserve_role Preserve current user role Default: true
-	     * @param[in] array $config Gravity Forms User Registration feed configuration for the form
-	     * @param[in] array $form Gravity Forms form array
-	     * @param[in] array $entry Gravity Forms entry being edited
-	     */
-	    $preserve_role = apply_filters( 'gravityview/edit_entry/user_registration/preserve_role', true, $config, $form, $entry );
-
-	    if( $preserve_role ) {
-		    $config['meta']['role'] = 'gfur_preserve_role';
-	    }
-
-	    $displayname = $this->match_current_display_name( $entry['created_by'] );
-
-	    /**
-	     * Make sure the current display name is not changed with the update user method.
-	     * @since 1.15
-	     */
-	    $config['meta']['displayname'] = $displayname ? $displayname : $config['meta']['displayname'];
-
-	    /**
-	     * @filter `gravityview/edit_entry/user_registration/config` Modify the User Registration Addon feed configuration
-	     * @since 1.14
-	     * @param[in,out] array $config Gravity Forms User Registration feed configuration for the form
-	     * @param[in] array $form Gravity Forms form array
-	     * @param[in] array $entry Gravity Forms entry being edited
-	     */
-	    $config = apply_filters( 'gravityview/edit_entry/user_registration/config', $config, $form, $entry );
-
-	    return $config;
-    }
-
-    /**
-     * Calculate the user display name format
-     *
-     * @since 1.15
-     * @since 1.20 Returns false if user not found at $user_id
-     *
-     * @param int $user_id WP User ID
-     * @return false|string Display name format as used inside Gravity Forms User Registration. Returns false if user not found.
-     */
-    public function match_current_display_name( $user_id ) {
-
-        $user = get_userdata( $user_id );
-
-        if( ! $user ) {
-        	return false;
-        }
-
-        $names = $this->generate_display_names( $user );
-
-        $format = array_search( $user->display_name, $names, true );
-
-        /**
-         * In case we can't find the current display name format, trigger last resort method at the 'gform_user_updated' hook
-         * @see restore_display_name
-         */
-        if( false === $format ) {
-            $this->_user_before_update = $user;
-        }
-
-        return $format;
-    }
-
-    /**
-     * Generate an array of all the user display names possibilities
-     *
-     * @since 1.15
-     *
-     * @param object $profileuser WP_User object
-     * @return array List all the possible display names for a certain User object
-     */
-    public function generate_display_names( $profileuser ) {
-
-        $public_display = array();
-        $public_display['nickname']  = $profileuser->nickname;
-        $public_display['username']  = $profileuser->user_login;
-
-        if ( !empty($profileuser->first_name) ) {
-	        $public_display['firstname'] = $profileuser->first_name;
-        }
-
-        if ( !empty($profileuser->last_name) ) {
-	        $public_display['lastname'] = $profileuser->last_name;
-        }
-
-        if ( !empty($profileuser->first_name) && !empty($profileuser->last_name) ) {
-            $public_display['firstlast'] = $profileuser->first_name . ' ' . $profileuser->last_name;
-            $public_display['lastfirst'] = $profileuser->last_name . ' ' . $profileuser->first_name;
-        }
-
-        $public_display = array_map( 'trim', $public_display );
-        $public_display = array_unique( $public_display );
-
-        return $public_display;
-    }
-
-
-    /**
-     * Restore the Display Name and roles of a user after being updated by Gravity Forms User Registration Addon
-     *
-     * @see GFUser::update_user()
-     * @param int $user_id WP User ID that was updated by Gravity Forms User Registration Addon
-     * @param array $config Gravity Forms User Registration Addon form feed configuration
-     * @param array $entry The Gravity Forms entry that was just updated
-     * @param string $password User password
-     * @return int|false|WP_Error|null True: User updated; False: $user_id not a valid User ID; WP_Error: User update error; Null: Method didn't process
-     */
-    public function restore_display_name( $user_id = 0, $config = array(), $entry = array(), $password = '' ) {
-
-        /**
-         * @filter `gravityview/edit_entry/restore_display_name` Whether display names should be restored to before updating an entry.
-         * Otherwise, display names will be reset to the format specified in Gravity Forms User Registration "Update" feed
-         * @since 1.14.4
-         * @param boolean $restore_display_name Restore Display Name? Default: true
-         */
-        $restore_display_name = apply_filters( 'gravityview/edit_entry/restore_display_name', true );
-
-        $is_update_feed = ( $config && \GV\Utils::get( $config, 'meta/feed_type' ) === 'update' );
-
-        /**
-         * Don't restore display name:
-         *   - either disabled,
-         *   - or it is an Update feed (we only care about Create feed)
-         *   - or we don't need as we found the correct format before updating user.
-         * @since 1.14.4
-         */
-        if( ! $restore_display_name || $is_update_feed || is_null( $this->_user_before_update ) ) {
-            return null;
-        }
-
-        $user_after_update = get_userdata( $user_id );
-
-        // User not found
-	    if ( ! $user_after_update ) {
-	    	gravityview()->log->error( 'User not found at $user_id #{user_id}', array( 'user_id' => $user_id ) );
-		    return false;
-	    }
-
-        $restored_user = $user_after_update;
-
-	    // Restore previous display_name
-        $restored_user->display_name = $this->_user_before_update->display_name;
-
-	    // Don't have WP update the password.
-	    unset( $restored_user->data->user_pass, $restored_user->user_pass );
-
-        /**
-         * Modify the user data after updated by Gravity Forms User Registration but before restored by GravityView
-         * @since 1.14
-         * @param WP_User $restored_user The user with restored details about to be updated by wp_update_user()
-         * @param WP_User $user_before_update The user before being updated by Gravity Forms User Registration
-         * @param WP_User $user_after_update The user after being updated by Gravity Forms User Registration
-         * @param array   $entry The Gravity Forms entry that was just updated
-         */
-        $restored_user = apply_filters( 'gravityview/edit_entry/user_registration/restored_user', $restored_user, $this->_user_before_update, $user_after_update, $entry );
-
-        $updated = wp_update_user( $restored_user );
-
-        if( is_wp_error( $updated ) ) {
-            gravityview()->log->error( 'There was an error updating user #{user_id} details', array( 'user_id' => $user_id, 'data' => $updated ) );
-        } else {
-            gravityview()->log->debug( 'User #{user_id} details restored', array( 'user_id' => $user_id ) );
-        }
-
-        $this->_user_before_update = null;
-
-        unset( $restored_user, $user_after_update );
-
-        return $updated;
-    }
+	public function get_feed_configuration( $entry, $form ) {
+
+		$gf_user_registration = GF_User_Registration::get_instance();
+
+		$config = $gf_user_registration->get_single_submission_feed( $entry, $form );
+
+		/**
+		 * @filter `gravityview/edit_entry/user_registration/preserve_role` Keep the current user role or override with the role defined in the Create feed
+		 * @since 1.15
+		 * @param[in,out] boolean $preserve_role Preserve current user role Default: true
+		 * @param[in] array $config Gravity Forms User Registration feed configuration for the form
+		 * @param[in] array $form Gravity Forms form array
+		 * @param[in] array $entry Gravity Forms entry being edited
+		 */
+		$preserve_role = apply_filters( 'gravityview/edit_entry/user_registration/preserve_role', true, $config, $form, $entry );
+
+		if( $preserve_role ) {
+			$config['meta']['role'] = 'gfur_preserve_role';
+		}
+
+		$displayname = $this->match_current_display_name( $entry['created_by'] );
+
+		/**
+		 * Make sure the current display name is not changed with the update user method.
+		 * @since 1.15
+		 */
+		$config['meta']['displayname'] = $displayname ? $displayname : $config['meta']['displayname'];
+
+		/**
+		 * @filter `gravityview/edit_entry/user_registration/config` Modify the User Registration Addon feed configuration
+		 * @since 1.14
+		 * @param[in,out] array $config Gravity Forms User Registration feed configuration for the form
+		 * @param[in] array $form Gravity Forms form array
+		 * @param[in] array $entry Gravity Forms entry being edited
+		 */
+		$config = apply_filters( 'gravityview/edit_entry/user_registration/config', $config, $form, $entry );
+
+		return $config;
+	}
+
+	/**
+	 * Calculate the user display name format
+	 *
+	 * @since 1.15
+	 * @since 1.20 Returns false if user not found at $user_id
+	 *
+	 * @param int $user_id WP User ID
+	 * @return false|string Display name format as used inside Gravity Forms User Registration. Returns false if user not found.
+	 */
+	public function match_current_display_name( $user_id ) {
+
+		$user = get_userdata( $user_id );
+
+		if( ! $user ) {
+			return false;
+		}
+
+		$names = $this->generate_display_names( $user );
+
+		$format = array_search( $user->display_name, $names, true );
+
+		/**
+		 * In case we can't find the current display name format, trigger last resort method at the 'gform_user_updated' hook
+		 * @see restore_display_name
+		 */
+		if( false === $format ) {
+			$this->_user_before_update = $user;
+		}
+
+		return $format;
+	}
+
+	/**
+	 * Generate an array of all the user display names possibilities
+	 *
+	 * @since 1.15
+	 *
+	 * @param object $profileuser WP_User object
+	 * @return array List all the possible display names for a certain User object
+	 */
+	public function generate_display_names( $profileuser ) {
+
+		$public_display = array();
+		$public_display['nickname']  = $profileuser->nickname;
+		$public_display['username']  = $profileuser->user_login;
+
+		if ( !empty($profileuser->first_name) ) {
+			$public_display['firstname'] = $profileuser->first_name;
+		}
+
+		if ( !empty($profileuser->last_name) ) {
+			$public_display['lastname'] = $profileuser->last_name;
+		}
+
+		if ( !empty($profileuser->first_name) && !empty($profileuser->last_name) ) {
+			$public_display['firstlast'] = $profileuser->first_name . ' ' . $profileuser->last_name;
+			$public_display['lastfirst'] = $profileuser->last_name . ' ' . $profileuser->first_name;
+		}
+
+		$public_display = array_map( 'trim', $public_display );
+		$public_display = array_unique( $public_display );
+
+		return $public_display;
+	}
+
+
+	/**
+	 * Restore the Display Name and roles of a user after being updated by Gravity Forms User Registration Addon
+	 *
+	 * @see GFUser::update_user()
+	 * @param int $user_id WP User ID that was updated by Gravity Forms User Registration Addon
+	 * @param array $config Gravity Forms User Registration Addon form feed configuration
+	 * @param array $entry The Gravity Forms entry that was just updated
+	 * @param string $password User password
+	 * @return int|false|WP_Error|null True: User updated; False: $user_id not a valid User ID; WP_Error: User update error; Null: Method didn't process
+	 */
+	public function restore_display_name( $user_id = 0, $config = array(), $entry = array(), $password = '' ) {
+
+		/**
+		 * @filter `gravityview/edit_entry/restore_display_name` Whether display names should be restored to before updating an entry.
+		 * Otherwise, display names will be reset to the format specified in Gravity Forms User Registration "Update" feed
+		 * @since 1.14.4
+		 * @param boolean $restore_display_name Restore Display Name? Default: true
+		 */
+		$restore_display_name = apply_filters( 'gravityview/edit_entry/restore_display_name', true );
+
+		$is_update_feed = ( $config && \GV\Utils::get( $config, 'meta/feed_type' ) === 'update' );
+
+		/**
+		 * Don't restore display name:
+		 *   - either disabled,
+		 *   - or it is an Update feed (we only care about Create feed)
+		 *   - or we don't need as we found the correct format before updating user.
+		 * @since 1.14.4
+		 */
+		if( ! $restore_display_name || $is_update_feed || is_null( $this->_user_before_update ) ) {
+			return null;
+		}
+
+		$user_after_update = get_userdata( $user_id );
+
+		// User not found
+		if ( ! $user_after_update ) {
+			gravityview()->log->error( 'User not found at $user_id #{user_id}', array( 'user_id' => $user_id ) );
+			return false;
+		}
+
+		$restored_user = $user_after_update;
+
+		// Restore previous display_name
+		$restored_user->display_name = $this->_user_before_update->display_name;
+
+		// Don't have WP update the password.
+		unset( $restored_user->data->user_pass, $restored_user->user_pass );
+
+		/**
+		 * Modify the user data after updated by Gravity Forms User Registration but before restored by GravityView
+		 * @since 1.14
+		 * @param WP_User $restored_user The user with restored details about to be updated by wp_update_user()
+		 * @param WP_User $user_before_update The user before being updated by Gravity Forms User Registration
+		 * @param WP_User $user_after_update The user after being updated by Gravity Forms User Registration
+		 * @param array   $entry The Gravity Forms entry that was just updated
+		 */
+		$restored_user = apply_filters( 'gravityview/edit_entry/user_registration/restored_user', $restored_user, $this->_user_before_update, $user_after_update, $entry );
+
+		$updated = wp_update_user( $restored_user );
+
+		if( is_wp_error( $updated ) ) {
+			gravityview()->log->error( 'There was an error updating user #{user_id} details', array( 'user_id' => $user_id, 'data' => $updated ) );
+		} else {
+			gravityview()->log->debug( 'User #{user_id} details restored', array( 'user_id' => $user_id ) );
+		}
+
+		$this->_user_before_update = null;
+
+		unset( $restored_user, $user_after_update );
+
+		return $updated;
+	}
 
 } //end class

includes/extensions/edit-entry/class-edit-entry-render.php

Indentation +300 added lines, -300 removed lines

@@ -102,10 +102,10 @@ 
 
 	/**
 	 * ID of the current post. May also be ID of the current View.
-     *
-     * @since 2.0.13
 	 *
-     * @var int
+	 * @since 2.0.13
+	 *
+	 * @var int
 	 */
 	public $post_id;
 
@@ -189,7 +189,7 @@ 
 	 */
 	public function prevent_maybe_process_form() {
 
-	    if( ! $this->is_edit_entry_submission() ) {
+		if( ! $this->is_edit_entry_submission() ) {
 			return;
 		}
 
@@ -228,14 +228,14 @@ 
 	 * When Edit entry view is requested setup the vars
 	 */
 	private function setup_vars() {
-        global $post;
+		global $post;
 
 		$gravityview_view = GravityView_View::getInstance();
 
 
 		$entries = $gravityview_view->getEntries();
-	    self::$original_entry = $entries[0];
-	    $this->entry = $entries[0];
+		self::$original_entry = $entries[0];
+		$this->entry = $entries[0];
 
 		self::$original_form = GFAPI::get_form( $this->entry['form_id'] );
 		$this->form = $gravityview_view->getForm();
@@ -377,8 +377,8 @@ 
 
 			GFFormsModel::save_lead( $form, $this->entry );
 
-	        // Delete the values for hidden inputs
-	        $this->unset_hidden_field_values();
+			// Delete the values for hidden inputs
+			$this->unset_hidden_field_values();
 
 			$this->entry['date_created'] = $date_created;
 
@@ -391,7 +391,7 @@ 
 			// Perform actions normally performed after updating a lead
 			$this->after_update();
 
-	        /**
+			/**
 			 * Must be AFTER after_update()!
 			 * @see https://github.com/gravityview/GravityView/issues/764
 			 */
@@ -399,7 +399,7 @@ 
 
 			/**
 			 * @action `gravityview/edit_entry/after_update` Perform an action after the entry has been updated using Edit Entry
-             * @since 2.1 Added $gv_data parameter
+			 * @since 2.1 Added $gv_data parameter
 			 * @param array $form Gravity Forms form array
 			 * @param string $entry_id Numeric ID of the entry that was updated
 			 * @param GravityView_Edit_Entry_Render $this This object
@@ -423,7 +423,7 @@ 
 	 * @return void
 	 */
 	private function unset_hidden_field_values() {
-	    global $wpdb;
+		global $wpdb;
 
 		/**
 		 * @filter `gravityview/edit_entry/unset_hidden_field_values` Whether to delete values of fields hidden by conditional logic
@@ -447,7 +447,7 @@ 
 			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $lead_detail_table WHERE lead_id=%d", $this->entry['id'] ) );
 		}
 
-	    foreach ( $this->entry as $input_id => $field_value ) {
+		foreach ( $this->entry as $input_id => $field_value ) {
 
 			if ( ! is_numeric( $input_id ) ) {
 				continue;
@@ -457,8 +457,8 @@ 
 				continue;
 			}
 
-		    // Reset fields that are or would be hidden
-		    if ( GFFormsModel::is_field_hidden( $this->form, $field, array(), $this->entry ) ) {
+			// Reset fields that are or would be hidden
+			if ( GFFormsModel::is_field_hidden( $this->form, $field, array(), $this->entry ) ) {
 
 				$empty_value = $field->get_value_save_entry(
 					is_array( $field->get_entry_inputs() ) ? array() : '',
@@ -470,16 +470,16 @@ 
 					$empty_value = '';
 				}
 
-			    $lead_detail_id = GFFormsModel::get_lead_detail_id( $current_fields, $input_id );
+				$lead_detail_id = GFFormsModel::get_lead_detail_id( $current_fields, $input_id );
 
-			    GFFormsModel::update_lead_field_value( $this->form, $this->entry, $field, $lead_detail_id, $input_id, $empty_value );
+				GFFormsModel::update_lead_field_value( $this->form, $this->entry, $field, $lead_detail_id, $input_id, $empty_value );
 
-			    // Prevent the $_POST values of hidden fields from being used as default values when rendering the form
+				// Prevent the $_POST values of hidden fields from being used as default values when rendering the form
 				// after submission
-			    $post_input_id = 'input_' . str_replace( '.', '_', $input_id );
-			    $_POST[ $post_input_id ] = '';
-		    }
-	    }
+				$post_input_id = 'input_' . str_replace( '.', '_', $input_id );
+				$_POST[ $post_input_id ] = '';
+			}
+		}
 	}
 
 	/**
@@ -634,7 +634,7 @@ 
 
 		$form = $this->filter_conditional_logic( $this->form );
 
-	    /** @type GF_Field $field */
+		/** @type GF_Field $field */
 		foreach( $form['fields'] as $k => &$field ) {
 
 			/**
@@ -649,7 +649,7 @@ 
 
 			if( isset( $field->inputs ) && is_array( $field->inputs ) ) {
 				foreach( $field->inputs as $key => $input ) {
-				    $field->inputs[ $key ][ 'id' ] = (string)$input['id'];
+					$field->inputs[ $key ][ 'id' ] = (string)$input['id'];
 				}
 			}
 		}
@@ -689,7 +689,7 @@ 
 
 				$inputs = $field->get_entry_inputs();
 				if ( is_array( $inputs ) ) {
-				    foreach ( $inputs as $input ) {
+					foreach ( $inputs as $input ) {
 						list( $field_id, $input_id ) = rgexplode( '.', $input['id'], 2 );
 
 						if ( 'product' === $field->type ) {
@@ -708,7 +708,7 @@ 
 						}
 
 						GFFormsModel::save_input( $form, $field, $entry, $current_fields, $input['id'] );
-				    }
+					}
 				} else {
 					// Set to what it previously was if it's not editable
 					if ( ! in_array( $field->id, $allowed_fields ) ) {
@@ -754,7 +754,7 @@ 
 			$value = RGFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'] );
 
 			$ary = ! empty( $value ) ? explode( '|:|', $value ) : array();
-	        $ary = stripslashes_deep( $ary );
+			$ary = stripslashes_deep( $ary );
 			$img_url = \GV\Utils::get( $ary, 0 );
 
 			$img_title       = count( $ary ) > 1 ? $ary[1] : '';
@@ -827,7 +827,7 @@ 
 	private function maybe_update_post_fields( $form ) {
 
 		if( empty( $this->entry['post_id'] ) ) {
-	        gravityview()->log->debug( 'This entry has no post fields. Continuing...' );
+			gravityview()->log->debug( 'This entry has no post fields. Continuing...' );
 			return;
 		}
 
@@ -862,49 +862,49 @@ 
 
 				switch( $field->type ) {
 
-				    case 'post_title':
-				        $post_title = $value;
-				        if ( \GV\Utils::get( $form, 'postTitleTemplateEnabled' ) ) {
-				            $post_title = $this->fill_post_template( $form['postTitleTemplate'], $form, $entry_tmp );
-				        }
-				        $updated_post->post_title = $post_title;
-				        $updated_post->post_name  = $post_title;
-				        unset( $post_title );
-				        break;
-
-				    case 'post_content':
-				        $post_content = $value;
-				        if ( \GV\Utils::get( $form, 'postContentTemplateEnabled' ) ) {
-				            $post_content = $this->fill_post_template( $form['postContentTemplate'], $form, $entry_tmp, true );
-				        }
-				        $updated_post->post_content = $post_content;
-				        unset( $post_content );
-				        break;
-				    case 'post_excerpt':
-				        $updated_post->post_excerpt = $value;
-				        break;
-				    case 'post_tags':
-				        wp_set_post_tags( $post_id, $value, false );
-				        break;
-				    case 'post_category':
-				        break;
-				    case 'post_custom_field':
+					case 'post_title':
+						$post_title = $value;
+						if ( \GV\Utils::get( $form, 'postTitleTemplateEnabled' ) ) {
+							$post_title = $this->fill_post_template( $form['postTitleTemplate'], $form, $entry_tmp );
+						}
+						$updated_post->post_title = $post_title;
+						$updated_post->post_name  = $post_title;
+						unset( $post_title );
+						break;
+
+					case 'post_content':
+						$post_content = $value;
+						if ( \GV\Utils::get( $form, 'postContentTemplateEnabled' ) ) {
+							$post_content = $this->fill_post_template( $form['postContentTemplate'], $form, $entry_tmp, true );
+						}
+						$updated_post->post_content = $post_content;
+						unset( $post_content );
+						break;
+					case 'post_excerpt':
+						$updated_post->post_excerpt = $value;
+						break;
+					case 'post_tags':
+						wp_set_post_tags( $post_id, $value, false );
+						break;
+					case 'post_category':
+						break;
+					case 'post_custom_field':
 						if ( is_array( $value ) && ( floatval( $field_id ) !== floatval( $field->id ) ) ) {
 							$value = $value[ $field_id ];
 						}
 
-				        if( ! empty( $field->customFieldTemplateEnabled ) ) {
-				            $value = $this->fill_post_template( $field->customFieldTemplate, $form, $entry_tmp, true );
-				        }
+						if( ! empty( $field->customFieldTemplateEnabled ) ) {
+							$value = $this->fill_post_template( $field->customFieldTemplate, $form, $entry_tmp, true );
+						}
 
 						$value = $field->get_value_save_entry( $value, $form, '', $this->entry['id'], $this->entry );
 
-				        update_post_meta( $post_id, $field->postCustomFieldName, $value );
-				        break;
+						update_post_meta( $post_id, $field->postCustomFieldName, $value );
+						break;
 
-				    case 'post_image':
-				        $value = $this->update_post_image( $form, $field, $field_id, $value, $this->entry, $post_id );
-				        break;
+					case 'post_image':
+						$value = $this->update_post_image( $form, $field, $field_id, $value, $this->entry, $post_id );
+						break;
 
 				}
 
@@ -1074,14 +1074,14 @@ 
 			?><h2 class="gv-edit-entry-title">
 				<span><?php
 
-				    /**
-				     * @filter `gravityview_edit_entry_title` Modify the edit entry title
-				     * @param string $edit_entry_title Modify the "Edit Entry" title
-				     * @param GravityView_Edit_Entry_Render $this This object
-				     */
-				    $edit_entry_title = apply_filters('gravityview_edit_entry_title', __('Edit Entry', 'gravityview'), $this );
+					/**
+					 * @filter `gravityview_edit_entry_title` Modify the edit entry title
+					 * @param string $edit_entry_title Modify the "Edit Entry" title
+					 * @param GravityView_Edit_Entry_Render $this This object
+					 */
+					$edit_entry_title = apply_filters('gravityview_edit_entry_title', __('Edit Entry', 'gravityview'), $this );
 
-				    echo esc_attr( $edit_entry_title );
+					echo esc_attr( $edit_entry_title );
 			?></span>
 			</h2>
 
@@ -1136,13 +1136,13 @@ 
 				);
 
 				/**
-				* @filter `gravityview/edit_entry/button_labels` Modify the cancel/submit buttons' labels
-				* @since 1.16.3
-				* @param array $labels Default button labels associative array
-				* @param array $form The Gravity Forms form
-				* @param array $entry The Gravity Forms entry
-				* @param int $view_id The current View ID
-				*/
+				 * @filter `gravityview/edit_entry/button_labels` Modify the cancel/submit buttons' labels
+				 * @since 1.16.3
+				 * @param array $labels Default button labels associative array
+				 * @param array $form The Gravity Forms form
+				 * @param array $entry The Gravity Forms entry
+				 * @param int $view_id The current View ID
+				 */
 				$labels = apply_filters( 'gravityview/edit_entry/button_labels', $labels, $this->form, $this->entry, $this->view_id );
 
 				$this->is_paged_submitted = \GV\Utils::_POST( 'save' ) === $labels['submit'];
@@ -1179,26 +1179,26 @@ 
 
 				switch ( $edit_redirect ) {
 
-                    case '0':
-	                    $redirect_url = $back_link;
-	                    $entry_updated_message = sprintf( esc_attr_x('Entry Updated. %sReturning to Entry%s', 'Replacements are HTML', 'gravityview'), '<a href="'. esc_url( $redirect_url ) .'">', '</a>' );
-                        break;
-
-                    case '1':
-	                    $redirect_url = $directory_link = GravityView_API::directory_link();
-	                    $entry_updated_message = sprintf( esc_attr_x('Entry Updated. %sReturning to %s%s', 'Replacement 1 is HTML. Replacement 2 is the title of the page where the user will be taken. Replacement 3 is HTML.','gravityview'), '<a href="'. esc_url( $redirect_url ) . '">', esc_html( $view->post_title ), '</a>' );
-	                    break;
-
-                    case '2':
-	                    $redirect_url = $edit_redirect_url;
-	                    $redirect_url = GFCommon::replace_variables( $redirect_url, $this->form, $this->entry, false, false, false, 'text' );
-	                    $entry_updated_message = sprintf( esc_attr_x('Entry Updated. %sRedirecting to %s%s', 'Replacement 1 is HTML. Replacement 2 is the URL where the user will be taken. Replacement 3 is HTML.','gravityview'), '<a href="'. esc_url( $redirect_url ) . '">', esc_html( $edit_redirect_url ), '</a>' );
-                        break;
-
-                    case '':
-                    default:
-					    $entry_updated_message = sprintf( esc_attr__('Entry Updated. %sReturn to Entry%s', 'gravityview'), '<a href="'. esc_url( $back_link ) .'">', '</a>' );
-                        break;
+					case '0':
+						$redirect_url = $back_link;
+						$entry_updated_message = sprintf( esc_attr_x('Entry Updated. %sReturning to Entry%s', 'Replacements are HTML', 'gravityview'), '<a href="'. esc_url( $redirect_url ) .'">', '</a>' );
+						break;
+
+					case '1':
+						$redirect_url = $directory_link = GravityView_API::directory_link();
+						$entry_updated_message = sprintf( esc_attr_x('Entry Updated. %sReturning to %s%s', 'Replacement 1 is HTML. Replacement 2 is the title of the page where the user will be taken. Replacement 3 is HTML.','gravityview'), '<a href="'. esc_url( $redirect_url ) . '">', esc_html( $view->post_title ), '</a>' );
+						break;
+
+					case '2':
+						$redirect_url = $edit_redirect_url;
+						$redirect_url = GFCommon::replace_variables( $redirect_url, $this->form, $this->entry, false, false, false, 'text' );
+						$entry_updated_message = sprintf( esc_attr_x('Entry Updated. %sRedirecting to %s%s', 'Replacement 1 is HTML. Replacement 2 is the URL where the user will be taken. Replacement 3 is HTML.','gravityview'), '<a href="'. esc_url( $redirect_url ) . '">', esc_html( $edit_redirect_url ), '</a>' );
+						break;
+
+					case '':
+					default:
+						$entry_updated_message = sprintf( esc_attr__('Entry Updated. %sReturn to Entry%s', 'gravityview'), '<a href="'. esc_url( $back_link ) .'">', '</a>' );
+						break;
 				}
 
 				if ( isset( $redirect_url ) ) {
@@ -1264,13 +1264,13 @@ 
 				);
 
 				/**
-				* @filter `gravityview/edit_entry/button_labels` Modify the cancel/submit buttons' labels
-				* @since 1.16.3
-				* @param array $labels Default button labels associative array
-				* @param array $form The Gravity Forms form
-				* @param array $entry The Gravity Forms entry
-				* @param int $view_id The current View ID
-				*/
+				 * @filter `gravityview/edit_entry/button_labels` Modify the cancel/submit buttons' labels
+				 * @since 1.16.3
+				 * @param array $labels Default button labels associative array
+				 * @param array $form The Gravity Forms form
+				 * @param array $entry The Gravity Forms entry
+				 * @param int $view_id The current View ID
+				 */
 				$labels = apply_filters( 'gravityview/edit_entry/button_labels', $labels, $this->form, $this->entry, $this->view_id );
 
 				GFFormDisplay::$submission[ $this->form['id'] ][ 'form' ] = $this->form;
@@ -1316,7 +1316,7 @@ 
 
 		ob_get_clean();
 
-	    remove_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields' ), 5000 );
+		remove_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields' ), 5000 );
 		remove_filter( 'gform_submit_button', array( $this, 'render_form_buttons' ) );
 		remove_filter( 'gform_next_button', array( $this, 'render_form_buttons' ) );
 		remove_filter( 'gform_previous_button', array( $this, 'render_form_buttons' ) );
@@ -1376,7 +1376,7 @@ 
 
 		// for now we don't support Save and Continue feature.
 		if( ! self::$supports_save_and_continue ) {
-	        unset( $form['save'] );
+			unset( $form['save'] );
 		}
 
 		$form = $this->unselect_default_values( $form );
@@ -1403,30 +1403,30 @@ 
 			return $field_content;
 		}
 
-        $message = null;
+		$message = null;
 
-        // First, make sure they have the capability to edit the post.
-        if( false === current_user_can( 'edit_post', $this->entry['post_id'] ) ) {
+		// First, make sure they have the capability to edit the post.
+		if( false === current_user_can( 'edit_post', $this->entry['post_id'] ) ) {
 
-            /**
-             * @filter `gravityview/edit_entry/unsupported_post_field_text` Modify the message when someone isn't able to edit a post
-             * @param string $message The existing "You don't have permission..." text
-             */
-            $message = apply_filters('gravityview/edit_entry/unsupported_post_field_text', __('You don&rsquo;t have permission to edit this post.', 'gravityview') );
+			/**
+			 * @filter `gravityview/edit_entry/unsupported_post_field_text` Modify the message when someone isn't able to edit a post
+			 * @param string $message The existing "You don't have permission..." text
+			 */
+			$message = apply_filters('gravityview/edit_entry/unsupported_post_field_text', __('You don&rsquo;t have permission to edit this post.', 'gravityview') );
 
-        } elseif( null === get_post( $this->entry['post_id'] ) ) {
-            /**
-             * @filter `gravityview/edit_entry/no_post_text` Modify the message when someone is editing an entry attached to a post that no longer exists
-             * @param string $message The existing "This field is not editable; the post no longer exists." text
-             */
-            $message = apply_filters('gravityview/edit_entry/no_post_text', __('This field is not editable; the post no longer exists.', 'gravityview' ) );
-        }
+		} elseif( null === get_post( $this->entry['post_id'] ) ) {
+			/**
+			 * @filter `gravityview/edit_entry/no_post_text` Modify the message when someone is editing an entry attached to a post that no longer exists
+			 * @param string $message The existing "This field is not editable; the post no longer exists." text
+			 */
+			$message = apply_filters('gravityview/edit_entry/no_post_text', __('This field is not editable; the post no longer exists.', 'gravityview' ) );
+		}
 
-        if( $message ) {
-            $field_content = sprintf('<div class="ginput_container ginput_container_' . $field->type . '">%s</div>', wpautop( $message ) );
-        }
+		if( $message ) {
+			$field_content = sprintf('<div class="ginput_container ginput_container_' . $field->type . '">%s</div>', wpautop( $message ) );
+		}
 
-        return $field_content;
+		return $field_content;
 	}
 
 	/**
@@ -1454,7 +1454,7 @@ 
 			|| ! empty( $field_content )
 			|| in_array( $field->type, array( 'honeypot' ) )
 		) {
-	        return $field_content;
+			return $field_content;
 		}
 
 		// SET SOME FIELD DEFAULTS TO PREVENT ISSUES
@@ -1462,24 +1462,24 @@ 
 
 		$field_value = $this->get_field_value( $field );
 
-	    // Prevent any PHP warnings, like undefined index
-	    ob_start();
+		// Prevent any PHP warnings, like undefined index
+		ob_start();
 
-	    $return = null;
+		$return = null;
 
 		/** @var GravityView_Field $gv_field */
 		if( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) ) {
 			$return = $gv_field->get_field_input( $this->form, $field_value, $this->entry, $field );
 		} else {
-	        $return = $field->get_field_input( $this->form, $field_value, $this->entry );
-	    }
+			$return = $field->get_field_input( $this->form, $field_value, $this->entry );
+		}
 
-	    // If there was output, it's an error
-	    $warnings = ob_get_clean();
+		// If there was output, it's an error
+		$warnings = ob_get_clean();
 
-	    if( !empty( $warnings ) ) {
-		    gravityview()->log->error( '{warning}', array( 'warning' => $warnings, 'data' => $field_value ) );
-	    }
+		if( !empty( $warnings ) ) {
+			gravityview()->log->error( '{warning}', array( 'warning' => $warnings, 'data' => $field_value ) );
+		}
 
 		return $return;
 	}
@@ -1514,8 +1514,8 @@ 
 				$input_id = strval( $input['id'] );
 
 				if ( isset( $this->entry[ $input_id ] ) && ! gv_empty( $this->entry[ $input_id ], false, false ) ) {
-				    $field_value[ $input_id ] =  'post_category' === $field->type ? GFCommon::format_post_category( $this->entry[ $input_id ], true ) : $this->entry[ $input_id ];
-				    $allow_pre_populated = false;
+					$field_value[ $input_id ] =  'post_category' === $field->type ? GFCommon::format_post_category( $this->entry[ $input_id ], true ) : $this->entry[ $input_id ];
+					$allow_pre_populated = false;
 				}
 
 			}
@@ -1539,7 +1539,7 @@ 
 			if ( 'post_category' === $field->type && !gv_empty( $field_value, false, false ) ) {
 				$categories = array();
 				foreach ( explode( ',', $field_value ) as $cat_string ) {
-				    $categories[] = GFCommon::format_post_category( $cat_string, true );
+					$categories[] = GFCommon::format_post_category( $cat_string, true );
 				}
 				$field_value = 'multiselect' === $field->get_input_type() ? $categories : implode( '', $categories );
 			}
@@ -1549,25 +1549,25 @@ 
 		// if value is empty get the default value if defined
 		$field_value = $field->get_value_default_if_empty( $field_value );
 
-	    /**
-	     * @filter `gravityview/edit_entry/field_value` Change the value of an Edit Entry field, if needed
-	     * @since 1.11
-	     * @since 1.20 Added third param
-	     * @param mixed $field_value field value used to populate the input
-	     * @param object $field Gravity Forms field object ( Class GF_Field )
-	     * @param GravityView_Edit_Entry_Render $this Current object
-	     */
-	    $field_value = apply_filters( 'gravityview/edit_entry/field_value', $field_value, $field, $this );
-
-	    /**
-	     * @filter `gravityview/edit_entry/field_value_{field_type}` Change the value of an Edit Entry field for a specific field type
-	     * @since 1.17
-	     * @since 1.20 Added third param
-	     * @param mixed $field_value field value used to populate the input
-	     * @param GF_Field $field Gravity Forms field object
-	     * @param GravityView_Edit_Entry_Render $this Current object
-	     */
-	    $field_value = apply_filters( 'gravityview/edit_entry/field_value_' . $field->type , $field_value, $field, $this );
+		/**
+		 * @filter `gravityview/edit_entry/field_value` Change the value of an Edit Entry field, if needed
+		 * @since 1.11
+		 * @since 1.20 Added third param
+		 * @param mixed $field_value field value used to populate the input
+		 * @param object $field Gravity Forms field object ( Class GF_Field )
+		 * @param GravityView_Edit_Entry_Render $this Current object
+		 */
+		$field_value = apply_filters( 'gravityview/edit_entry/field_value', $field_value, $field, $this );
+
+		/**
+		 * @filter `gravityview/edit_entry/field_value_{field_type}` Change the value of an Edit Entry field for a specific field type
+		 * @since 1.17
+		 * @since 1.20 Added third param
+		 * @param mixed $field_value field value used to populate the input
+		 * @param GF_Field $field Gravity Forms field object
+		 * @param GravityView_Edit_Entry_Render $this Current object
+		 */
+		$field_value = apply_filters( 'gravityview/edit_entry/field_value_' . $field->type , $field_value, $field, $this );
 
 		return $field_value;
 	}
@@ -1594,7 +1594,7 @@ 
 			// This is because we're doing admin form pretending to be front-end, so Gravity Forms
 			// expects certain field array items to be set.
 			foreach ( array( 'noDuplicates', 'adminOnly', 'inputType', 'isRequired', 'enablePrice', 'inputs', 'allowedExtensions' ) as $key ) {
-	            $field->{$key} = isset( $field->{$key} ) ? $field->{$key} : NULL;
+				$field->{$key} = isset( $field->{$key} ) ? $field->{$key} : NULL;
 			}
 
 			switch( RGFormsModel::get_input_type( $field ) ) {
@@ -1608,61 +1608,61 @@ 
 				 */
 				case 'fileupload':
 
-				    // Set the previous value
-				    $entry = $this->get_entry();
+					// Set the previous value
+					$entry = $this->get_entry();
 
-				    $input_name = 'input_'.$field->id;
-				    $form_id = $form['id'];
+					$input_name = 'input_'.$field->id;
+					$form_id = $form['id'];
 
-				    $value = NULL;
+					$value = NULL;
 
-				    // Use the previous entry value as the default.
-				    if( isset( $entry[ $field->id ] ) ) {
-				        $value = $entry[ $field->id ];
-				    }
+					// Use the previous entry value as the default.
+					if( isset( $entry[ $field->id ] ) ) {
+						$value = $entry[ $field->id ];
+					}
 
-				    // If this is a single upload file
-				    if( !empty( $_FILES[ $input_name ] ) && !empty( $_FILES[ $input_name ]['name'] ) ) {
-				        $file_path = GFFormsModel::get_file_upload_path( $form['id'], $_FILES[ $input_name ]['name'] );
-				        $value = $file_path['url'];
+					// If this is a single upload file
+					if( !empty( $_FILES[ $input_name ] ) && !empty( $_FILES[ $input_name ]['name'] ) ) {
+						$file_path = GFFormsModel::get_file_upload_path( $form['id'], $_FILES[ $input_name ]['name'] );
+						$value = $file_path['url'];
 
-				    } else {
+					} else {
 
-				        // Fix PHP warning on line 1498 of form_display.php for post_image fields
-				        // Fix PHP Notice:  Undefined index:  size in form_display.php on line 1511
-				        $_FILES[ $input_name ] = array('name' => '', 'size' => '' );
+						// Fix PHP warning on line 1498 of form_display.php for post_image fields
+						// Fix PHP Notice:  Undefined index:  size in form_display.php on line 1511
+						$_FILES[ $input_name ] = array('name' => '', 'size' => '' );
 
-				    }
+					}
 
-				    if ( \GV\Utils::get( $field, "multipleFiles" ) ) {
+					if ( \GV\Utils::get( $field, "multipleFiles" ) ) {
 
-				        // If there are fresh uploads, process and merge them.
-				        // Otherwise, use the passed values, which should be json-encoded array of URLs
-				        if( isset( GFFormsModel::$uploaded_files[$form_id][$input_name] ) ) {
-				            $value = empty( $value ) ? '[]' : $value;
-				            $value = stripslashes_deep( $value );
-				            $value = GFFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'], array());
-				        }
+						// If there are fresh uploads, process and merge them.
+						// Otherwise, use the passed values, which should be json-encoded array of URLs
+						if( isset( GFFormsModel::$uploaded_files[$form_id][$input_name] ) ) {
+							$value = empty( $value ) ? '[]' : $value;
+							$value = stripslashes_deep( $value );
+							$value = GFFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'], array());
+						}
 
-				    } else {
+					} else {
 
-				        // A file already exists when editing an entry
-				        // We set this to solve issue when file upload fields are required.
-				        GFFormsModel::$uploaded_files[ $form_id ][ $input_name ] = $value;
+						// A file already exists when editing an entry
+						// We set this to solve issue when file upload fields are required.
+						GFFormsModel::$uploaded_files[ $form_id ][ $input_name ] = $value;
 
-				    }
+					}
 
-				    $this->entry[ $input_name ] = $value;
-				    $_POST[ $input_name ] = $value;
+					$this->entry[ $input_name ] = $value;
+					$_POST[ $input_name ] = $value;
 
-				    break;
+					break;
 
 				case 'number':
-				    // Fix "undefined index" issue at line 1286 in form_display.php
-				    if( !isset( $_POST['input_'.$field->id ] ) ) {
-				        $_POST['input_'.$field->id ] = NULL;
-				    }
-				    break;
+					// Fix "undefined index" issue at line 1286 in form_display.php
+					if( !isset( $_POST['input_'.$field->id ] ) ) {
+						$_POST['input_'.$field->id ] = NULL;
+					}
+					break;
 			}
 
 		}
@@ -1752,43 +1752,43 @@ 
 				case 'fileupload' :
 				case 'post_image':
 
-				    // in case nothing is uploaded but there are already files saved
-				    if( !empty( $field->failed_validation ) && !empty( $field->isRequired ) && !empty( $value ) ) {
-				        $field->failed_validation = false;
-				        unset( $field->validation_message );
-				    }
+					// in case nothing is uploaded but there are already files saved
+					if( !empty( $field->failed_validation ) && !empty( $field->isRequired ) && !empty( $value ) ) {
+						$field->failed_validation = false;
+						unset( $field->validation_message );
+					}
 
-				    // validate if multi file upload reached max number of files [maxFiles] => 2
-				    if( \GV\Utils::get( $field, 'maxFiles') && \GV\Utils::get( $field, 'multipleFiles') ) {
+					// validate if multi file upload reached max number of files [maxFiles] => 2
+					if( \GV\Utils::get( $field, 'maxFiles') && \GV\Utils::get( $field, 'multipleFiles') ) {
 
-				        $input_name = 'input_' . $field->id;
-				        //uploaded
-				        $file_names = isset( GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] ) ? GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] : array();
+						$input_name = 'input_' . $field->id;
+						//uploaded
+						$file_names = isset( GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] ) ? GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] : array();
 
-				        //existent
-				        $entry = $this->get_entry();
-				        $value = NULL;
-				        if( isset( $entry[ $field->id ] ) ) {
-				            $value = json_decode( $entry[ $field->id ], true );
-				        }
+						//existent
+						$entry = $this->get_entry();
+						$value = NULL;
+						if( isset( $entry[ $field->id ] ) ) {
+							$value = json_decode( $entry[ $field->id ], true );
+						}
 
-				        // count uploaded files and existent entry files
-				        $count_files = ( is_array( $file_names ) ? count( $file_names ) : 0 ) +
-						               ( is_array( $value ) ? count( $value ) : 0 );
+						// count uploaded files and existent entry files
+						$count_files = ( is_array( $file_names ) ? count( $file_names ) : 0 ) +
+									   ( is_array( $value ) ? count( $value ) : 0 );
 
-				        if( $count_files > $field->maxFiles ) {
-				            $field->validation_message = __( 'Maximum number of files reached', 'gravityview' );
-				            $field->failed_validation = 1;
-				            $gv_valid = false;
+						if( $count_files > $field->maxFiles ) {
+							$field->validation_message = __( 'Maximum number of files reached', 'gravityview' );
+							$field->failed_validation = 1;
+							$gv_valid = false;
 
-				            // in case of error make sure the newest upload files are removed from the upload input
-				            GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ] = null;
-				        }
+							// in case of error make sure the newest upload files are removed from the upload input
+							GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ] = null;
+						}
 
-				    }
+					}
 
 
-				    break;
+					break;
 
 			}
 
@@ -1799,47 +1799,47 @@ 
 
 				switch ( $field_type ) {
 
-				    // Captchas don't need to be re-entered.
-				    case 'captcha':
+					// Captchas don't need to be re-entered.
+					case 'captcha':
 
-				        // Post Image fields aren't editable, so we un-fail them.
-				    case 'post_image':
-				        $field->failed_validation = false;
-				        unset( $field->validation_message );
-				        break;
+						// Post Image fields aren't editable, so we un-fail them.
+					case 'post_image':
+						$field->failed_validation = false;
+						unset( $field->validation_message );
+						break;
 
 				}
 
 				// You can't continue inside a switch, so we do it after.
 				if( empty( $field->failed_validation ) ) {
-				    continue;
+					continue;
 				}
 
 				// checks if the No Duplicates option is not validating entry against itself, since
 				// we're editing a stored entry, it would also assume it's a duplicate.
 				if( !empty( $field->noDuplicates ) ) {
 
-				    $entry = $this->get_entry();
+					$entry = $this->get_entry();
 
-				    // If the value of the entry is the same as the stored value
-				    // Then we can assume it's not a duplicate, it's the same.
-				    if( !empty( $entry ) && $value == $entry[ $field->id ] ) {
-				        //if value submitted was not changed, then don't validate
-				        $field->failed_validation = false;
+					// If the value of the entry is the same as the stored value
+					// Then we can assume it's not a duplicate, it's the same.
+					if( !empty( $entry ) && $value == $entry[ $field->id ] ) {
+						//if value submitted was not changed, then don't validate
+						$field->failed_validation = false;
 
-				        unset( $field->validation_message );
+						unset( $field->validation_message );
 
-				        gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field not a duplicate; it is the same entry.', array( 'data' => $entry ) );
+						gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field not a duplicate; it is the same entry.', array( 'data' => $entry ) );
 
-				        continue;
-				    }
+						continue;
+					}
 				}
 
 				// if here then probably we are facing the validation 'At least one field must be filled out'
 				if( GFFormDisplay::is_empty( $field, $this->form_id  ) && empty( $field->isRequired ) ) {
-				    unset( $field->validation_message );
-	                $field->validation_message = false;
-				    continue;
+					unset( $field->validation_message );
+					$field->validation_message = false;
+					continue;
 				}
 
 				$gv_valid = false;
@@ -1903,8 +1903,8 @@ 
 		// Hide fields depending on admin settings
 		$fields = $this->filter_fields( $form['fields'], $edit_fields );
 
-	    // If Edit Entry fields are configured, remove adminOnly field settings. Otherwise, don't.
-	    $fields = $this->filter_admin_only_fields( $fields, $edit_fields, $form, $view_id );
+		// If Edit Entry fields are configured, remove adminOnly field settings. Otherwise, don't.
+		$fields = $this->filter_admin_only_fields( $fields, $edit_fields, $form, $view_id );
 
 		/**
 		 * @filter `gravityview/edit_entry/form_fields` Modify the fields displayed in Edit Entry form
@@ -1995,11 +1995,11 @@ 
 		// The edit tab has been configured, so we loop through to configured settings
 		foreach ( $configured_fields as $configured_field ) {
 
-	        /** @var GF_Field $field */
-	        foreach ( $fields as $field ) {
+			/** @var GF_Field $field */
+			foreach ( $fields as $field ) {
 				if( intval( $configured_field['id'] ) === intval( $field->id ) && $this->user_can_edit_field( $configured_field, false ) ) {
-				    $edit_fields[] = $this->merge_field_properties( $field, $configured_field );
-				    break;
+					$edit_fields[] = $this->merge_field_properties( $field, $configured_field );
+					break;
 				}
 
 			}
@@ -2055,28 +2055,28 @@ 
 	 */
 	private function filter_admin_only_fields( $fields = array(), $edit_fields = null, $form = array(), $view_id = 0 ) {
 
-	    /**
+		/**
 		 * @filter `gravityview/edit_entry/use_gf_admin_only_setting` When Edit tab isn't configured, should the Gravity Forms "Admin Only" field settings be used to control field display to non-admins? Default: true
-	     * If the Edit Entry tab is not configured, adminOnly fields will not be shown to non-administrators.
-	     * If the Edit Entry tab *is* configured, adminOnly fields will be shown to non-administrators, using the configured GV permissions
-	     * @since 1.9.1
-	     * @param boolean $use_gf_adminonly_setting True: Hide field if set to Admin Only in GF and the user is not an admin. False: show field based on GV permissions, ignoring GF permissions.
-	     * @param array $form GF Form array
-	     * @param int $view_id View ID
-	     */
-	    $use_gf_adminonly_setting = apply_filters( 'gravityview/edit_entry/use_gf_admin_only_setting', empty( $edit_fields ), $form, $view_id );
-
-	    if( $use_gf_adminonly_setting && false === GVCommon::has_cap( 'gravityforms_edit_entries', $this->entry['id'] ) ) {
+		 * If the Edit Entry tab is not configured, adminOnly fields will not be shown to non-administrators.
+		 * If the Edit Entry tab *is* configured, adminOnly fields will be shown to non-administrators, using the configured GV permissions
+		 * @since 1.9.1
+		 * @param boolean $use_gf_adminonly_setting True: Hide field if set to Admin Only in GF and the user is not an admin. False: show field based on GV permissions, ignoring GF permissions.
+		 * @param array $form GF Form array
+		 * @param int $view_id View ID
+		 */
+		$use_gf_adminonly_setting = apply_filters( 'gravityview/edit_entry/use_gf_admin_only_setting', empty( $edit_fields ), $form, $view_id );
+
+		if( $use_gf_adminonly_setting && false === GVCommon::has_cap( 'gravityforms_edit_entries', $this->entry['id'] ) ) {
 			foreach( $fields as $k => $field ) {
 				if( $field->adminOnly ) {
-				    unset( $fields[ $k ] );
+					unset( $fields[ $k ] );
 				}
 			}
 			return array_values( $fields );
 		}
 
-	    foreach( $fields as &$field ) {
-		    $field->adminOnly = false;
+		foreach( $fields as &$field ) {
+			$field->adminOnly = false;
 		}
 
 		return $fields;
@@ -2096,13 +2096,13 @@ 
 	 */
 	private function unselect_default_values( $form ) {
 
-	    foreach ( $form['fields'] as &$field ) {
+		foreach ( $form['fields'] as &$field ) {
 
 			if ( empty( $field->choices ) ) {
-                continue;
+				continue;
 			}
 
-            foreach ( $field->choices as &$choice ) {
+			foreach ( $field->choices as &$choice ) {
 				if ( \GV\Utils::get( $choice, 'isSelected' ) ) {
 					$choice['isSelected'] = false;
 				}
@@ -2139,36 +2139,36 @@ 
 
 			if( 'checkbox' === $field->type ) {
 				foreach ( $field->get_entry_inputs() as $key => $input ) {
-				    $input_id = $input['id'];
-				    $choice = $field->choices[ $key ];
-				    $value = \GV\Utils::get( $this->entry, $input_id );
-				    $match = RGFormsModel::choice_value_match( $field, $choice, $value );
-				    if( $match ) {
-				        $field->choices[ $key ]['isSelected'] = true;
-				    }
+					$input_id = $input['id'];
+					$choice = $field->choices[ $key ];
+					$value = \GV\Utils::get( $this->entry, $input_id );
+					$match = RGFormsModel::choice_value_match( $field, $choice, $value );
+					if( $match ) {
+						$field->choices[ $key ]['isSelected'] = true;
+					}
 				}
 			} else {
 
 				// We need to run through each field to set the default values
 				foreach ( $this->entry as $field_id => $field_value ) {
 
-				    if( floatval( $field_id ) === floatval( $field->id ) ) {
+					if( floatval( $field_id ) === floatval( $field->id ) ) {
 
-				        if( 'list' === $field->type ) {
-				            $list_rows = maybe_unserialize( $field_value );
+						if( 'list' === $field->type ) {
+							$list_rows = maybe_unserialize( $field_value );
 
-				            $list_field_value = array();
-				            foreach ( (array) $list_rows as $row ) {
-				                foreach ( (array) $row as $column ) {
-				                    $list_field_value[] = $column;
-				                }
-				            }
+							$list_field_value = array();
+							foreach ( (array) $list_rows as $row ) {
+								foreach ( (array) $row as $column ) {
+									$list_field_value[] = $column;
+								}
+							}
 
-				            $field->defaultValue = serialize( $list_field_value );
-				        } else {
-				            $field->defaultValue = $field_value;
-				        }
-				    }
+							$field->defaultValue = serialize( $list_field_value );
+						} else {
+							$field->defaultValue = $field_value;
+						}
+					}
 				}
 			}
 		}
@@ -2229,7 +2229,7 @@ 
 			foreach ( $form['fields'] as &$field ) {
 				foreach ( $remove_conditions_rule as $_remove_conditions_r ) {
 
-				    list( $rule_field_id, $rule_i ) = $_remove_conditions_r;
+					list( $rule_field_id, $rule_i ) = $_remove_conditions_r;
 
 					if ( $field['id'] == $rule_field_id ) {
 						unset( $field->conditionalLogic['rules'][ $rule_i ] );
@@ -2280,7 +2280,7 @@ 
 			return $has_conditional_logic;
 		}
 
-	    /** @see GravityView_Edit_Entry_Render::filter_conditional_logic for filter documentation */
+		/** @see GravityView_Edit_Entry_Render::filter_conditional_logic for filter documentation */
 		return apply_filters( 'gravityview/edit_entry/conditional_logic', $has_conditional_logic, $form );
 	}
 
@@ -2347,14 +2347,14 @@ 
 
 		if( $echo && $error !== true ) {
 
-	        $error = esc_html( $error );
+			$error = esc_html( $error );
 
-	        /**
-	         * @since 1.9
-	         */
-	        if ( ! empty( $this->entry ) ) {
-		        $error .= ' ' . gravityview_get_link( '#', _x('Go back.', 'Link shown when invalid Edit Entry link is clicked', 'gravityview' ), array( 'onclick' => "window.history.go(-1); return false;" ) );
-	        }
+			/**
+			 * @since 1.9
+			 */
+			if ( ! empty( $this->entry ) ) {
+				$error .= ' ' . gravityview_get_link( '#', _x('Go back.', 'Link shown when invalid Edit Entry link is clicked', 'gravityview' ), array( 'onclick' => "window.history.go(-1); return false;" ) );
+			}
 
 			echo GVCommon::generate_notice( wpautop( $error ), 'gv-error error');
 		}

includes/extensions/edit-entry/class-edit-entry-admin.php

Indentation +147 added lines, -147 removed lines

@@ -10,42 +10,42 @@ 
  */
 
 if ( ! defined( 'WPINC' ) ) {
-    die;
+	die;
 }
 
 
 class GravityView_Edit_Entry_Admin {
 
-    protected $loader;
+	protected $loader;
 
-    function __construct( GravityView_Edit_Entry $loader ) {
-        $this->loader = $loader;
-    }
+	function __construct( GravityView_Edit_Entry $loader ) {
+		$this->loader = $loader;
+	}
 
-    function load() {
+	function load() {
 
-        if( !is_admin() ) {
-            return;
-        }
+		if( !is_admin() ) {
+			return;
+		}
 
-        // Add Edit Link as a default field, outside those set in the Gravity Form form
-        add_filter( 'gravityview_entry_default_fields', array( $this, 'add_default_field' ), 10, 3 );
+		// Add Edit Link as a default field, outside those set in the Gravity Form form
+		add_filter( 'gravityview_entry_default_fields', array( $this, 'add_default_field' ), 10, 3 );
 
-        // For the Edit Entry Link, you don't want visible to all users.
-        add_filter( 'gravityview_field_visibility_caps', array( $this, 'modify_visibility_caps' ), 10, 5 );
+		// For the Edit Entry Link, you don't want visible to all users.
+		add_filter( 'gravityview_field_visibility_caps', array( $this, 'modify_visibility_caps' ), 10, 5 );
 
-        // Modify the field options based on the name of the field type
-        add_filter( 'gravityview_template_edit_link_options', array( $this, 'edit_link_field_options' ), 10, 5 );
+		// Modify the field options based on the name of the field type
+		add_filter( 'gravityview_template_edit_link_options', array( $this, 'edit_link_field_options' ), 10, 5 );
 
-        // add tooltips
-        add_filter( 'gravityview/metaboxes/tooltips', array( $this, 'tooltips') );
+		// add tooltips
+		add_filter( 'gravityview/metaboxes/tooltips', array( $this, 'tooltips') );
 
-        // custom fields' options for zone EDIT
-        add_filter( 'gravityview_template_field_options', array( $this, 'field_options' ), 10, 6 );
+		// custom fields' options for zone EDIT
+		add_filter( 'gravityview_template_field_options', array( $this, 'field_options' ), 10, 6 );
 
-        // Add Edit Entry settings to View Settings
-        add_action( 'gravityview/metaboxes/edit_entry', array( $this, 'view_settings_metabox' ) );
-    }
+		// Add Edit Entry settings to View Settings
+		add_action( 'gravityview/metaboxes/edit_entry', array( $this, 'view_settings_metabox' ) );
+	}
 
 	/**
 	 * Render Edit Entry View metabox settings
@@ -69,100 +69,100 @@ 
 		GravityView_Render_Settings::render_setting_row( 'edit_redirect_url', $current_settings );
 	}
 
-    /**
-     * Add Edit Link as a default field, outside those set in the Gravity Form form
-     * @param array $entry_default_fields Existing fields
-     * @param  string|array $form form_ID or form object
-     * @param  string $zone   Either 'single', 'directory', 'header', 'footer'
-     */
-    function add_default_field( $entry_default_fields, $form = array(), $zone = '' ) {
-
-        if( $zone !== 'edit' ) {
-
-            $entry_default_fields['edit_link'] = array(
-                'label' => __('Edit Entry', 'gravityview'),
-                'type' => 'edit_link',
-                'desc'	=> __('A link to edit the entry. Visible based on View settings.', 'gravityview'),
-            );
-
-        }
-
-        return $entry_default_fields;
-    }
-
-    /**
-     * Change wording for the Edit context to read Entry Creator
-     *
-     * @param  array 	   $visibility_caps        Array of capabilities to display in field dropdown.
-     * @param  string      $field_type  Type of field options to render (`field` or `widget`)
-     * @param  string      $template_id Table slug
-     * @param  float       $field_id    GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
-     * @param  string      $context     What context are we in? Example: `single` or `directory`
-     * @param  string      $input_type  (textarea, list, select, etc.)
-     * @return array                   Array of field options with `label`, `value`, `type`, `default` keys
-     */
-    function modify_visibility_caps( $visibility_caps = array(), $template_id = '', $field_id = '', $context = '', $input_type = '' ) {
-
-        $caps = $visibility_caps;
-
-        // If we're configuring fields in the edit context, we want a limited selection
-        if( $context === 'edit' ) {
-
-            // Remove other built-in caps.
-            unset( $caps['publish_posts'], $caps['gravityforms_view_entries'], $caps['delete_others_posts'] );
-
-            $caps['read'] = _x('Entry Creator','User capability', 'gravityview');
-        }
-
-        return $caps;
-    }
-
-    /**
-     * Add "Edit Link Text" setting to the edit_link field settings
-     *
-     * @param array  $field_options
-     * @param string $template_id
-     * @param string $field_id
-     * @param string $context
-     * @param string $input_type
-     *
-     * @return array $field_options, with "Edit Link Text" field option
-     */
-    function edit_link_field_options( $field_options, $template_id, $field_id, $context, $input_type ) {
-
-        // Always a link, never a filter
-        unset( $field_options['show_as_link'], $field_options['search_filter'] );
-
-        // Edit Entry link should only appear to visitors capable of editing entries
-        unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] );
-
-        $add_option['edit_link'] = array(
-            'type' => 'text',
-            'label' => __( 'Edit Link Text', 'gravityview' ),
-            'desc' => NULL,
-            'value' => __('Edit Entry', 'gravityview'),
-            'merge_tags' => true,
-        );
-
-        return array_merge( $add_option, $field_options );
-    }
-
-    /**
-     * Add tooltips
-     * @param  array $tooltips Existing tooltips
-     * @return array           Modified tooltips
-     */
-    function tooltips( $tooltips ) {
-
-        $return = $tooltips;
-
-        $return['allow_edit_cap'] = array(
-            'title' => __('Limiting Edit Access', 'gravityview'),
-            'value' => __('Change this setting if you don\'t want the user who created the entry to be able to edit this field.', 'gravityview'),
-        );
-
-        return $return;
-    }
+	/**
+	 * Add Edit Link as a default field, outside those set in the Gravity Form form
+	 * @param array $entry_default_fields Existing fields
+	 * @param  string|array $form form_ID or form object
+	 * @param  string $zone   Either 'single', 'directory', 'header', 'footer'
+	 */
+	function add_default_field( $entry_default_fields, $form = array(), $zone = '' ) {
+
+		if( $zone !== 'edit' ) {
+
+			$entry_default_fields['edit_link'] = array(
+				'label' => __('Edit Entry', 'gravityview'),
+				'type' => 'edit_link',
+				'desc'	=> __('A link to edit the entry. Visible based on View settings.', 'gravityview'),
+			);
+
+		}
+
+		return $entry_default_fields;
+	}
+
+	/**
+	 * Change wording for the Edit context to read Entry Creator
+	 *
+	 * @param  array 	   $visibility_caps        Array of capabilities to display in field dropdown.
+	 * @param  string      $field_type  Type of field options to render (`field` or `widget`)
+	 * @param  string      $template_id Table slug
+	 * @param  float       $field_id    GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
+	 * @param  string      $context     What context are we in? Example: `single` or `directory`
+	 * @param  string      $input_type  (textarea, list, select, etc.)
+	 * @return array                   Array of field options with `label`, `value`, `type`, `default` keys
+	 */
+	function modify_visibility_caps( $visibility_caps = array(), $template_id = '', $field_id = '', $context = '', $input_type = '' ) {
+
+		$caps = $visibility_caps;
+
+		// If we're configuring fields in the edit context, we want a limited selection
+		if( $context === 'edit' ) {
+
+			// Remove other built-in caps.
+			unset( $caps['publish_posts'], $caps['gravityforms_view_entries'], $caps['delete_others_posts'] );
+
+			$caps['read'] = _x('Entry Creator','User capability', 'gravityview');
+		}
+
+		return $caps;
+	}
+
+	/**
+	 * Add "Edit Link Text" setting to the edit_link field settings
+	 *
+	 * @param array  $field_options
+	 * @param string $template_id
+	 * @param string $field_id
+	 * @param string $context
+	 * @param string $input_type
+	 *
+	 * @return array $field_options, with "Edit Link Text" field option
+	 */
+	function edit_link_field_options( $field_options, $template_id, $field_id, $context, $input_type ) {
+
+		// Always a link, never a filter
+		unset( $field_options['show_as_link'], $field_options['search_filter'] );
+
+		// Edit Entry link should only appear to visitors capable of editing entries
+		unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] );
+
+		$add_option['edit_link'] = array(
+			'type' => 'text',
+			'label' => __( 'Edit Link Text', 'gravityview' ),
+			'desc' => NULL,
+			'value' => __('Edit Entry', 'gravityview'),
+			'merge_tags' => true,
+		);
+
+		return array_merge( $add_option, $field_options );
+	}
+
+	/**
+	 * Add tooltips
+	 * @param  array $tooltips Existing tooltips
+	 * @return array           Modified tooltips
+	 */
+	function tooltips( $tooltips ) {
+
+		$return = $tooltips;
+
+		$return['allow_edit_cap'] = array(
+			'title' => __('Limiting Edit Access', 'gravityview'),
+			'value' => __('Change this setting if you don\'t want the user who created the entry to be able to edit this field.', 'gravityview'),
+		);
+
+		return $return;
+	}
 
 	/**
 	 * Add "Edit Link Text" setting to the edit_link field settings
@@ -178,37 +178,37 @@ 
 	 */
 	public function field_options( $field_options, $template_id, $field_id, $context, $input_type, $form_id ) {
 
-        // We only want to modify the settings for the edit context
-        if( 'edit' !== $context ) {
-
-            /**
-             * @since 1.8.4
-             */
-            $field_options['new_window'] = array(
-                'type' => 'checkbox',
-                'label' => __( 'Open link in a new tab or window?', 'gravityview' ),
-                'value' => false,
-            );
-
-            return $field_options;
-        }
-
-        //  Entry field is only for logged in users
-        unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] );
-
-        $add_options = array(
-            'allow_edit_cap' => array(
-                'type' => 'select',
-                'label' => __( 'Make field editable to:', 'gravityview' ),
-                'choices' => GravityView_Render_Settings::get_cap_choices( $template_id, $field_id, $context, $input_type ),
-                'tooltip' => 'allow_edit_cap',
-                'class' => 'widefat',
-                'value' => 'read', // Default: entry creator
-            ),
-        );
-
-        return array_merge( $field_options, $add_options );
-    }
+		// We only want to modify the settings for the edit context
+		if( 'edit' !== $context ) {
+
+			/**
+			 * @since 1.8.4
+			 */
+			$field_options['new_window'] = array(
+				'type' => 'checkbox',
+				'label' => __( 'Open link in a new tab or window?', 'gravityview' ),
+				'value' => false,
+			);
+
+			return $field_options;
+		}
+
+		//  Entry field is only for logged in users
+		unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] );
+
+		$add_options = array(
+			'allow_edit_cap' => array(
+				'type' => 'select',
+				'label' => __( 'Make field editable to:', 'gravityview' ),
+				'choices' => GravityView_Render_Settings::get_cap_choices( $template_id, $field_id, $context, $input_type ),
+				'tooltip' => 'allow_edit_cap',
+				'class' => 'widefat',
+				'value' => 'read', // Default: entry creator
+			),
+		);
+
+		return array_merge( $field_options, $add_options );
+	}
 
 
 } // end class

includes/class-admin-views.php

Indentation +80 added lines, -80 removed lines

@@ -63,28 +63,28 @@ 
 	}
 
 	/**
-     * When on the Add/Edit View screen, suggest most popular articles related to that
-     *
+	 * When on the Add/Edit View screen, suggest most popular articles related to that
+	 *
 	 * @param array $localization_data Data to be passed to the Support Port JS
 	 *
 	 * @return array
 	 */
 	function suggest_support_articles( $localization_data = array() ) {
 
-	    if( ! gravityview()->request->is_view() ) {
-	        return $localization_data;
-        }
+		if( ! gravityview()->request->is_view() ) {
+			return $localization_data;
+		}
 
 		$localization_data['suggest'] = array(
-            '57ef23539033602e61d4a560',
-            '54c67bb9e4b0512429885513',
-            '54c67bb9e4b0512429885512',
-            '54c67bbbe4b07997ea3f3f6b',
-            '54d1a33ae4b086c0c0964ce9',
-            '57ef253c9033602e61d4a563',
-            '552355bfe4b0221aadf2572b',
-            '54c67bcde4b051242988553e',
-        );
+			'57ef23539033602e61d4a560',
+			'54c67bb9e4b0512429885513',
+			'54c67bb9e4b0512429885512',
+			'54c67bbbe4b07997ea3f3f6b',
+			'54d1a33ae4b086c0c0964ce9',
+			'57ef253c9033602e61d4a563',
+			'552355bfe4b0221aadf2572b',
+			'54c67bcde4b051242988553e',
+		);
 
 		return $localization_data;
 	}
@@ -175,11 +175,11 @@ 
 
 		if( 'form_list' === GFForms::get_page() ) {
 			$priority = 790;
-        }
+		}
 
 		if( empty( $connected_views ) ) {
 
-		    $menu_items['gravityview'] = array(
+			$menu_items['gravityview'] = array(
 				'label'          => esc_attr__( 'Create a View', 'gravityview' ),
 				'icon'           => '<i class="fa fa-lg gv-icon-astronaut-head gv-icon"></i>',
 				'title'          => esc_attr__( 'Create a View using this form as a data source', 'gravityview' ),
@@ -210,13 +210,13 @@ 
 		// If there were no items added, then let's create the parent menu
 		if( $sub_menu_items ) {
 
-		    $sub_menu_items[] = array(
-			    'label' => esc_attr__( 'Create a View', 'gravityview' ),
-                'link_class' => 'gv-create-view',
-			    'title' => esc_attr__( 'Create a View using this form as a data source', 'gravityview' ),
-			    'url'   => admin_url( 'post-new.php?post_type=gravityview&form_id=' . $id ),
-			    'capabilities'   => array( 'edit_gravityviews' ),
-            );
+			$sub_menu_items[] = array(
+				'label' => esc_attr__( 'Create a View', 'gravityview' ),
+				'link_class' => 'gv-create-view',
+				'title' => esc_attr__( 'Create a View using this form as a data source', 'gravityview' ),
+				'url'   => admin_url( 'post-new.php?post_type=gravityview&form_id=' . $id ),
+				'capabilities'   => array( 'edit_gravityviews' ),
+			);
 
 			// Make sure Gravity Forms uses the submenu; if there's only one item, it uses a link instead of a dropdown
 			$sub_menu_items[] = array(
@@ -596,16 +596,16 @@ 
 	/**
 	 * Render html for displaying available fields based on a Form ID
 	 *
-     * @see GravityView_Ajax::get_available_fields_html() Triggers `gravityview_render_available_fields` action
+	 * @see GravityView_Ajax::get_available_fields_html() Triggers `gravityview_render_available_fields` action
 	 *
 	 * @param int $form Gravity Forms Form ID (default: '')
 	 * @param string $context (default: 'single')
-     *
+	 *
 	 * @return void
 	 */
 	function render_available_fields( $form = 0, $context = 'single' ) {
 
-	    // Determine if form is a preset and convert it to an array with fields
+		// Determine if form is a preset and convert it to an array with fields
 		$form = ( is_string( $form ) && preg_match( '/^preset_/', $form ) ) ? GravityView_Ajax::pre_get_form_fields( $form ) : $form;
 
 		/**
@@ -617,7 +617,7 @@ 
 
 		if ( ! is_array( $blacklist_field_types ) ) {
 
-		    gravityview()->log->error( '$blacklist_field_types is not an array', array( 'data' => print_r( $blacklist_field_types, true ) ) );
+			gravityview()->log->error( '$blacklist_field_types is not an array', array( 'data' => print_r( $blacklist_field_types, true ) ) );
 
 			$blacklist_field_types = array();
 		}
@@ -753,12 +753,12 @@ 
 				/**
 				 * @since 1.7.2
 				 */
-			    'other_entries' => array(
-				    'label'	=> __('Other Entries', 'gravityview'),
-				    'type'	=> 'other_entries',
-				    'desc'	=> __('Display other entries created by the entry creator.', 'gravityview'),
-			    ),
-	        );
+				'other_entries' => array(
+					'label'	=> __('Other Entries', 'gravityview'),
+					'type'	=> 'other_entries',
+					'desc'	=> __('Display other entries created by the entry creator.', 'gravityview'),
+				),
+			);
 
 			if( 'single' !== $zone) {
 
@@ -920,9 +920,9 @@ 
 
 				$joined_forms = gravityview_get_joined_forms( $post->ID );
 
-                foreach ( $joined_forms as $form ) {
-                    $available_items[ $form->ID ] = $this->get_available_fields( $form->ID, $zone );
-                }
+				foreach ( $joined_forms as $form ) {
+					$available_items[ $form->ID ] = $this->get_available_fields( $form->ID, $zone );
+				}
 			} else {
 				$available_items[ $form ] = \GV\Widget::registered();
 			}
@@ -950,9 +950,9 @@ 
 
 										if ( $form_id ) {
 											$original_item = isset( $available_items[ $form_id ] [ $field['id'] ] ) ? $available_items[ $form_id ] [ $field['id'] ] : false ;
-                                        } else {
+										} else {
 											$original_item = isset( $available_items[ $field['id'] ] ) ? $available_items[ $field['id'] ] : false ;
-                                        }
+										}
 
 										if ( !$original_item ) {
 											gravityview()->log->error( 'An item was not available when rendering the output; maybe it was added by a plugin that is now de-activated.', array(' data' => array('available_items' => $available_items, 'field' => $field ) ) );
@@ -1004,7 +1004,7 @@ 
 
 	/**
 	 * Render the widget active areas
-     * @param  string $template_id The current slug of the selected View template
+	 * @param  string $template_id The current slug of the selected View template
 	 * @param  string $zone    Either 'header' or 'footer'
 	 * @param  string $post_id Current Post ID (view)
 	 * @return string          html
@@ -1186,7 +1186,7 @@ 
 		$is_widgets_page = ( $pagenow === 'widgets.php' );
 
 		// Add the GV font (with the Astronaut)
-        wp_enqueue_style( 'gravityview_global', plugins_url('assets/css/admin-global.css', GRAVITYVIEW_FILE), array(), \GV\Plugin::$version );
+		wp_enqueue_style( 'gravityview_global', plugins_url('assets/css/admin-global.css', GRAVITYVIEW_FILE), array(), \GV\Plugin::$version );
 		wp_register_style( 'gravityview_views_styles', plugins_url( 'assets/css/admin-views.css', GRAVITYVIEW_FILE ), array( 'dashicons', 'wp-jquery-ui-dialog' ), \GV\Plugin::$version );
 
 		wp_register_script( 'gravityview-jquery-cookie', plugins_url('assets/lib/jquery.cookie/jquery.cookie.min.js', GRAVITYVIEW_FILE), array( 'jquery' ), \GV\Plugin::$version, true );
@@ -1194,66 +1194,66 @@ 
 		if( GFForms::get_page() === 'form_list' ) {
 			wp_enqueue_style( 'gravityview_views_styles' );
 			return;
-        }
+		}
 
 		// Don't process any scripts below here if it's not a GravityView page.
 		if( ! gravityview()->request->is_admin( $hook, 'single' ) && ! $is_widgets_page ) {
-		    return;
+			return;
 		}
 
-        wp_enqueue_script( 'jquery-ui-datepicker' );
-        wp_enqueue_style( 'gravityview_views_datepicker', plugins_url('assets/css/admin-datepicker.css', GRAVITYVIEW_FILE), \GV\Plugin::$version );
-
-        $script_debug = (defined('SCRIPT_DEBUG') && SCRIPT_DEBUG) ? '' : '.min';
-
-        //enqueue scripts
-        wp_enqueue_script( 'gravityview_views_scripts', plugins_url( 'assets/js/admin-views' . $script_debug . '.js', GRAVITYVIEW_FILE ), array( 'jquery-ui-tabs', 'jquery-ui-draggable', 'jquery-ui-droppable', 'jquery-ui-sortable', 'jquery-ui-tooltip', 'jquery-ui-dialog', 'gravityview-jquery-cookie', 'jquery-ui-datepicker', 'underscore' ), \GV\Plugin::$version );
-
-        wp_localize_script('gravityview_views_scripts', 'gvGlobals', array(
-            'cookiepath' => COOKIEPATH,
-            'passed_form_id' => (bool) \GV\Utils::_GET( 'form_id' ),
-            'nonce' => wp_create_nonce( 'gravityview_ajaxviews' ),
-            'label_viewname' => __( 'Enter View name here', 'gravityview' ),
-            'label_reorder_search_fields' => __( 'Reorder Search Fields', 'gravityview' ),
-            'label_add_search_field' => __( 'Add Search Field', 'gravityview' ),
-            'label_remove_search_field' => __( 'Remove Search Field', 'gravityview' ),
-            'label_close' => __( 'Close', 'gravityview' ),
-            'label_cancel' => __( 'Cancel', 'gravityview' ),
-            'label_continue' => __( 'Continue', 'gravityview' ),
-            'label_ok' => __( 'Ok', 'gravityview' ),
-            'label_publisherror' => __( 'Error while creating the View for you. Check the settings or contact GravityView support.', 'gravityview' ),
-            'loading_text' => esc_html__( 'Loading&hellip;', 'gravityview' ),
-            'loading_error' => esc_html__( 'There was an error loading dynamic content.', 'gravityview' ),
-            'field_loaderror' => __( 'Error while adding the field. Please try again or contact GravityView support.', 'gravityview' ),
-            'remove_all_fields' => __( 'Would you like to remove all fields in this zone? (You are seeing this message because you were holding down the ALT key)', 'gravityview' ),
-        ));
+		wp_enqueue_script( 'jquery-ui-datepicker' );
+		wp_enqueue_style( 'gravityview_views_datepicker', plugins_url('assets/css/admin-datepicker.css', GRAVITYVIEW_FILE), \GV\Plugin::$version );
+
+		$script_debug = (defined('SCRIPT_DEBUG') && SCRIPT_DEBUG) ? '' : '.min';
+
+		//enqueue scripts
+		wp_enqueue_script( 'gravityview_views_scripts', plugins_url( 'assets/js/admin-views' . $script_debug . '.js', GRAVITYVIEW_FILE ), array( 'jquery-ui-tabs', 'jquery-ui-draggable', 'jquery-ui-droppable', 'jquery-ui-sortable', 'jquery-ui-tooltip', 'jquery-ui-dialog', 'gravityview-jquery-cookie', 'jquery-ui-datepicker', 'underscore' ), \GV\Plugin::$version );
+
+		wp_localize_script('gravityview_views_scripts', 'gvGlobals', array(
+			'cookiepath' => COOKIEPATH,
+			'passed_form_id' => (bool) \GV\Utils::_GET( 'form_id' ),
+			'nonce' => wp_create_nonce( 'gravityview_ajaxviews' ),
+			'label_viewname' => __( 'Enter View name here', 'gravityview' ),
+			'label_reorder_search_fields' => __( 'Reorder Search Fields', 'gravityview' ),
+			'label_add_search_field' => __( 'Add Search Field', 'gravityview' ),
+			'label_remove_search_field' => __( 'Remove Search Field', 'gravityview' ),
+			'label_close' => __( 'Close', 'gravityview' ),
+			'label_cancel' => __( 'Cancel', 'gravityview' ),
+			'label_continue' => __( 'Continue', 'gravityview' ),
+			'label_ok' => __( 'Ok', 'gravityview' ),
+			'label_publisherror' => __( 'Error while creating the View for you. Check the settings or contact GravityView support.', 'gravityview' ),
+			'loading_text' => esc_html__( 'Loading&hellip;', 'gravityview' ),
+			'loading_error' => esc_html__( 'There was an error loading dynamic content.', 'gravityview' ),
+			'field_loaderror' => __( 'Error while adding the field. Please try again or contact GravityView support.', 'gravityview' ),
+			'remove_all_fields' => __( 'Would you like to remove all fields in this zone? (You are seeing this message because you were holding down the ALT key)', 'gravityview' ),
+		));
 
 		wp_enqueue_style( 'gravityview_views_styles' );
 
-        // Enqueue scripts needed for merge tags
-        self::enqueue_gravity_forms_scripts();
+		// Enqueue scripts needed for merge tags
+		self::enqueue_gravity_forms_scripts();
 	}
 
 	/**
 	 * Enqueue Gravity Forms scripts, needed for Merge Tags
-     *
-     * @since 1.0.5-beta
-     *
-     * @return void
+	 *
+	 * @since 1.0.5-beta
+	 *
+	 * @return void
 	 */
 	static function enqueue_gravity_forms_scripts() {
 		GFForms::register_scripts();
 
 		$scripts = array(
-		    'sack',
-		    'gform_gravityforms',
-		    'gform_forms',
-		    'gform_form_admin',
-		    'jquery-ui-autocomplete'
+			'sack',
+			'gform_gravityforms',
+			'gform_forms',
+			'gform_form_admin',
+			'jquery-ui-autocomplete'
 		);
 
 		if ( wp_is_mobile() ) {
-		    $scripts[] = 'jquery-touch-punch';
+			$scripts[] = 'jquery-touch-punch';
 		}
 
 		wp_enqueue_script( $scripts );