Completed
Pull Request — master (#857)
by
unknown
16:49
created
includes/error-tracking.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -65,7 +65,7 @@
 block discarded – undo
65 65
  *
66 66
  * @since 1.0
67 67
  * @uses  Give_Session::get()
68
- * @return mixed array if errors are present, false if none found
68
+ * @return string array if errors are present, false if none found
69 69
  */
70 70
 function give_get_errors() {
71 71
 	return Give()->session->get( 'give_errors' );
Please login to merge, or discard this patch.
includes/misc-functions.php 1 patch
Doc Comments   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -337,7 +337,7 @@  discard block
 block discarded – undo
337 337
  *
338 338
  * @since 1.0
339 339
  * @uses  Give()->session->get()
340
- * @return mixed array | false
340
+ * @return string array | false
341 341
  */
342 342
 function give_get_purchase_session() {
343 343
 	return Give()->session->get( 'give_purchase' );
@@ -695,9 +695,9 @@  discard block
 block discarded – undo
695 695
 /**
696 696
  * Create SVG library function
697 697
  *
698
- * @param $icon
698
+ * @param string $icon
699 699
  *
700
- * @return mixed
700
+ * @return string
701 701
  */
702 702
 function give_svg_icons( $icon ) {
703 703
 
@@ -754,7 +754,7 @@  discard block
 block discarded – undo
754 754
 	 *
755 755
 	 * @param array $input A multi-dimensional array (record set) from which to pull
756 756
 	 *                         a column of values.
757
-	 * @param mixed $columnKey The column of values to return. This value may be the
757
+	 * @param string $columnKey The column of values to return. This value may be the
758 758
 	 *                         integer key of the column you wish to retrieve, or it
759 759
 	 *                         may be the string key name for an associative array.
760 760
 	 * @param mixed $indexKey (Optional.) The column to use as the index/keys for
@@ -908,7 +908,7 @@  discard block
 block discarded – undo
908 908
 	/**
909 909
 	 * cal_days_in_month
910 910
 	 *
911
-	 * @param $calendar
911
+	 * @param integer $calendar
912 912
 	 * @param $month
913 913
 	 * @param $year
914 914
 	 *
Please login to merge, or discard this patch.
includes/admin/class-give-settings.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -89,7 +89,7 @@  discard block
 block discarded – undo
89 89
 	 *
90 90
 	 * @param $url
91 91
 	 *
92
-	 * @return mixed
92
+	 * @return string
93 93
 	 */
94 94
 	public function give_update_cmb_meta_box_url( $url ) {
95 95
 		//Path to Give's CMB
@@ -873,7 +873,7 @@  discard block
 block discarded – undo
873 873
  * @since 1.0
874 874
  *
875 875
  * @param string          $key The Key to update
876
- * @param string|bool|int $value The value to set the key to
876
+ * @param integer $value The value to set the key to
877 877
  *
878 878
  * @return boolean True if updated, false if not.
879 879
  */
@@ -974,7 +974,7 @@  discard block
 block discarded – undo
974 974
  * @since      1.3.5
975 975
  *
976 976
  * @param $array
977
- * @param $position |int|string Expects an array key or 'id' of the settings field to appear after
977
+ * @param string $position |int|string Expects an array key or 'id' of the settings field to appear after
978 978
  * @param $insert |array a valid array of options to insert
979 979
  *
980 980
  * @return array
Please login to merge, or discard this patch.
includes/formatting.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -242,7 +242,7 @@  discard block
 block discarded – undo
242 242
  * @param $field_args
243 243
  * @param $field
244 244
  *
245
- * @return bool
245
+ * @return false|null
246 246
  */
247 247
 function give_format_admin_multilevel_amount( $field_args, $field ) {
248 248
 
@@ -391,7 +391,7 @@  discard block
 block discarded – undo
391 391
  * @param array  $field_args
392 392
  * @param object $field
393 393
  *
394
- * @return mixed
394
+ * @return string
395 395
  */
396 396
 function give_sanitize_thousand_separator( $value, $field_args, $field ){
397 397
     return $value;
@@ -422,7 +422,7 @@  discard block
 block discarded – undo
422 422
  * @param array  $field_args
423 423
  * @param object $field
424 424
  *
425
- * @return mixed
425
+ * @return string
426 426
  */
427 427
 function give_sanitize_price_field_value( $value, $field_args, $field ){
428 428
     return give_sanitize_amount( $value );
Please login to merge, or discard this patch.
includes/class-give-db-customers.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -158,7 +158,7 @@  discard block
 block discarded – undo
158 158
 	 * @since  1.0
159 159
 	 * @access public
160 160
 	 *
161
-	 * @param  bool|string|int $_id_or_email
161
+	 * @param  integer $_id_or_email
162 162
 	 *
163 163
 	 * @return bool|int
164 164
 	 */
@@ -313,7 +313,7 @@  discard block
 block discarded – undo
313 313
 	 * @param  int     $user_id       User ID.
314 314
 	 * @param  WP_User $old_user_data User data.
315 315
 	 *
316
-	 * @return bool
316
+	 * @return false|null
317 317
 	 */
318 318
 	public function update_customer_email_on_user_update( $user_id = 0, $old_user_data ) {
319 319
 
@@ -362,7 +362,7 @@  discard block
 block discarded – undo
362 362
 	 * @access public
363 363
 	 *
364 364
 	 * @param  string $field ID or email. Default is 'id'.
365
-	 * @param  mixed  $value The Customer ID or email to search. Default is 0.
365
+	 * @param  integer  $value The Customer ID or email to search. Default is 0.
366 366
 	 *
367 367
 	 * @return mixed         Upon success, an object of the customer. Upon failure, NULL
368 368
 	 */
Please login to merge, or discard this patch.
includes/class-give-donate-form.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -329,7 +329,7 @@  discard block
 block discarded – undo
329 329
 	 * @param  bool  $_id   Post id. Default is false.
330 330
 	 * @param  array $_args Arguments passed.
331 331
 	 *
332
-	 * @return void
332
+	 * @return boolean
333 333
 	 */
334 334
 	public function __construct( $_id = false, $_args = array() ) {
335 335
 
@@ -412,7 +412,7 @@  discard block
 block discarded – undo
412 412
 	 *
413 413
 	 * @param  array $data Array of attributes for a donation form.
414 414
 	 *
415
-	 * @return mixed       False if data isn't passed and class not instantiated for creation, or New Form ID.
415
+	 * @return boolean       False if data isn't passed and class not instantiated for creation, or New Form ID.
416 416
 	 */
417 417
 	public function create( $data = array() ) {
418 418
 
Please login to merge, or discard this patch.
includes/class-give-logging.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -223,7 +223,7 @@  discard block
 block discarded – undo
223 223
 	 * @param  array $log_data Log entry data.
224 224
 	 * @param  array $log_meta Log entry meta.
225 225
 	 *
226
-	 * @return bool            True if successful, false otherwise.
226
+	 * @return boolean|null            True if successful, false otherwise.
227 227
 	 */
228 228
 	public function update_log( $log_data = array(), $log_meta = array() ) {
229 229
 
@@ -406,7 +406,7 @@  discard block
 block discarded – undo
406 406
  * @param  int    $parent  Parent log. Default is 0.
407 407
  * @param  string $type    Log type. Default is null.
408 408
  *
409
- * @return mixed           ID of the new log entry.
409
+ * @return integer           ID of the new log entry.
410 410
  */
411 411
 function give_record_log( $title = '', $message = '', $parent = 0, $type = null ) {
412 412
 	/* @var Give_Logging $give_logs */
Please login to merge, or discard this patch.
includes/class-give-session.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -192,7 +192,7 @@
 block discarded – undo
192 192
 	 * @param  string $key   Session key.
193 193
 	 * @param  string $value Session variable.
194 194
 	 *
195
-	 * @return mixed         Session variable.
195
+	 * @return string         Session variable.
196 196
 	 */
197 197
 	public function set( $key, $value ) {
198 198
 
Please login to merge, or discard this patch.
includes/forms/functions.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -156,7 +156,7 @@  discard block
 block discarded – undo
156 156
  * Used to redirect a user back to the purchase
157 157
  * page if there are errors present.
158 158
  *
159
- * @param array $args
159
+ * @param string $args
160 160
  *
161 161
  * @access public
162 162
  * @since  1.0
@@ -390,7 +390,7 @@  discard block
 block discarded – undo
390 390
  *
391 391
  * @param int $form_id Give Form ID
392 392
  *
393
- * @return int $earnings Earnings for a certain form
393
+ * @return double $earnings Earnings for a certain form
394 394
  */
395 395
 function give_get_form_earnings_stats( $form_id = 0 ) {
396 396
 	$give_form = new Give_Donate_Form( $form_id );
Please login to merge, or discard this patch.