woocommerce / woocommerce

includes/class-wc-post-types.php

Doc Comments +1 added lines, -1 removed lines

@@ -580,7 +580,7 @@
 	 * Added product for Jetpack related posts.
 	 *
 	 * @param  array $post_types Post types.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function rest_api_allowed_post_types( $post_types ) {
 		$post_types[] = 'product';

includes/class-wc-structured-data.php

Doc Comments +1 added lines, -1 removed lines

@@ -370,7 +370,7 @@
 	 *
 	 * Hooked into `woocommerce_email_order_details` action hook.
 	 *
-	 * @param WP_Order $order         Order data.
+	 * @param WC_Order $order         Order data.
 	 * @param bool     $sent_to_admin Send to admin (default: false).
 	 * @param bool     $plain_text    Plain text email (default: false).
 	 */

includes/abstracts/abstract-wc-order.php

Doc Comments +3 added lines, -3 removed lines

@@ -90,7 +90,7 @@ 
 	 * should be used. It is possible, but the aforementioned are preferred and are the only.
 	 * methods that will be maintained going forward.
 	 *
-	 * @param  int|object|WC_Order $order Order to read.
+	 * @param  integer $order Order to read.
 	 */
 	public function __construct( $order = 0 ) {
 		parent::__construct( $order );
@@ -1237,7 +1237,7 @@ 
 	 * Calculate shipping total.
 	 *
 	 * @since 2.2
-	 * @return float
+	 * @return string
 	 */
 	public function calculate_shipping() {
 		$shipping_total = 0;
@@ -1474,7 +1474,7 @@ 
 	/**
 	 * Get item subtotal - this is the cost before discount.
 	 *
-	 * @param object $item Item to get total from.
+	 * @param WC_Order_Item $item Item to get total from.
 	 * @param bool   $inc_tax (default: false).
 	 * @param bool   $round (default: true).
 	 * @return float

includes/gateways/paypal/includes/class-wc-gateway-paypal-pdt-handler.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
 	 * Validate a PDT transaction to ensure its authentic.
 	 *
 	 * @param  string $transaction TX ID.
-	 * @return bool|array False or result array if successful and valid.
+	 * @return WC_Order False or result array if successful and valid.
 	 */
 	protected function validate_transaction( $transaction ) {
 		$pdt = array(

includes/wc-formatting-functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -1350,7 +1350,7 @@
  *
  * @since 3.4.0
  * @param mixed $raw_value Value stored in DB.
- * @return array Nicely formatted array with number and unit values.
+ * @return integer Nicely formatted array with number and unit values.
  */
 function wc_parse_relative_date_option( $raw_value ) {
 	$periods = array(

includes/wc-template-functions.php

Doc Comments +4 added lines, -4 removed lines

@@ -202,7 +202,7 @@ 
  * @since 3.3.0
  * @param string $prop Prop to get.
  * @param string $default Default if the prop does not exist.
- * @return mixed
+ * @return string
  */
 function wc_get_loop_prop( $prop, $default = '' ) {
 	wc_setup_loop(); // Ensure shop loop is setup.
@@ -262,7 +262,7 @@ 
  * Add body classes for WC pages.
  *
  * @param  array $classes Body Classes.
- * @return array
+ * @return string[]
  */
 function wc_body_class( $classes ) {
 	$classes = (array) $classes;
@@ -656,7 +656,7 @@ 
  *
  * @since 3.0.0
  * @param string|array $values Name value pairs, or a URL to parse.
- * @param array        $exclude Keys to exclude.
+ * @param string[]        $exclude Keys to exclude.
  * @param string       $current_key Current key we are outputting.
  * @param bool         $return Whether to return.
  * @return string
@@ -1699,7 +1699,7 @@ 
 			 *
 			 * @param array $a Comparison A.
 			 * @param array $b Comparison B.
-			 * @return bool
+			 * @return integer
 			 */
 			function _sort_priority_callback( $a, $b ) {
 				if ( ! isset( $a['priority'], $b['priority'] ) || $a['priority'] === $b['priority'] ) {

includes/wc-order-item-functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
  * @param array $item_array Items list.
  *
  * @throws Exception        When `WC_Data_Store::load` validation fails.
- * @return int|bool         Item ID or false
+ * @return integer         Item ID or false
  */
 function wc_add_order_item( $order_id, $item_array ) {
 	$order_id = absint( $order_id );

includes/wc-rest-functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -338,7 +338,7 @@
  *
  * @since 3.5.0
  * @param string $context   Request context.
- * @param string $object_id Object ID.
+ * @param integer $object_id Object ID.
  * @return bool
  */
 function wc_rest_check_product_reviews_permissions( $context = 'read', $object_id = 0 ) {

includes/class-wc-order-factory.php

Doc Comments +2 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
 	 * Get order item.
 	 *
 	 * @param int $item_id Order item ID to get.
-	 * @return WC_Order_Item|false if not found
+	 * @return WC_Order_Item if not found
 	 */
 	public static function get_order_item( $item_id = 0 ) {
 		if ( is_numeric( $item_id ) ) {
@@ -111,7 +111,7 @@ 
 	 *
 	 * @since 3.0.0
 	 * @param  mixed $order Order data to convert to an ID.
-	 * @return int|bool false on failure
+	 * @return boolean false on failure
 	 */
 	public static function get_order_id( $order ) {
 		global $post;