ravinderk / Give

includes/class-give-cache.php

Doc Comments +1 added lines, -1 removed lines

@@ -205,7 +205,7 @@
 	 *
 	 * @param bool $force If set to true then all cached values will be delete instead of only expired
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public static function delete_all_expired( $force = false ) {
 		global $wpdb;

includes/admin/class-give-settings.php

Doc Comments +5 added lines, -5 removed lines

@@ -72,7 +72,7 @@ 
 	 *
 	 * @param $url
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function give_update_cmb_meta_box_url( $url ) {
 		// Path to Give's CMB
@@ -935,7 +935,7 @@ 
  * @since      1.3.5
  *
  * @param $array
- * @param $position |int|string Expects an array key or 'id' of the settings field to appear after
+ * @param string $position |int|string Expects an array key or 'id' of the settings field to appear after
  * @param $insert   |array a valid array of options to insert
  *
  * @return array
@@ -974,7 +974,7 @@ 
  * @since 1.0
  *
  * @param array $field_arr
- * @param array $saved_values
+ * @param string|boolean $saved_values
  *
  * @return void
  */
@@ -1009,7 +1009,7 @@ 
  * @since  1.0
  *
  * @param  array $field_arr
- * @param  array $saved_value
+ * @param  string|boolean $saved_value
  *
  * @return void
  */
@@ -1170,7 +1170,7 @@ 
  *  @params $string text
  *  @params $filter array
  *
- *  @return text $string
+ *  @return string $string
  */
 function give_slug_to_title( $string, $filters = array() ){
 

includes/admin/donors/donor-actions.php

Doc Comments +3 added lines, -3 removed lines

@@ -272,7 +272,7 @@ 
  *
  * @param  array $args The $_POST array being passed.
  *
- * @return int Whether it was a successful deletion.
+ * @return false|null Whether it was a successful deletion.
  */
 function give_donor_delete( $args ) {
 
@@ -546,7 +546,7 @@ 
  * Remove an email address to the donor from within the admin and log a donor note and redirect back to the donor interface for feedback.
  *
  * @since  1.7
- * @return bool|null
+ * @return false|null
  */
 function give_remove_donor_email() {
 	if ( empty( $_GET['id'] ) || ! is_numeric( $_GET['id'] ) ) {
@@ -589,7 +589,7 @@ 
  * and redirect back to the donor interface for feedback
  *
  * @since  1.7
- * @return bool|null
+ * @return false|null
  */
 function give_set_donor_primary_email() {
 	if ( empty( $_GET['id'] ) || ! is_numeric( $_GET['id'] ) ) {

includes/class-give-donor.php

Doc Comments +2 added lines, -2 removed lines

@@ -889,7 +889,7 @@ 
 	 * @access public
 	 *
 	 * @param  string $meta_key Metadata name. Default is empty.
-	 * @param  mixed $meta_value Metadata value.
+	 * @param  string $meta_value Metadata value.
 	 * @param  bool $unique Optional. Whether the same key should not be added. Default is false.
 	 *
 	 * @return bool               False for failure. True for success.
@@ -921,7 +921,7 @@ 
 	 * @access public
 	 *
 	 * @param  string $meta_key Metadata name. Default is empty.
-	 * @param  mixed $meta_value Optional. Metadata value. Default is empty.
+	 * @param  string $meta_value Optional. Metadata value. Default is empty.
 	 *
 	 * @return bool               False for failure. True for success.
 	 */

includes/api/class-give-api.php

Doc Comments +3 added lines, -3 removed lines

@@ -216,7 +216,7 @@ 
 	 *
 	 * @access public
 	 * @since  1.1
-	 * @return array
+	 * @return string
 	 */
 	public function get_versions() {
 		return $this->versions;
@@ -302,7 +302,7 @@ 
 	 * @uses   Give_API::invalid_key()
 	 * @uses   Give_API::invalid_auth()
 	 * @since  1.1
-	 * @return bool
+	 * @return false|null
 	 */
 	private function validate_request() {
 		global $wp_query;
@@ -694,7 +694,7 @@ 
 	 *
 	 * @param array $args Arguments to override defaults
 	 *
-	 * @return array $dates
+	 * @return integer|null $dates
 	 */
 	public function get_dates( $args = array() ) {
 		$dates = array();

includes/class-give-db-donors.php

Doc Comments +3 added lines, -3 removed lines

@@ -158,7 +158,7 @@ 
 	 * @since  1.0
 	 * @access public
 	 *
-	 * @param  bool|string|int $_id_or_email
+	 * @param  integer $_id_or_email
 	 *
 	 * @return bool|int
 	 */
@@ -313,7 +313,7 @@ 
 	 * @param  int          $user_id       User ID.
 	 * @param  WP_User|bool $old_user_data User data.
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public function update_donor_email_on_user_update( $user_id = 0, $old_user_data = false ) {
 
@@ -370,7 +370,7 @@ 
 	 * @access public
 	 *
 	 * @param  string $field ID or email. Default is 'id'.
-	 * @param  mixed  $value The Customer ID or email to search. Default is 0.
+	 * @param  integer  $value The Customer ID or email to search. Default is 0.
 	 *
 	 * @return mixed         Upon success, an object of the donor. Upon failure, NULL
 	 */

includes/class-give-license-handler.php

Doc Comments +3 added lines, -3 removed lines

@@ -683,7 +683,7 @@ 
 		 * @access private
 		 * @since  1.7
 		 *
-		 * @return bool
+		 * @return false|null
 		 */
 		private function __remove_license_key_from_subscriptions() {
 			$subscriptions = get_option( 'give_subscriptions', array() );
@@ -782,7 +782,7 @@ 
 		 * @param $plugin_data
 		 * @param $status
 		 *
-		 * @return bool
+		 * @return false|null
 		 */
 		public function plugin_page_notices( $plugin_file, $plugin_data, $status ) {
 			// Bailout.
@@ -804,7 +804,7 @@ 
 		 *
 		 * @since  1.8.7
 		 * @access public
-		 * @return array
+		 * @return string
 		 */
 		public function license_state_message() {
 			$message_data = array();

includes/login-register.php

Doc Comments +2 added lines, -2 removed lines

@@ -174,7 +174,7 @@ 
  * @param string $user_login Username
  * @param string $user_pass  Password
  *
- * @return bool
+ * @return false|null
  */
 function give_log_user_in( $user_id, $user_login, $user_pass ) {
 
@@ -215,7 +215,7 @@ 
  *
  * @param array $data Data sent from the register form
  *
- * @return bool
+ * @return false|null
  */
 function give_process_register_form( $data ) {
 

includes/actions.php

Doc Comments -1 removed lines

@@ -217,7 +217,6 @@
 /**
  * Set Donation Amount for Multi Level Donation Forms
  *
- * @param int    $form_id
  * @param object $form
  *
  * @since 1.8.9