woocommerce / woocommerce

includes/class-wc-regenerate-images.php

Doc Comments +2 added lines, -2 removed lines

@@ -276,7 +276,7 @@ 
 	/**
 	 * Ensure we are dealing with the correct image attachment
 	 *
-	 * @param int|WP_Post $attachment Attachment object or ID.
+	 * @param integer $attachment Attachment object or ID.
 	 * @return boolean
 	 */
 	public static function is_regeneratable( $attachment ) {
@@ -295,7 +295,7 @@ 
 	 * Only regenerate images for the requested size.
 	 *
 	 * @param array $sizes Array of image sizes.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function adjust_intermediate_image_sizes( $sizes ) {
 		return array( self::$regenerate_size );

includes/wc-core-functions.php

Doc Comments +5 added lines, -5 removed lines

@@ -153,7 +153,7 @@ 
  *
  * WC_TEMPLATE_DEBUG_MODE will prevent overrides in themes from taking priority.
  *
- * @param mixed  $slug Template slug.
+ * @param string  $slug Template slug.
  * @param string $name Template name (default: '').
  */
 function wc_get_template_part( $slug, $name = '' ) {
@@ -747,7 +747,7 @@ 
  * defines sizes.
  *
  * @param array|string $image_size Name of the image size to get, or an array of dimensions.
- * @return array Array of dimensions including width, height, and cropping mode. Cropping mode is 0 for no crop, and 1 for hard crop.
+ * @return string Array of dimensions including width, height, and cropping mode. Cropping mode is 0 for no crop, and 1 for hard crop.
  */
 function wc_get_image_size( $image_size ) {
 	$cache_key = 'size-' . ( is_array( $image_size ) ? implode( '-', $image_size ) : $image_size );
@@ -1851,7 +1851,7 @@ 
  *
  * @since 3.0.0
  * @param array      $list              List of objects or arrays.
- * @param int|string $callback_or_field Callback method from the object to place instead of the entire object.
+ * @param string $callback_or_field Callback method 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.
  * @return array Array of values.
@@ -1997,7 +1997,7 @@ 
  * @since  3.2.0
  * @param  mixed  $var     Variable.
  * @param  string $default Default value.
- * @return mixed
+ * @return string|null
  */
 function wc_get_var( &$var, $default = null ) {
 	return isset( $var ) ? $var : $default;
@@ -2114,7 +2114,7 @@ 
  * See if theme/s is activate or not.
  *
  * @since 3.3.0
- * @param string|array $theme Theme name or array of theme names to check.
+ * @param string[] $theme Theme name or array of theme names to check.
  * @return boolean
  */
 function wc_is_active_theme( $theme ) {

includes/wc-user-functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -36,7 +36,7 @@ 
 	 * @param  string $username Customer username.
 	 * @param  string $password Customer password.
 	 * @param  array  $args     List of arguments to pass to `wp_insert_user()`.
-	 * @return int|WP_Error Returns WP_Error on failure, Int (user ID) on success.
+	 * @return integer Returns WP_Error on failure, Int (user ID) on success.
 	 */
 	function wc_create_new_customer( $email, $username = '', $password = '', $args = array() ) {
 		if ( empty( $email ) || ! is_email( $email ) ) {
@@ -611,7 +611,7 @@ 
  * Get total spent by customer.
  *
  * @param  int $user_id User ID.
- * @return string
+ * @return double
  */
 function wc_get_customer_total_spent( $user_id ) {
 	$customer = new WC_Customer( $user_id );
@@ -756,7 +756,7 @@ 
  *
  * @since 3.2.0
  * @param array $search_columns Column names.
- * @return array
+ * @return string[]
  */
 function wc_user_search_columns( $search_columns ) {
 	$search_columns[] = 'display_name';

includes/tracks/class-wc-tracks-client.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
 	/**
 	 * Check if identiy cookie is set, if not set it.
 	 *
-	 * @return void
+	 * @return null|false
 	 */
 	public static function maybe_set_identity_cookie() {
 		// Bail if cookie already set.

includes/wc-product-functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -1504,8 +1504,8 @@
  * Populate a batch of rating count lookup table data for products.
  *
  * @since 3.6.2
- * @param array $offset Offset to query.
- * @param array $limit  Limit to query.
+ * @param integer $offset Offset to query.
+ * @param integer $limit  Limit to query.
  */
 function wc_update_product_lookup_tables_rating_count_batch( $offset = 0, $limit = 0 ) {
 	global $wpdb;

includes/data-stores/class-wc-data-store-wp.php

Doc Comments +2 added lines, -2 removed lines

@@ -493,7 +493,7 @@ 
 	 * the approximate search engines list, and is translatable.
 	 *
 	 * @since 3.4.0
-	 * @param array $terms Terms to check.
+	 * @param string[] $terms Terms to check.
 	 * @return array Terms that are not stopwords.
 	 */
 	protected function get_valid_search_terms( $terms ) {
@@ -579,7 +579,7 @@ 
 	 * @param int    $id ID of object to update.
 	 * @param string $table Lookup table name.
 	 *
-	 * @return NULL
+	 * @return false|null
 	 */
 	protected function update_lookup_table( $id, $table ) {
 		global $wpdb;

includes/abstracts/abstract-wc-product.php

Doc Comments +6 added lines, -6 removed lines

@@ -116,7 +116,7 @@ 
 	 * This class should NOT be instantiated, but the wc_get_product() function
 	 * should be used. It is possible, but the wc_get_product() is preferred.
 	 *
-	 * @param int|WC_Product|object $product Product to init.
+	 * @param integer $product Product to init.
 	 */
 	public function __construct( $product = 0 ) {
 		parent::__construct( $product );
@@ -855,7 +855,7 @@ 
 	 * Set date on sale from.
 	 *
 	 * @since 3.0.0
-	 * @param string|integer|null $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.
+	 * @param string $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.
 	 */
 	public function set_date_on_sale_from( $date = null ) {
 		$this->set_date_prop( 'date_on_sale_from', $date );
@@ -865,7 +865,7 @@ 
 	 * Set date on sale to.
 	 *
 	 * @since 3.0.0
-	 * @param string|integer|null $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.
+	 * @param string $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.
 	 */
 	public function set_date_on_sale_to( $date = null ) {
 		$this->set_date_prop( 'date_on_sale_to', $date );
@@ -982,7 +982,7 @@ 
 	/**
 	 * Set low stock amount.
 	 *
-	 * @param int|string $amount Empty string if value not set.
+	 * @param string $amount Empty string if value not set.
 	 * @since 3.5.0
 	 */
 	public function set_low_stock_amount( $amount ) {
@@ -1286,7 +1286,7 @@ 
 	 * Set main image ID.
 	 *
 	 * @since 3.0.0
-	 * @param int|string $image_id Product image id.
+	 * @param integer $image_id Product image id.
 	 */
 	public function set_image_id( $image_id = '' ) {
 		$this->set_prop( 'image_id', $image_id );
@@ -1295,7 +1295,7 @@ 
 	/**
 	 * Set rating counts. Read only.
 	 *
-	 * @param array $counts Product rating counts.
+	 * @param integer $counts Product rating counts.
 	 */
 	public function set_rating_counts( $counts ) {
 		$this->set_prop( 'rating_counts', array_filter( array_map( 'absint', (array) $counts ) ) );

includes/wc-webhook-functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -168,7 +168,7 @@
  * Get webhoook REST API versions.
  *
  * @since 3.5.1
- * @return array
+ * @return string[]
  */
 function wc_get_webhook_rest_api_versions() {
 	return array(

includes/wccom-site/class-wc-wccom-site-installer.php

Doc Comments +1 added lines, -1 removed lines

@@ -464,7 +464,7 @@
 	 *
 	 * @since 3.7.0
 	 * @param int $product_id Product ID.
-	 * @return bool|string
+	 * @return false|string
 	 */
 	private static function get_wporg_product_dir_name( $product_id ) {
 		$steps   = self::get_state( 'steps' );