WooCommerce Active Shipping Methods Widget

wc-active-shipping-methods-widget.php

<?php
/**
 * Plugin Name: WooCommerce Active Shipping Widget
 * Plugin URI: https://www.skyverge.com/blog/how-to-create-a-woocommerce-widget/
 * Description: Adds a widget to display a list of active WooCommerce shipping methods
 * Author: SkyVerge
 * Author URI: https://www.skyverge.com/
 * Version: 1.0.0
 * Text Domain: wc-active-shipping-widget
 *
 * Copyright: (c) 2015 SkyVerge, Inc. (info@skyverge.com)
 *
 * License: GNU General Public License v3.0
 * License URI: http://www.gnu.org/licenses/gpl-3.0.html
 *
 * @author    SkyVerge
 * @copyright Copyright (c) 2015, SkyVerge, Inc.
 * @license   http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
 *
 */
 
 
if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly


/**
 * A simple widget for displaying active WooCommerce shipping methods
 *
 * @since 1.0.0
 * @extends \WP_Widget
 */

class WC_Active_Shipping_Widget extends WP_Widget {

	/**
	 * Setup the widget options
	 *
	 * @since 1.0.0
	 */
	public function __construct() {
	
		// set widget options
		$options = array(
			'classname'   => 'widget_wc_active_shipping', // CSS class name
			'description' => __( 'Displays a list of active shipping methods for your shop.', 'wc-active-shipping-widget' ),
		);
		
		// instantiate the widget
		parent::__construct( 'WC_Active_Shipping_Widget', __( 'WooCommerce Active Shipping Methods', 'wc-active-shipping-widget' ), $options );
	}
	
	
	/**
	 * Render the widget
	 *
	 * @since 1.0.0
	 * @see WP_Widget::widget()
	 * @param array $args
	 * @param array $instance
	 */
	public function widget( $args, $instance ) {
		// Get the active methods and bail if there are none
		$methods = $this->get_active_shipping_methods();
		if ( empty( $methods ) ) {
			return;
		}
		
		// get the widget configuration
		$title = $instance['title'];
		$added_text = $instance['text'];
		
		echo $args['before_widget'];
		
		if ( $title ) {
			echo $args['before_title'] . wp_kses_post( $title ) . $args['after_title'];
		}
		
		// Show the additional text if set
		if ( $added_text ) {
			echo '<p>' . wp_kses_post( $added_text ) . '</p>';
		}
		
		// Output list of shipping methods
		echo '<ul>';
		
		foreach ( $methods as $method ) {
			echo '<li>' . esc_html( $method ) . '</li>';
		}
		
		echo '</ul>';
		
		echo $args['after_widget'];
	}
	

	/**
	 * Update the widget title & selected product
	 *
	 * @since 1.0.0
	 * @see WP_Widget::update()
	 * @param array $new_instance new widget settings
	 * @param array $old_instance old widget settings
	 * @return array updated widget settings
	 */
	public function update( $new_instance, $old_instance ) {
	
		$instance['title'] = strip_tags( $new_instance['title'] );
		$instance['text'] = strip_tags( $new_instance['text'] );
		
		return $instance;
	}
	

	/**
	 * Render the admin form for the widget
	 *
	 * @since 1.0.0
	 * @see WP_Widget::form()
	 * @param array $instance the widget settings
	 * @return string|void
	 */
	public function form( $instance ) {
		?>
		<p>
			<label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php _e( 'Title', 'wc-active-shipping-widget' ) ?>:</label>
			<input type="text" class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" value="<?php echo esc_attr( isset( $instance['title'] ) ? $instance['title'] : '' ); ?>" />
		</p>
		
		<p>
			<label for="<?php echo esc_attr( $this->get_field_id( 'text' ) ); ?>"><?php _e( 'Additional text', 'wc-active-shipping-widget' ) ?>:</label>
			<textarea class="widefat" rows="3" cols="20" id="<?php echo esc_attr( $this->get_field_id( 'text' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'text' ) ); ?>"><?php echo esc_textarea( $instance['text'] ); ?></textarea>
		</p>
		<?php
	}

	
	/**
	 * Gets the shipping methods enabled in the shop
	 *
	 * @since 1.0.0
	 * @return array $active_methods the titles of all active methods
	 */
	private function get_active_shipping_methods() {

		$shipping_methods = WC()->shipping->load_shipping_methods();
		$active_methods = array();	

		foreach ( $shipping_methods as $id => $shipping_method ) {
			if ( isset( $shipping_method->enabled ) && 'yes' === $shipping_method->enabled ) {
				$method_title = $shipping_method->title;
				if ( 'international_delivery' === $id ) {
					$method_title .= ' (International)';
				}
				array_push( $active_methods, $method_title );
			}
		}

		return $active_methods;
	}
	
} // end \WC_Active_Shipping_Widget class


/**
 * Registers the new widget to add it to the available widgets
 * 
 * @since 1.0.0
 */
function wc_active_shipping_register_widget() {
	register_widget( 'WC_Active_Shipping_Widget' );
}
add_action( 'widgets_init', 'wc_active_shipping_register_widget' );