WordImpress / Give

includes/forms/template.php

Doc Comments +5 added lines, -5 removed lines

@@ -21,7 +21,7 @@ 
  *
  * @param  array $args An array of form arguments.
  *
- * @return string Donation form.
+ * @return false|null Donation form.
  */
 function give_get_donation_form( $args = array() ) {
 
@@ -1470,7 +1470,7 @@ 
  *
  * @param  int $form_id The form ID.
  *
- * @return bool
+ * @return false|null
  */
 function give_terms_agreement( $form_id ) {
 	$form_option = give_get_meta( $form_id, '_give_terms_option', true );
@@ -1647,7 +1647,7 @@ 
  * @param  int   $form_id The form ID.
  * @param  array $args    An array of form arguments.
  *
- * @return mixed
+ * @return boolean
  */
 function give_show_goal_progress( $form_id, $args ) {
 
@@ -1667,7 +1667,7 @@ 
  *
  * @since  1.8
  *
- * @param  $form_id
+ * @param  integer $form_id
  * @param  $args
  *
  * @return mixed|string
@@ -1708,7 +1708,7 @@ 
  * @param  int   $form_id The form ID.
  * @param  array $args    An array of form arguments.
  *
- * @return void|bool
+ * @return false|null
  */
 function give_form_content( $form_id, $args ) {
 

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
  */
@@ -1163,7 +1163,7 @@ 
  * @params $string text
  * @params $filter array
  *
- * @return text $string
+ * @return string $string
  */
 function give_slug_to_title( $string, $filters = array() ) {
 

includes/admin/payments/class-payments-table.php

Doc Comments +4 added lines, -4 removed lines

@@ -490,7 +490,7 @@ 
 	/**
 	 * Get donor email html.
 	 *
-	 * @param object $payment Contains all the data of the payment.
+	 * @param Give_Payment $payment Contains all the data of the payment.
 	 *
 	 * @access public
 	 * @since  1.0
@@ -513,7 +513,7 @@ 
 	/**
 	 * Get Row Actions
 	 *
-	 * @param object $payment Payment Data.
+	 * @param Give_Payment $payment Payment Data.
 	 *
 	 * @since 1.6
 	 *
@@ -565,7 +565,7 @@ 
 	/**
 	 *  Get payment status html.
 	 *
-	 * @param object $payment Contains all the data of the payment.
+	 * @param Give_Payment $payment Contains all the data of the payment.
 	 *
 	 * @access public
 	 * @since  1.0
@@ -615,7 +615,7 @@ 
 	/**
 	 * Get donor html.
 	 *
-	 * @param object $payment Contains all the data of the payment.
+	 * @param Give_Payment $payment Contains all the data of the payment.
 	 *
 	 * @access public
 	 * @since  1.0

includes/ajax-functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -521,7 +521,7 @@
  *
  * @since 1.8.17
  *
- * @return bool
+ * @return false|null
  */
 function give_confirm_email_for_donation_access() {
 

includes/class-give-email-access.php

Doc Comments +1 added lines, -1 removed lines

@@ -242,7 +242,7 @@
 	 * @since  1.0
 	 * @access public
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function check_for_token() {
 

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() {
 
@@ -749,7 +749,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/login-register.php

Doc Comments +3 added lines, -3 removed lines

@@ -180,7 +180,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 ) {
 
@@ -221,7 +221,7 @@ 
  *
  * @param array $data Data sent from the register form
  *
- * @return bool
+ * @return false|null
  */
 function give_process_register_form( $data ) {
 
@@ -307,7 +307,7 @@ 
  *
  * @since 1.8.17
  *
- * @return bool
+ * @return boolean|null
  */
 function give_email_access_login() {
 

includes/misc-functions.php

Doc Comments +4 added lines, -4 removed lines

@@ -212,7 +212,7 @@ 
  *
  * @since 1.8.17
  *
- * @return array|string
+ * @return boolean
  */
 function give_get_history_session() {
 	return (bool) Give()->session->get( 'history_access' );
@@ -685,7 +685,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() {
 
@@ -1084,7 +1084,7 @@ 
  * @param int    $id
  * @param string $meta_key
  * @param mixed  $meta_value
- * @param mixed  $prev_value
+ * @param string  $prev_value
  *
  * @return mixed
  */
@@ -1291,7 +1291,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/payments/class-give-payment.php

Doc Comments +2 added lines, -2 removed lines

@@ -391,7 +391,7 @@ 
 	 *
 	 * @param  int|bool $payment_id A given payment
 	 *
-	 * @return mixed void|false
+	 * @return false|null void|false
 	 */
 	public function __construct( $payment_id = false ) {
 
@@ -1115,7 +1115,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.