Filters WooCommerce Orders by Payment Gateway Used

filter-wc-orders-by-gateway.php

<?php
/**
 * Plugin Name: Filter WooCommerce Orders by Payment Method
 * Plugin URI: http://skyverge.com/
 * Description: Filters WooCommerce orders by the payment method used :)
 * Author: SkyVerge
 * Author URI: http://www.skyverge.com/
 * Version: 1.0.0
 * Text Domain: wc-filter-orders-by-payment
 *
 * Copyright: (c) 2017-2020 SkyVerge, Inc. ([email protected])
 *
 * License: GNU General Public License v3.0
 * License URI: http://www.gnu.org/licenses/gpl-3.0.html
 *
 * @package   WC-Filter-Orders-By-Payment
 * @author    SkyVerge
 * @category  Admin
 * @copyright Copyright (c) 2017-2020, SkyVerge, Inc.
 * @license   http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
 */

defined( 'ABSPATH' ) or exit;

// fire it up!
add_action( 'plugins_loaded', 'wc_filter_orders_by_payment' );


/** 
 * Main plugin class
 *
 * @since 1.0.0
 */
class WC_Filter_Orders_By_Payment {


	const VERSION = '1.0.0';

	/** @var WC_Filter_Orders_By_Payment single instance of this plugin */
	protected static $instance;

	/**
	 * Main plugin class constructor
	 *
	 * @since 1.0.0
	 */
	public function __construct() {

		if ( is_admin() ) {

			// add bulk order filter for exported / non-exported orders
			add_action( 'restrict_manage_posts', array( $this, 'filter_orders_by_payment_method') , 20 );
			add_filter( 'request',               array( $this, 'filter_orders_by_payment_method_query' ) );		
		}
	}


	/** Plugin methods ***************************************/


	/**
	 * Add bulk filter for orders by payment method
	 *
	 * @since 1.0.0
	 */
	public function filter_orders_by_payment_method() {
		global $typenow;

		if ( 'shop_order' === $typenow ) {

			// get all payment methods, even inactive ones
			$gateways = WC()->payment_gateways->payment_gateways();

			?>
			<select name="_shop_order_payment_method" id="dropdown_shop_order_payment_method">
				<option value="">
					<?php esc_html_e( 'All Payment Methods', 'wc-filter-orders-by-payment' ); ?>
				</option>

				<?php foreach ( $gateways as $id => $gateway ) : ?>
				<option value="<?php echo esc_attr( $id ); ?>" <?php echo esc_attr( isset( $_GET['_shop_order_payment_method'] ) ? selected( $id, $_GET['_shop_order_payment_method'], false ) : '' ); ?>>
					<?php echo esc_html( $gateway->get_method_title() ); ?>
				</option>
				<?php endforeach; ?>
			</select>
			<?php
		}
	}


	/**
	 * Process bulk filter order payment method
	 *
	 * @since 1.0.0
	 *
	 * @param array $vars query vars without filtering
	 * @return array $vars query vars with (maybe) filtering
	 */
	public function filter_orders_by_payment_method_query( $vars ) {
		global $typenow;

		if ( 'shop_order' === $typenow && isset( $_GET['_shop_order_payment_method'] ) && ! empty( $_GET['_shop_order_payment_method'] ) ) {

			$vars['meta_key']   = '_payment_method';
			$vars['meta_value'] = wc_clean( $_GET['_shop_order_payment_method'] );
		}

		return $vars;
	}


	/** Helper methods ***************************************/


	/**
	 * Main WC_Filter_Orders_By_Payment Instance, ensures only one instance is/can be loaded
	 *
	 * @since 1.0.0
	 * @see wc_filter_orders_by_payment()
	 * @return WC_Filter_Orders_By_Payment
 	*/
	public static function instance() {

		if ( is_null( self::$instance ) ) {
			self::$instance = new self();
		}

		return self::$instance;
	}


}


/**
 * Returns the One True Instance of WC_Filter_Orders_By_Payment
 *
 * @since 1.0.0
 * @return WC_Filter_Orders_By_Payment
 */
function wc_filter_orders_by_payment() {
    return WC_Filter_Orders_By_Payment::instance();
}

Hi there... i am wondering if you can help me?
i am tying to set different shipping classes to different shipping methods... here is what is what i found so far but dont quite get it:

`add_filter('woocommerce_package_rates', 'manage_method_basedon_shipping_class', 10, 2);
function manage_method_basedon_shipping_class($methods, $package)
{
// $package have cart items, so loop through that and get your shipping classes available in the cart. like $item->get_shipping_class().

// So you have all the classes now. Now based on this unset shipping methods from $method function. $method have all available shipping methods

// now return $methods;

}
`

By adding && wc_clean( $_GET['_shop_order_payment_method'] )!="" you can still search within all orders, including orders that do not have a payment method.

` /**
* Process bulk filter order payment method
*
* @SInCE 1.0.0
*
* @param array $vars query vars without filtering
* @return array $vars query vars with (maybe) filtering
*/
public function filter_orders_by_payment_method_query( $vars ) {
global $typenow;

	if ( 'shop_order' === $typenow && isset( $_GET['_shop_order_payment_method'] ) && wc_clean( $_GET['_shop_order_payment_method'] )!="" ) {

		$vars['meta_key']   = '_payment_method';
		$vars['meta_value'] = wc_clean( $_GET['_shop_order_payment_method'] );
	}

	return $vars;
}`

Can we make it filter the active payment methods only ?, because there are the default payment methods which we don't use and they are deactivated in woocommerce settings, but still appear in the filter dropdown despite we don't have any orders with that default payments methods like the check or pay on delivery.

@magedmoh94
Yes, you can, change line 72 to:
$gateways = WC()->payment_gateways->get_available_payment_gateways();

Thanks so much, exactly what I needed!

I've found some issue with this plugin: if I filter by some payment type and change sorting to sort by amount (order sum) with this filter active, then the orders list is empty.

Hi,

Hello,
Is it also possible to create an N/A filter?

thnx!

I've found some issue with this plugin: if I filter by some payment type and change sorting to sort by amount (order sum) with this filter active, then the orders list is empty.

Encountering the same too.

@magedmoh94
Yes, you can, change line 72 to:
$gateways = WC()->payment_gateways->get_available_payment_gateways();

Thanks for sharing this. Is is possible to show all 'Used' payment gateways instead of 'Active'?
In the situation whereby I would like to still filter by COD, but COD is currently not enabled on site.

awesome plugin!

Just wondering if this can be used in the Analytics > Orders as well. Any suggestions would be appreciated. :-)

To show only enabled gateways, You can use.

            if( $gateway->enabled == 'yes' ):
                
             endif;

To show only enabled gateways, You can use.

            if( $gateway->enabled == 'yes' ):
                
             endif;

I wanted to add this code but wondering where exactly? Line 72?

@magedmoh94
Yes, you can, change line 72 to:
$gateways = WC()->payment_gateways->get_available_payment_gateways();

Thanks for sharing this. Is is possible to show all 'Used' payment gateways instead of 'Active'? In the situation whereby I would like to still filter by COD, but COD is currently not enabled on site.

When I add
$gateways = WC()->payment_gateways->get_available_payment_gateways();

there are some payment gateways missing (bacs & cod). They are activated in WC and I have a lot of orders with this gateway. When I use the code above without changing this line I can see and filter by them.