ravinderk / Give

includes/misc-functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -1157,7 +1157,7 @@ 
  *
  * @todo  Remove this, when WordPress Core ticket is resolved (https://core.trac.wordpress.org/ticket/16828).
  *
- * @return bool
+ * @return false|null
  */
 function give_donation_metabox_menu() {
 
@@ -1540,7 +1540,7 @@ 
  * @param int    $id
  * @param string $meta_key
  * @param mixed  $meta_value
- * @param mixed  $prev_value
+ * @param string  $prev_value
  *
  * @return mixed
  */
@@ -1747,7 +1747,7 @@ 
  * @since 1.8.13
  *
  * @param array      $list      List of objects or arrays
- * @param int|string $field     Field from the object to place instead of the entire object
+ * @param string $field     Field from the object to place instead of the entire object
  * @param int|string $index_key Optional. Field from the object to use as keys for the new array.
  *                              Default null.
  *

includes/admin/donors/class-donor-table.php

Doc Comments +1 added lines, -1 removed lines

@@ -258,7 +258,7 @@
 	 * @access public
 	 * @since  1.0
 	 *
-	 * @return mixed string If search is present, false otherwise.
+	 * @return string|false string If search is present, false otherwise.
 	 */
 	public function get_search() {
 		return ! empty( $_GET['s'] ) ? urldecode( trim( $_GET['s'] ) ) : false;

includes/admin/donors/donor-actions.php

Doc Comments +4 added lines, -4 removed lines

@@ -21,7 +21,7 @@ 
  *
  * @since 1.0
  *
- * @return array|bool $output Response messages
+ * @return false|null $output Response messages
  */
 function give_edit_donor( $args ) {
 
@@ -227,7 +227,7 @@ 
  *
  * @since 1.0
  *
- * @return int Whether it was a successful deletion.
+ * @return false|null Whether it was a successful deletion.
  */
 function give_donor_delete( $args ) {
 
@@ -521,7 +521,7 @@ 
  *
  * @since  1.7
  *
- * @return bool|null
+ * @return false|null
  */
 function give_remove_donor_email() {
 	if ( empty( $_GET['id'] ) || ! is_numeric( $_GET['id'] ) ) {
@@ -565,7 +565,7 @@ 
  *
  * @since  1.7
  *
- * @return bool|null
+ * @return false|null
  */
 function give_set_donor_primary_email() {
 	if ( empty( $_GET['id'] ) || ! is_numeric( $_GET['id'] ) ) {

includes/payments/functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -705,7 +705,7 @@ 
  *
  * @since 1.0
  *
- * @return int $earnings Earnings
+ * @return double $earnings Earnings
  */
 function give_get_earnings_by_date( $day = null, $month_num, $year = null, $hour = null ) {
 
@@ -993,7 +993,7 @@ 
  *
  * @since 1.0
  *
- * @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 );
@@ -1010,7 +1010,7 @@ 
  *
  * @since 1.0
  *
- * @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 );

includes/admin/donors/donor-functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -88,7 +88,7 @@ 
 /**
  * Connect and Reconnect Donor with User profile.
  *
- * @param object $donor      Donor Object.
+ * @param Give_Donor $donor      Donor Object.
  * @param array  $donor_data Donor Post Variables.
  * @param array  $address    Address Information.
  *
@@ -174,7 +174,7 @@ 
  *
  * @since 1.8.17
  *
- * @return bool
+ * @return false|null
  */
 function give_delete_bulk_donors( $donor_id, $args ) {
 	$donor_edit_role = apply_filters( 'give_edit_donors_role', 'edit_give_payments' );

includes/forms/functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -155,7 +155,7 @@ 
  *
  * Used to redirect a user back to the donation form if there are errors present.
  *
- * @param array $args
+ * @param string $args
  *
  * @access public
  * @since  1.0
@@ -301,7 +301,7 @@ 
  * @since  1.0
  * @since  1.8.16 Add security check
  *
- * @return bool
+ * @return false|null
  */
 function give_listen_for_failed_payments() {
 
@@ -741,7 +741,7 @@ 
  *
  * @param int $form_id ID number of the form to retrieve the minimum price for
  *
- * @return mixed string|int Minimum price of the form
+ * @return string string|int Minimum price of the form
  */
 function give_get_form_minimum_price( $form_id = 0 ) {
 

includes/payments/class-give-payment.php

Doc Comments +2 added lines, -2 removed lines

@@ -392,7 +392,7 @@ 
 	 *
 	 * @param  int|bool $payment_id A given payment
 	 *
-	 * @return mixed void|false
+	 * @return false|null void|false
 	 */
 	public function __construct( $payment_id = false ) {
 
@@ -1106,7 +1106,7 @@ 
 	 *
 	 * @param  string|bool $note The note to add
 	 *
-	 * @return bool           If the note was specified or not
+	 * @return false|null           If the note was specified or not
 	 */
 	public function add_note( $note = false ) {
 		// Bail if no note specified.