woothemes / woocommerce

includes/class-wc-auth.php

Doc Comments +1 added lines, -1 removed lines

@@ -201,7 +201,7 @@
 	/**
 	 * Parse file path and see if its remote or local.
 	 * @param  string $file_path
-	 * @return array
+	 * @return string
 	 */
 	public static function parse_file_path( $file_path ) {
 		$wp_uploads     = wp_upload_dir();

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

Doc Comments +2 added lines, -2 removed lines

@@ -558,7 +558,7 @@ 
 	 *
 	 * @param WP_Term $term
 	 * @param WP_REST_Request $request
-	 * @return bool|WP_Error
+	 * @return boolean
 	 */
 	protected function update_term_meta_fields( $term, $request ) {
 		return true;
@@ -730,7 +730,7 @@ 
 	 * Get taxonomy.
 	 *
 	 * @param WP_REST_Request $request Full details about the request.
-	 * @return int|WP_Error
+	 * @return string
 	 */
 	protected function get_taxonomy( $request ) {
 		// Check if taxonomy is defined.

includes/api/class-wc-rest-authentication.php

Doc Comments +1 added lines, -1 removed lines

@@ -184,7 +184,7 @@
 	 *
 	 * @param stdClass $user
 	 * @param array $params The request parameters.
-	 * @return null|WP_Error
+	 * @return stdClass
 	 */
 	private function check_oauth_signature( $user, $params ) {
 		$http_method  = strtoupper( $_SERVER['REQUEST_METHOD'] );

includes/api/class-wc-rest-coupons-controller.php

Doc Comments +2 added lines, -2 removed lines

@@ -285,7 +285,7 @@ 
 	 *
 	 * @param WP_Post $post
 	 * @param WP_REST_Request $request
-	 * @return bool|WP_Error
+	 * @return boolean
 	 */
 	protected function add_post_meta_fields( $post, $request ) {
 		$data = $request->get_json_params();
@@ -340,7 +340,7 @@ 
 	 *
 	 * @param WP_Post $post
 	 * @param WP_REST_Request $request
-	 * @return bool|WP_Error
+	 * @return boolean
 	 */
 	protected function update_post_meta_fields( $post, $request ) {
 		if ( isset( $request['amount'] ) ) {

includes/api/class-wc-rest-product-attributes-controller.php

Doc Comments +1 added lines, -2 removed lines

@@ -470,7 +470,6 @@ 
 	 * Prepare links for the request.
 	 *
 	 * @param object $attribute Attribute object.
-	 * @param WP_REST_Request $request Full details about the request.
 	 * @return array Links for the given attribute.
 	 */
 	protected function prepare_links( $attribute ) {
@@ -562,7 +561,7 @@ 
 	 * Get attribute name.
 	 *
 	 * @param WP_REST_Request $request Full details about the request.
-	 * @return int|WP_Error
+	 * @return string
 	 */
 	protected function get_taxonomy( $request ) {
 		if ( '' !== $this->attribute ) {

includes/api/class-wc-rest-webhooks-controller.php

Doc Comments -1 removed lines

@@ -380,7 +380,6 @@
 	/**
 	 * Prepare a single webhook output for response.
 	 *
-	 * @param WP_Post $webhook Webhook object.
 	 * @param WP_REST_Request $request Request object.
 	 * @return WP_REST_Response $response Response data.
 	 */

includes/wc-user-functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -628,7 +628,7 @@
  *
  * @since 2.6.0
  * @param int $customer_id Customer ID.
- * @return WC_Order|bool Order object if successful or false.
+ * @return WC_Order Order object if successful or false.
  */
 function wc_get_customer_last_order( $customer_id ) {
 	global $wpdb;

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

Doc Comments +2 added lines, -2 removed lines

@@ -285,7 +285,7 @@ 
 	 *
 	 * @param WP_Post $post
 	 * @param WP_REST_Request $request
-	 * @return bool|WP_Error
+	 * @return boolean
 	 */
 	protected function add_post_meta_fields( $post, $request ) {
 		$data = $request->get_json_params();
@@ -340,7 +340,7 @@ 
 	 *
 	 * @param WP_Post $post
 	 * @param WP_REST_Request $request
-	 * @return bool|WP_Error
+	 * @return boolean
 	 */
 	protected function update_post_meta_fields( $post, $request ) {
 		if ( isset( $request['amount'] ) ) {

includes/wc-core-functions.php

Doc Comments +3 added lines, -1 removed lines

@@ -209,6 +209,7 @@ 
  * Like wc_get_template, but returns the HTML instead of outputting.
  * @see wc_get_template
  * @since 2.5.0
+ * @param string $template_name
  */
 function wc_get_template_html( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
 	ob_start();
@@ -1227,7 +1228,7 @@ 
 /**
  * Return a list of potential postcodes for wildcard searching.
  * @param  string $postcode
- * @return array
+ * @return string[]
  */
 function wc_get_wildcard_postcodes( $postcode ) {
 	$postcodes         = array( '*', strtoupper( $postcode ), strtoupper( $postcode ) . '*' );
@@ -1248,6 +1249,7 @@ 
  * @param array $objects Array of postcode objects from Database
  * @param string $object_compare_key DB column name for the ID.
  * @param string $object_compare_key DB column name for the value.
+ * @param string $object_id_key
  * @return array Array of matching object ID and values.
  */
 function wc_postcode_location_matcher( $postcode, $objects, $object_id_key, $object_compare_key ) {