Fix phpdoc to include params and correct types

Author: rasmusbe

includes/abstracts/abstract-wc-data.php

@@ -248,6 +248,9 @@ public function get_extra_data_keys() {
 	 * Filter null meta values from array.
 	 *
 	 * @since  3.0.0
+	 *
+	 * @param mixed $meta
+	 *
 	 * @return bool
 	 */
 	protected function filter_null_meta( $meta ) {
@@ -352,8 +355,8 @@ public function add_meta_data( $key, $value, $unique = false ) {
 
 	/**
 	 * Update meta data by key or ID, if provided.
-	 *
 	 * @since  2.6.0
+	 *
 	 * @param  string $key
 	 * @param  string $value
 	 * @param  int $meta_id
@@ -532,8 +535,11 @@ public function get_object_read() {
 	 * Only sets using public methods.
 	 *
 	 * @since  3.0.0
+	 *
 	 * @param  array $props Key value pairs to set. Key is the prop and should map to a setter function name.
-	 * @return WP_Error|bool
+	 * @param string $context
+	 *
+	 * @return bool|WP_Error
 	 */
 	public function set_props( $props, $context = 'set' ) {
 		$errors = new WP_Error();

includes/abstracts/abstract-wc-deprecated-hooks.php

@@ -76,6 +76,9 @@ abstract function handle_deprecated_hook( $new_hook, $old_hook, $new_callback_ar
 
 	/**
 	 * Display a deprecated notice for old hooks.
+	 *
+	 * @param string $old_hook
+	 * @param string $new_hook
 	 */
 	protected function display_notice( $old_hook, $new_hook ) {
 		wc_deprecated_function( sprintf( 'The "%s" hook uses out of date data structures and', esc_html( $old_hook ) ), WC_VERSION, esc_html( $new_hook ) );

includes/abstracts/abstract-wc-order.php

@@ -1387,6 +1387,8 @@ public function get_subtotal_to_display( $compound = false, $tax_display = '' )
 	/**
 	 * Gets shipping (formatted).
 	 *
+	 * @param string $tax_display
+	 *
 	 * @return string
 	 */
 	public function get_shipping_to_display( $tax_display = '' ) {
@@ -1427,6 +1429,9 @@ public function get_shipping_to_display( $tax_display = '' ) {
 	/**
 	 * Get the discount amount (formatted).
 	 * @since  2.3.0
+	 *
+	 * @param string $tax_display
+	 *
 	 * @return string
 	 */
 	public function get_discount_to_display( $tax_display = '' ) {
@@ -1569,6 +1574,8 @@ public function get_order_item_totals( $tax_display = '' ) {
 	/**
 	 * Checks the order status against a passed in status.
 	 *
+	 * @param array|string $status
+	 *
 	 * @return bool
 	 */
 	public function has_status( $status ) {

includes/abstracts/abstract-wc-product.php

@@ -436,7 +436,7 @@ public function get_height( $context = 'view' ) {
 	/**
 	 * Returns formatted dimensions.
 	 *
-	 * @param  $formatted True by default for legacy support - will be false/not set in future versions to return the array only. Use wc_format_dimensions for formatted versions instead.
+	 * @param  $formatted bool True by default for legacy support - will be false/not set in future versions to return the array only. Use wc_format_dimensions for formatted versions instead.
 	 * @return string|array
 	 */
 	public function get_dimensions( $formatted = true ) {
@@ -1639,6 +1639,9 @@ public function get_stock_managed_by_id() {
 
 	/**
 	 * Returns the price in html format.
+	 *
+	 * @param string $deprecated
+	 *
 	 * @return string
 	 */
 	public function get_price_html( $deprecated = '' ) {
@@ -1719,7 +1722,7 @@ public function add_to_cart_text() {
 	 *
 	 * @param string $size (default: 'shop_thumbnail')
 	 * @param array $attr
-	 * @param bool True to return $placeholder if no image is found, or false to return an empty string.
+	 * @param bool $placeholder True to return $placeholder if no image is found, or false to return an empty string.
 	 * @return string
 	 */
 	public function get_image( $size = 'shop_thumbnail', $attr = array(), $placeholder = true ) {

includes/abstracts/abstract-wc-rest-controller.php

@@ -228,7 +228,7 @@ public function validate_setting_select_field( $value, $setting ) {
 	 * @since 3.0.0
 	 * @param array $values
 	 * @param array  $setting
-	 * @return string|WP_Error
+	 * @return array|WP_Error
 	 */
 	public function validate_setting_multiselect_field( $values, $setting ) {
 		if ( empty( $values ) ) {
@@ -253,7 +253,7 @@ public function validate_setting_multiselect_field( $values, $setting ) {
 	 * Validate image_width based settings.
 	 *
 	 * @since 3.0.0
-	 * @param array $value
+	 * @param array $values
 	 * @param array $setting
 	 * @return string|WP_Error
 	 */

includes/abstracts/abstract-wc-rest-crud-controller.php

@@ -94,7 +94,7 @@ public function delete_item_permissions_check( $request ) {
 	/**
 	 * Get object permalink.
 	 *
-	 * @param  int $id Object ID.
+	 * @param  object $object
 	 * @return string
 	 */
 	protected function get_permalink( $object ) {

includes/abstracts/abstract-wc-rest-posts-controller.php

@@ -122,7 +122,8 @@ public function delete_item_permissions_check( $request ) {
 	 * Check if a given request has access batch create, update and delete items.
 	 *
 	 * @param  WP_REST_Request $request Full details about the request.
-	 * @return boolean
+	 *
+	 * @return boolean|WP_Error
 	 */
 	public function batch_items_permissions_check( $request ) {
 		if ( ! wc_rest_check_post_permissions( $this->post_type, 'batch' ) ) {

includes/abstracts/abstract-wc-rest-terms-controller.php

@@ -200,7 +200,7 @@ public function delete_item_permissions_check( $request ) {
 	 * Check if a given request has access batch create, update and delete items.
 	 *
 	 * @param  WP_REST_Request $request Full details about the request.
-	 * @return boolean
+	 * @return boolean|WP_Error
 	 */
 	public function batch_items_permissions_check( $request ) {
 		$permissions = $this->check_permissions( $request, 'batch' );

includes/abstracts/abstract-wc-settings-api.php

@@ -273,9 +273,11 @@ public function get_field_key( $key ) {
 	 * Generate the HTML for the fields on the "settings" screen.
 	 *
 	 * @param  array $form_fields (default: array())
+	 * @param bool $echo
+	 *
+	 * @return string the html for the settings
 	 * @since  1.0.0
 	 * @uses   method_exists()
-	 * @return string the html for the settings
 	 */
 	public function generate_settings_html( $form_fields = array(), $echo = true ) {
 		if ( empty( $form_fields ) ) {
@@ -875,7 +877,7 @@ public function validate_select_field( $key, $value ) {
 	 *
 	 * @param  string $key
 	 * @param  string $value Posted Value
-	 * @return string
+	 * @return string|array
 	 */
 	public function validate_multiselect_field( $key, $value ) {
 		return is_array( $value ) ? array_map( 'wc_clean', array_map( 'stripslashes', $value ) ) : '';
@@ -884,6 +886,8 @@ public function validate_multiselect_field( $key, $value ) {
 	/**
 	 * Validate the data on the "Settings" form.
 	 * @deprecated 2.6.0 No longer used
+	 *
+	 * @param array $form_fields
 	 */
 	public function validate_settings_fields( $form_fields = array() ) {
 		wc_deprecated_function( 'validate_settings_fields', '2.6' );

includes/abstracts/abstract-wc-shipping-method.php

@@ -137,6 +137,8 @@ public function supports( $feature ) {
 
 	/**
 	 * Called to calculate shipping rates for this method. Rates can be added using the add_rate() method.
+	 *
+	 * @param array $package
 	 */
 	public function calculate_shipping( $package = array() ) {}
 

includes/abstracts/abstract-wc-widget.php

@@ -108,6 +108,8 @@ public function flush_widget_cache() {
 	 * Output the html at the start of a widget.
 	 *
 	 * @param  array $args
+	 * @param array $instance
+	 *
 	 * @return string
 	 */
 	public function widget_start( $args, $instance ) {

includes/admin/class-wc-admin-duplicate-product.php

@@ -170,7 +170,7 @@ public function product_duplicate( $product ) {
 	 *
 	 * @deprecated 3.0.0
 	 * @param mixed $id
-	 * @return WP_Post|bool
+	 * @return object|bool
 	 * @see duplicate_product
 	 */
 	private function get_product_to_duplicate( $id ) {

includes/admin/class-wc-admin-post-types.php

@@ -108,6 +108,11 @@ public function __construct() {
 
 	/**
 	 * Adjust shop order columns for the user on certain conditions.
+	 *
+	 * @param array $hidden
+	 * @param object $screen
+	 *
+	 * @return array
 	 */
 	public function adjust_shop_order_columns( $hidden, $screen ) {
 		if ( isset( $screen->id ) && 'edit-shop_order' === $screen->id ) {
@@ -1899,6 +1904,8 @@ public function disable_view_mode_options( $post_types ) {
 
 	/**
 	 * Show blank slate.
+	 *
+	 * @param string $which
 	 */
 	public function maybe_render_blank_state( $which ) {
 		global $post_type;
@@ -1941,6 +1948,11 @@ public function maybe_render_blank_state( $which ) {
 
 	/**
 	 * When editing the shop page, we should hide templates.
+	 *
+	 * @param array $page_templates
+	 * @param $class
+	 * @param object $post
+	 *
 	 * @return array
 	 */
 	public function hide_cpt_archive_templates( $page_templates, $class, $post ) {
@@ -1955,6 +1967,8 @@ public function hide_cpt_archive_templates( $page_templates, $class, $post ) {
 
 	/**
 	 * Show a notice above the CPT archive.
+	 *
+	 * @param object $post
 	 */
 	public function show_cpt_archive_notice( $post ) {
 		$shop_page_id = wc_get_page_id( 'shop' );

includes/admin/class-wc-admin-reports.php

@@ -152,6 +152,8 @@ public static function get_reports() {
 
 	/**
 	 * Get a report from our reports subfolder.
+	 *
+	 * @param string $name
 	 */
 	public static function get_report( $name ) {
 		$name  = sanitize_title( str_replace( '_', '-', $name ) );

includes/admin/class-wc-admin-settings.php

@@ -172,8 +172,10 @@ public static function output() {
 	/**
 	 * Get a setting from the settings API.
 	 *
-	 * @param mixed $option_name
-	 * @return string
+	 * @param string $option_name
+	 * @param mixed $default
+	 *
+	 * @return mixed
 	 */
 	public static function get_option( $option_name, $default = '' ) {
 		// Array value
@@ -214,7 +216,7 @@ public static function get_option( $option_name, $default = '' ) {
 	 *
 	 * Loops though the woocommerce options array and outputs each field.
 	 *
-	 * @param array $options Opens array to output
+	 * @param array[] $options Opens array to output
 	 */
 	public static function output_fields( $options ) {
 		foreach ( $options as $value ) {

includes/admin/class-wc-admin-taxonomies.php

@@ -327,7 +327,8 @@ public function product_cat_columns( $columns ) {
 	 * @param string $columns
 	 * @param string $column
 	 * @param int $id
-	 * @return array
+	 *
+	 * @return string
 	 */
 	public function product_cat_column( $columns, $column, $id ) {
 

includes/admin/class-wc-admin-webhooks.php

@@ -491,6 +491,8 @@ public static function logs_output( $webhook ) {
 	/**
 	 * Get the webhook topic data.
 	 *
+	 * @param WC_Webhook $webhook
+	 *
 	 * @return array
 	 */
 	public static function get_topic_data( $webhook ) {
@@ -519,6 +521,7 @@ public static function get_topic_data( $webhook ) {
 	 * Get the logs navigation.
 	 *
 	 * @param  int $total
+	 * @param  WC_Webhook $webhook
 	 *
 	 * @return string
 	 */

includes/admin/meta-boxes/class-wc-meta-box-product-data.php

@@ -173,6 +173,11 @@ public static function output_variations() {
 
 	/**
 	 * Prepare downloads for save.
+	 *
+	 * @param array $file_names
+	 * @param array $file_urls
+	 * @param array $file_hashes
+	 *
 	 * @return array
 	 */
 	private static function prepare_downloads( $file_names, $file_urls, $file_hashes ) {
@@ -204,6 +209,9 @@ private static function prepare_children() {
 
 	/**
 	 * Prepare attributes for save.
+	 *
+	 * @param array $data
+	 *
 	 * @return array
 	 */
 	public static function prepare_attributes( $data = false ) {
@@ -292,6 +300,9 @@ private static function prepare_set_attributes( $all_attributes, $key_prefix = '
 
 	/**
 	 * Save meta box data.
+	 *
+	 * @param int $post_id
+	 * @param $post
 	 */
 	public static function save( $post_id, $post ) {
 		// Process product type first so we have the correct class to run setters.

includes/admin/meta-boxes/class-wc-meta-box-product-reviews.php

@@ -19,6 +19,8 @@ class WC_Meta_Box_Product_Reviews {
 
 	/**
 	 * Output the metabox
+	 *
+	 * @param object $comment
 	 */
 	public static function output( $comment ) {
 		wp_nonce_field( 'woocommerce_save_data', 'woocommerce_meta_nonce' );
@@ -35,6 +37,11 @@ public static function output( $comment ) {
 
 	/**
 	 * Save meta box data
+	 *
+	 * @param mixed $location
+	 * @param int $comment_id
+	 *
+	 * @return mixed
 	 */
 	public static function save( $location, $comment_id ) {
 		// Not allowed, return regular value without updating meta

includes/admin/reports/class-wc-report-sales-by-date.php

@@ -590,8 +590,10 @@ class="export_csv"
 
 	/**
 	 * Round our totals correctly.
-	 * @param  string $amount
-	 * @return string
+	 *
+	 * @param array|string $amount
+	 *
+	 * @return array|string
 	 */
 	private function round_chart_totals( $amount ) {
 		if ( is_array( $amount ) ) {

includes/admin/settings/class-wc-settings-checkout.php

@@ -59,6 +59,8 @@ public function get_sections() {
 	/**
 	 * Get settings array.
 	 *
+	 * @param string $current_section
+	 *
 	 * @return array
 	 */
 	public function get_settings( $current_section = '' ) {

includes/admin/settings/class-wc-settings-page.php

@@ -63,6 +63,10 @@ public function get_label() {
 
 	/**
 	 * Add this page to settings.
+	 *
+	 * @param array $pages
+	 *
+	 * @return mixed
 	 */
 	public function add_settings_page( $pages ) {
 		$pages[ $this->id ] = $this->label;

includes/admin/settings/class-wc-settings-products.php

@@ -74,6 +74,8 @@ public function save() {
 	/**
 	 * Get settings array.
 	 *
+	 * @param string $current_section
+	 *
 	 * @return array
 	 */
 	public function get_settings( $current_section = '' ) {