WordImpress / Give

includes/actions.php

Doc Comments -1 removed lines

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

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/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

@@ -161,7 +161,7 @@ 
 	 * @since  1.0
 	 * @access public
 	 *
-	 * @param  bool|string|int $_id_or_email
+	 * @param  integer $_id_or_email
 	 *
 	 * @return bool|int
 	 */
@@ -316,7 +316,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 ) {
 
@@ -373,7 +373,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

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

includes/class-notices.php

Doc Comments +1 added lines, -1 removed lines

@@ -435,7 +435,7 @@
 	 * @since  1.8.9
 	 * @access public
 	 *
-	 * @param $errors
+	 * @param string $errors
 	 */
 	static function print_frontend_errors( $errors ) {
 		if ( ! $errors ) {

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/payments/class-payment-stats.php

Doc Comments +3 added lines, -3 removed lines

@@ -36,7 +36,7 @@ 
 	 * @param  $end_date   string|bool  The end date for which we'd like to filter our sale stats. If false, we'll use the default end date of `this_month`
 	 * @param  $status     string|array The sale status(es) to count. Only valid when retrieving global stats
 	 *
-	 * @return float|int                Total amount of donations based on the passed arguments.
+	 * @return string                Total amount of donations based on the passed arguments.
 	 */
 	public function get_sales( $form_id = 0, $start_date = false, $end_date = false, $status = 'publish' ) {
 
@@ -83,7 +83,7 @@ 
 	 * @param  $end_date    string|bool The end date for which we'd like to filter the donations stats. If false, method will use the default end date of `this_month`.
 	 * @param  $gateway_id  string|bool The gateway to get earnings for such as 'paypal' or 'stripe'.
 	 *
-	 * @return float|int                Total amount of donations based on the passed arguments.
+	 * @return string                Total amount of donations based on the passed arguments.
 	 */
 	public function get_earnings( $form_id = 0, $start_date = false, $end_date = false, $gateway_id = false ) {
 		$this->setup_dates( $start_date, $end_date );
@@ -168,7 +168,7 @@ 
 	 * @param  $end_date    string|bool The end date for which we'd like to filter our sale stats. If false, we'll use the default end date of `this_month`
 	 * @param  $gateway_id  string|bool The gateway to get earnings for such as 'paypal' or 'stripe'
 	 *
-	 * @return float|int                Total amount of donations based on the passed arguments.
+	 * @return string                Total amount of donations based on the passed arguments.
 	 */
 	public function get_earnings_cache_key( $form_id = 0, $start_date = false, $end_date = false, $gateway_id = false ) {
 

includes/payments/functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -681,7 +681,7 @@ 
  * @param  int $year      Year number. Default is null.
  * @param  int $hour      Hour number. Default is null.
  *
- * @return int $earnings  Earnings
+ * @return double $earnings  Earnings
  */
 function give_get_earnings_by_date( $day = null, $month_num, $year = null, $hour = null ) {
 
@@ -970,7 +970,7 @@ 
  *
  * @param int $payment_id Payment ID.
  *
- * @return array $user_info User Info Meta Values.
+ * @return string $user_info User Info Meta Values.
  */
 function give_get_payment_meta_user_info( $payment_id ) {
 	$payment = new Give_Payment( $payment_id );
@@ -987,7 +987,7 @@ 
  *
  * @param int $payment_id Payment ID.
  *
- * @return int $form_id Form ID.
+ * @return string $form_id Form ID.
  */
 function give_get_payment_form_id( $payment_id ) {
 	$payment = new Give_Payment( $payment_id );