phpwordpresswoocommercedropdownstock

How to add variation stock status to Woocommerce product variation dropdown


I would like to show the stock status (eg. In Stock / Out of Stock) for each product variation shown in the drop down list of variations on the Woocommerce Product Page. I have copied the relevant function to my theme's functions.php file, and can edit the content, but am unsure how to pull out the required stock status for each variation.


// Updated Woocommerce Product Variation Select 

if ( ! function_exists( 'wc_dropdown_variation_attribute_options' ) ) {

    /**
     * Output a list of variation attributes for use in the cart forms.
     *
     * @param array $args
     * @since 2.4.0
     */

     /*

    function wc_dropdown_variation_attribute_options( $args = array() ) {
        $args = wp_parse_args( apply_filters( 'woocommerce_dropdown_variation_attribute_options_args', $args ), array(
            'options'          => false,
            'attribute'        => false,
            'product'          => false,
            'selected'         => false,
            'name'             => '',
            'id'               => '',
            'class'            => '',
            'show_option_none' => __( 'Choose an option', 'woocommerce' ),
        ) );

        $options               = $args['options'];
        $product               = $args['product'];
        $attribute             = $args['attribute'];
        $name                  = $args['name'] ? $args['name'] : 'attribute_' . sanitize_title( $attribute );
        $id                    = $args['id'] ? $args['id'] : sanitize_title( $attribute );
        $class                 = $args['class'];
        $show_option_none      = $args['show_option_none'] ? true : false;
        $show_option_none_text = $args['show_option_none'] ? $args['show_option_none'] : __( 'Choose an option', 'woocommerce' ); // We'll do our best to hide the placeholder, but we'll need to show something when resetting options.

        if ( empty( $options ) && ! empty( $product ) && ! empty( $attribute ) ) {
            $attributes = $product->get_variation_attributes();
            $options    = $attributes[ $attribute ];
        }

        $html = '';
        $html .= '' . esc_html( $show_option_none_text ) . '';

        if ( ! empty( $options ) ) {
            if ( $product && taxonomy_exists( $attribute ) ) {
                // Get terms if this is a taxonomy - ordered. We need the names too.
                $terms = wc_get_product_terms( $product->get_id(), $attribute, array( 'fields' => 'all' ) );



                foreach ( $terms as $term ) {
                    if ( in_array( $term->slug, $options ) ) {
                        $html .= 'slug ) . '" ' . selected( sanitize_title( $args['selected'] ), $term->slug, false ) . '>' . esc_html( apply_filters( 'woocommerce_variation_option_name', $term->name ) ) . ' ';
                    }
                }
            } else {
                foreach ( $options as $option ) {
                    // This handles lt 2.4.0 bw compatibility where text attributes were not sanitized.
                    $selected = sanitize_title( $args['selected'] ) === $args['selected'] ? selected( $args['selected'], sanitize_title( $option ), false ) : selected( $args['selected'], $option, false );

                    $html .= '' . esc_html( apply_filters( 'woocommerce_variation_option_name', $option ) ) . '  Output Stock Details Here ';
                }
            }
        }

        $html .= '';

        echo apply_filters( 'woocommerce_dropdown_variation_attribute_options_html', $html, $args );
    }
}

I can pull out the stock level for the overall product, but now for each variation.

Any help would be greatly appreciated.


Solution

  • Ok, first you'll need to get product variations like this:

    $variations = $product->get_available_variations();
    

    And inside options loop, you need to loop through the variations and find the current option stock status

    foreach ($variations as $variation) {
        if($variation['attributes'][$name] == $option) {
            $stock = $variation['is_in_stock'];
    
        }
    }
    

    Outside the variations loop you need to add the wording for in-stock and out-of-stock variations

    if( $stock == 1) {
        $stock_content = ' - In stock';
    } else {
        $stock_content = ' - Out of stock';
    }
    

    Then change the html to include an additional variable ($stock_content)

    $html .= '<option value="' . esc_attr( $option ) . '" ' . $selected . '>' . esc_html( $option  .  $stock_content ) . '</option>'; 
    

    So a complete function will look like this:

    add_filter( 'woocommerce_dropdown_variation_attribute_options_html', 'show_stock_status_in_dropdown', 10, 2);
    function show_stock_status_in_dropdown( $html, $args ) {
        $options = $args['options']; 
        $product = $args['product']; 
        $attribute = $args['attribute']; 
        $name = $args['name'] ? $args['name'] : 'attribute_' . sanitize_title( $attribute ); 
        $id = $args['id'] ? $args['id'] : sanitize_title( $attribute ); 
        $class = $args['class']; 
        $show_option_none = $args['show_option_none'] ? true : false; 
        $show_option_none_text = $args['show_option_none'] ? $args['show_option_none'] : __( 'Choose an option', 'woocommerce' ); 
    
      // Get all product variations
        $variations = $product->get_available_variations();
    
        if ( empty( $options ) && ! empty( $product ) && ! empty( $attribute ) ) { 
            $attributes = $product->get_variation_attributes(); 
            $options = $attributes[ $attribute ]; 
        } 
    
        $html = '<select id="' . esc_attr( $id ) . '" class="' . esc_attr( $class ) . '" name="' . esc_attr( $name ) . '" data-attribute_name="attribute_' . esc_attr( sanitize_title( $attribute ) ) . '" data-show_option_none="' . ( $show_option_none ? 'yes' : 'no' ) . '">'; 
        $html .= '<option value="">' . esc_html( $show_option_none_text ) . '</option>'; 
    
        if ( ! empty( $options ) ) { 
            if ( $product && taxonomy_exists( $attribute ) ) { 
              // Get terms if this is a taxonomy - ordered. We need the names too. 
              $terms = wc_get_product_terms( $product->get_id(), $attribute, array( 'fields' => 'all' ) ); 
    
              foreach ( $terms as $term ) { 
                    if ( in_array( $term->slug, $options ) ) { 
                        $html .= '<option value="' . esc_attr( $term->slug ) . '" ' . selected( sanitize_title( $args['selected'] ), $term->slug, false ) . '>' . esc_html( apply_filters( 'woocommerce_variation_option_name', $term->name ) ) . '</option>'; 
                    } 
                }
            } else {
                foreach ( $options as $option ) {
                        foreach ($variations as $variation) {
                            if($variation['attributes'][$name] == $option) {
                                $stock = $variation['is_in_stock'];
                            }
                        }       
                    if( $stock == 1) {
                        $stock_content = ' - (In Stock)';
                    } else {
                        $stock_content = ' - (Out of Stock)';
                    }
                     // This handles < 2.4.0 bw compatibility where text attributes were not sanitized. 
                    $selected = sanitize_title( $args['selected'] ) === $args['selected'] ? selected( $args['selected'], sanitize_title( $option ), false ) : selected( $args['selected'], $option, false ); 
    
                    $html .= '<option value="' . esc_attr( $option ) . '" ' . $selected . '>' . esc_html( $option  .  $stock_content ) . '</option>'; 
    
                }
            } 
        } 
    
        $html .= '</select>'; 
    
        return $html;
    }