Woocommerce Archives

Regenerate Woocommerce Download Permissions

We recently imported a large number of orders and files from and older legacy / custom Ecommerce site into a Woocommerce site.

There are a lot of tales to tell in this adventure, but a big one was getting all of these files attached correctly to the product variations downloadable file.

It took a while to find a good solution, but thankfully Chris Hawkins had a good answer for me over on Stack Overflow.

Here is essentially what my solution looked like:

$limit = 10000;
$offset = 0 * $limit;

$orders = get_posts( array(
	'post_type'      => 'shop_order',
	'post_status'    => 'wc-completed',
	'posts_per_page' => $limit,
	'offset'  	 => $offset 
) );

foreach ( $orders as $order ) {
	regen_woo_downloadable_product_permissions( $order->ID, true );
}

/**
 * Regenerate the WooCommerce download permissions for an order
 * @param  Integer $order_id
 */
function regen_woo_downloadable_product_permissions( $order_id ){

    // Remove all existing download permissions for this order.
    // This uses the same code as the "regenerate download permissions" action in the WP admin (https://github.com/woocommerce/woocommerce/blob/3.5.2/includes/admin/meta-boxes/class-wc-meta-box-order-actions.php#L129-L131)
    // An instance of the download's Data Store (WC_Customer_Download_Data_Store) is created and
    // uses its method to delete a download permission from the database by order ID.
    $data_store = WC_Data_Store::load( 'customer-download' );
    $data_store->delete_by_order_id( $order_id );

    // Run WooCommerce's built in function to create the permissions for an order (https://docs.woocommerce.com/wc-apidocs/function-wc_downloadable_product_permissions.html)
    // Setting the second "force" argument to true makes sure that this ignores the fact that permissions
    // have already been generated on the order.
    wc_downloadable_product_permissions( $order_id, true );

}

$limit = 10000;

$offset = 0 * $limit;

$orders = get_posts( array(

'post_type' => 'shop_order',

'post_status' => 'wc-completed',

'posts_per_page' => $limit,

'offset' => $offset

) );

foreach ( $orders as $order ) {

regen_woo_downloadable_product_permissions( $order->ID, true );

}

/**

* Regenerate the WooCommerce download permissions for an order

* @param Integer $order_id

function regen_woo_downloadable_product_permissions( $order_id ){

// Remove all existing download permissions for this order.

// This uses the same code as the "regenerate download permissions" action in the WP admin (https://github.com/woocommerce/woocommerce/blob/3.5.2/includes/admin/meta-boxes/class-wc-meta-box-order-actions.php#L129-L131)

// An instance of the download's Data Store (WC_Customer_Download_Data_Store) is created and

// uses its method to delete a download permission from the database by order ID.

$data_store = WC_Data_Store::load( 'customer-download' );

$data_store->delete_by_order_id( $order_id );

// Run WooCommerce's built in function to create the permissions for an order (https://docs.woocommerce.com/wc-apidocs/function-wc_downloadable_product_permissions.html)

// Setting the second "force" argument to true makes sure that this ignores the fact that permissions

// have already been generated on the order.

wc_downloadable_product_permissions( $order_id, true );

}

This only needs to be run once for each order so this can be run from almost anywhere. Make sure to update your offset until you make it through all your orders AND that you already have all your files in place.

That is it! I hope this helps someone!

Woocommerce Custom Endpoint

Sometimes we need to add a new account menu item for Woocommerce. If you have the same problem the code below should get you 90% of the way there. Just need to build out your own template part.

add_filter ( 'woocommerce_account_menu_items', 'jb_add_woo_item' );
function jb_add_woo_item( $menu_links ){
 
	$new = array( 'attendance' => 'Seminar Attendance' );
 
	// array_slice() is good when you want to add an element between the other ones
	$menu_links = array_slice( $menu_links, 0, 1, true ) 
	+ $new 
	+ array_slice( $menu_links, 1, NULL, true );
 
 
	return $menu_links;
 
 
}
 
add_filter( 'woocommerce_get_endpoint_url', 'jb_hook_endpoint', 10, 4 );
function jb_hook_endpoint( $url, $endpoint, $value, $permalink ){
 
	if( $endpoint === 'attendance' ) {
 
		// ok, here is the place for your custom URL, it could be external
		$url = site_url().'/my-account/attendance/';
 
	}
	return $url;
 
}


add_action( 'init', 'jb_attendance_new_endpoints' );
function jb_attendance_new_endpoints() {
	add_rewrite_endpoint( 'attendance', EP_ROOT | EP_PAGES );
}


// MY ACCOUNT
add_action( 'woocommerce_account_attendance_endpoint', 'jb_attendance_endpoint_content' );
function jb_attendance_endpoint_content() {
	get_template_part('templates/woocommerce/my-account/attendance');
}

add_filter ( 'woocommerce_account_menu_items', 'jb_add_woo_item' );

function jb_add_woo_item( $menu_links ){

$new = array( 'attendance' => 'Seminar Attendance' );

// array_slice() is good when you want to add an element between the other ones

$menu_links = array_slice( $menu_links, 0, 1, true )

+ $new

+ array_slice( $menu_links, 1, NULL, true );

return $menu_links;

}

add_filter( 'woocommerce_get_endpoint_url', 'jb_hook_endpoint', 10, 4 );

function jb_hook_endpoint( $url, $endpoint, $value, $permalink ){

if( $endpoint === 'attendance' ) {

// ok, here is the place for your custom URL, it could be external

$url = site_url().'/my-account/attendance/';

}

return $url;

}

add_action( 'init', 'jb_attendance_new_endpoints' );

function jb_attendance_new_endpoints() {

add_rewrite_endpoint( 'attendance', EP_ROOT | EP_PAGES );

}

// MY ACCOUNT

add_action( 'woocommerce_account_attendance_endpoint', 'jb_attendance_endpoint_content' );

function jb_attendance_endpoint_content() {

get_template_part('templates/woocommerce/my-account/attendance');

}

Multiple Custom Query with paginate_links

Sometimes I need pagination for multiple queries on a single page. Whenever possible I use the built in WordPress functions for this purpose. However, WordPress’ pageinate_links() is really meant for WP custom queries…and preferably one query per page.

Here is an example of how you can use this built in function for your own queries! We are using an example which involves three different email lists we need to display.

First, setup your queries:

global $wpdb;

$page_limit = 10;

$email_types = array('need', 'have', 'news');
$results = array();


foreach($email_types as $email_type){
	$results[$email_type] = array();
	$results[$email_type]['count'] = $wpdb->get_var("SELECT COUNT(email_id) FROM {$wpdb->prefix}email_{$email_type} ORDER BY CREATED DESC");

	$results[$email_type]['total'] = ceil($results[$email_type]['count'] / $page_limit);

	// Check if we are on the 2+ page of this type
	if(! empty($_GET['type']) && $_GET['type'] === $email_type){
		$results[$email_type]['current'] = max(1, get_query_var('paged'));
	}else{
		$results[$email_type]['current'] = 1;
	}

	$offset = ($results[$email_type]['current'] - 1) * $page_limit;
	$results[$email_type]['emails'] = $wpdb->get_results("SELECT * FROM {$wpdb->prefix}email_{$email_type} ORDER BY CREATED DESC LIMIT {$offset},{$page_limit}  ");
}

global $wpdb;

$page_limit = 10;

$email_types = array('need', 'have', 'news');

$results = array();

foreach($email_types as $email_type){

$results[$email_type] = array();

$results[$email_type]['count'] = $wpdb->get_var("SELECT COUNT(email_id) FROM {$wpdb->prefix}email_{$email_type} ORDER BY CREATED DESC");

$results[$email_type]['total'] = ceil($results[$email_type]['count'] / $page_limit);

// Check if we are on the 2+ page of this type

if(! empty($_GET['type']) && $_GET['type'] === $email_type){

$results[$email_type]['current'] = max(1, get_query_var('paged'));

}else{

$results[$email_type]['current'] = 1;

}

$offset = ($results[$email_type]['current'] - 1) * $page_limit;

$results[$email_type]['emails'] = $wpdb->get_results("SELECT * FROM {$wpdb->prefix}email_{$email_type} ORDER BY CREATED DESC LIMIT {$offset},{$page_limit} ");

}

Second, display your results: Note, I am leaving out a lot of the display code, but all the relevant pagination code should be here.

foreach($email_types as $key => $email_type){
	$active = '';
	if(! empty($_GET['type'])){
		if($_GET['type'] === $email_type){
			$active = 'active';
		}
	}else if($key === 0){
		$active = 'active';
	}

	echo '<div class="tab-pane fade show '.$active.'" id="archive-'.$email_type.'">';

	foreach($results[$email_type]['emails'] as $email){
		switch($email_type){
			case 'need':
				jb_display_need_email($email);
				break;
			case 'have':
				jb_display_have_email($email);
				break;
			case 'news':
				jb_display_news_email($email);
				break;
		}
	}


	jb_custom_email_pagination($results[$email_type]['total'], $results[$email_type]['current'], $email_type);


	echo '</div>';

}

foreach($email_types as $key => $email_type){

$active = '';

if(! empty($_GET['type'])){

if($_GET['type'] === $email_type){

$active = 'active';

}

}else if($key === 0){

$active = 'active';

}

echo '<div class="tab-pane fade show '.$active.'" id="archive-'.$email_type.'">';

foreach($results[$email_type]['emails'] as $email){

switch($email_type){

case 'need':

jb_display_need_email($email);

break;

case 'have':

jb_display_have_email($email);

break;

case 'news':

jb_display_news_email($email);

break;

}

jb_custom_email_pagination($results[$email_type]['total'], $results[$email_type]['current'], $email_type);

echo '</div>';

}

Notice at the bottom of this loop we are calling our pagination function for each list. The important thing to note here is that we are using a separate ‘type’ variable so we know which list we are paginating.

Lastly, here is the actual pagination function:

function jb_custom_email_pagination($total, $current, $type){
	echo '<div class="pagination-wrapper">
			<div class="pagination">'.paginate_links( array(
				'base' => str_replace( 9999, '%#%', esc_url( get_pagenum_link( 9999 ) ) ),
				'format' => '&paged=%#%',
				'prev_text' => __('<i class="fas fa-angle-left"></i>'),
				'next_text' => __('<i class="fas fa-angle-right"></i>'),
				'total' => $total,
				'current' => $current,
				'add_args' => array( 'type' => $type )
			)).'</div>
			</div>';
}

function jb_custom_email_pagination($total, $current, $type){

echo '<div class="pagination-wrapper">

<div class="pagination">'.paginate_links( array(

'base' => str_replace( 9999, '%#%', esc_url( get_pagenum_link( 9999 ) ) ),

'format' => '&paged=%#%',

'prev_text' => __('<i class="fas fa-angle-left"></i>'),

'next_text' => __('<i class="fas fa-angle-right"></i>'),

'total' => $total,

'current' => $current,

'add_args' => array( 'type' => $type )

)).'</div>

</div>';

}

Custom Woocommerce ACF Category Filters

We had a client recently that needed to be able to create product filters based on the product categories they were assigned to. This presented a problem because we didn’t want to clog up the taxonomy / category pages with a bunch of filter options and the user also needed to be able to edit these categories in the future.

We took the approach of adding some ACF fields to the product categories and then inserting a meta box on the products based on their selected categories which would list the ACF fields as checkboxes, similar to selecting a taxonomy.

It is hard to explain so here is a bunch of code and images to explain.

Here is our custom meta box displaying the filters that were created in the category page. Notice this is actually displaying the filters from ALL selected categories.

Here are the filters created in one category.

This is what the front end looks like. The checkboxes are FontAwesome icons.

Finally, here is the code needed to accomplish this.

All of this code goes into your “functions.php” file

/**
 * Adds a metabox to the product pages to list the available filters
 * @link: https://wptheming.com/2010/08/custom-metabox-for-post-type/
 */
add_action( 'add_meta_boxes', 'jb_add_filter_metaboxes' );
function jb_add_filter_metaboxes() {
	add_meta_box(
		'jb_product_filters',
		'Product Filters',
		'jb_product_filters',
		'product',
		'side',
		'default'
	);
}

/**
 * Build the filter selection functionality
 * @link: https://wptheming.com/2010/08/custom-metabox-for-post-type/
 */
function jb_product_filters() {
	global $post;
	$terms = wp_get_post_terms($post->ID, 'product_cat', array( 'fields' => 'ids' ));

	$filters = array();
	foreach($terms as $term_id){
		$filter = get_field('filters', 'term_'. $term_id);
		if(! empty($filter)){
			$filters = array_merge($filters, $filter);
		}
	}

	if(! empty($filters)){
		foreach($filters as $filter){
			$meta_key = sanitize_title( $filter['filter_name'] );
			$current_filters = get_post_meta( $post->ID, $meta_key, true );

			if(! empty($current_filters)){
				$current_filters = explode(',',$current_filters);
			}else{
				$current_filters = array();
			}

			echo '<p style="font-weight: bold; margin: 0;">'.$filter['filter_name'].'</p>';

			echo '<ul id="product_filters" class="categorychecklist form-no-clear" style="margin: 0 0 20px;">';
			
			if(! empty($filter['filter_options'])){
				foreach($filter['filter_options'] as $option){
					echo '<li class="wpseo-term-unchecked">
							<label class="selectit">
								<input value="'.$option['option'].'" '.(in_array($option['option'], $current_filters)?'checked="checked"':'').' type="checkbox" name="jb_filter['.$meta_key.'][]"> '.$option['option'].'</label>
							</li>';
				}
			}
				
			echo '</ul>';
		}
	}
}

/**
 * Save the filter information as meta_data that we can query later
 * @link: https://wptheming.com/2010/08/custom-metabox-for-post-type/
 */
add_action( 'save_post', 'jb_save_filter_meta', 1, 2 );
function jb_save_filter_meta( $post_id, $post ) {
	if ( 'revision' === $post->post_type ) {
		return;
	}

	// Return if the user doesn't have edit permissions.
	if ( ! current_user_can( 'edit_post', $post_id ) ) {
		return $post_id;
	}

	// Now that we're authenticated, time to save the data.
	$filter_meta = $_POST['jb_filter'];

	// Cycle through the $filter_meta array.
	foreach ( $filter_meta as $key => $value ) :
		
		$value = implode(',',$value);

		if ( get_post_meta( $post_id, $key, false ) ) {
			// If the custom field already has a value, update it.
			update_post_meta( $post_id, $key, $value );
		} else {
			// If the custom field doesn't have a value, add it.
			add_post_meta( $post_id, $key, $value);
		}
		if ( ! $value ) {
			// Delete the meta key if there's no value
			delete_post_meta( $post_id, $key );
		}
	endforeach;
}

/**
 * Filter products based on submitted filters
 */
add_action( 'pre_get_posts', 'jb_filter_products' );
function jb_filter_products( $query ) {
	if(is_tax()){

		if(! empty($_POST['psearch'])){
			$query->set('s', $_POST['psearch'] );
		}

		if(! empty($_POST['jb_filter'])){
			$meta_query = array('relation' => 'AND');

			foreach($_POST['jb_filter'] as $key => $filter){
				foreach($filter as $value){
					$meta_query[] = array(
						'key'     => $key,
						'compare' => 'LIKE',
						'value'   => $value
					);
				}
				
			}

			$query->set( 'meta_query', $meta_query );
		}

	}
}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

/**

* Adds a metabox to the product pages to list the available filters

* @link: https://wptheming.com/2010/08/custom-metabox-for-post-type/

add_action( 'add_meta_boxes', 'jb_add_filter_metaboxes' );

function jb_add_filter_metaboxes() {

add_meta_box(

'jb_product_filters',

'Product Filters',

'jb_product_filters',

'product',

'side',

'default'

);

}

/**

* Build the filter selection functionality

* @link: https://wptheming.com/2010/08/custom-metabox-for-post-type/

function jb_product_filters() {

global $post;

$terms = wp_get_post_terms($post->ID, 'product_cat', array( 'fields' => 'ids' ));

$filters = array();

foreach($terms as $term_id){

$filter = get_field('filters', 'term_'. $term_id);

if(! empty($filter)){

$filters = array_merge($filters, $filter);

}

if(! empty($filters)){

foreach($filters as $filter){

$meta_key = sanitize_title( $filter['filter_name'] );

$current_filters = get_post_meta( $post->ID, $meta_key, true );

if(! empty($current_filters)){

$current_filters = explode(',',$current_filters);

}else{

$current_filters = array();

}

echo '<p style="font-weight: bold; margin: 0;">'.$filter['filter_name'].'</p>';

echo '<ul id="product_filters" class="categorychecklist form-no-clear" style="margin: 0 0 20px;">';

if(! empty($filter['filter_options'])){

foreach($filter['filter_options'] as $option){

echo '<li class="wpseo-term-unchecked">

<input value="'.$option['option'].'" '.(in_array($option['option'], $current_filters)?'checked="checked"':'').' type="checkbox" name="jb_filter['.$meta_key.'][]"> '.$option['option'].'</label>

</li>';

}

echo '</ul>';

}

/**

* Save the filter information as meta_data that we can query later

* @link: https://wptheming.com/2010/08/custom-metabox-for-post-type/

add_action( 'save_post', 'jb_save_filter_meta', 1, 2 );

function jb_save_filter_meta( $post_id, $post ) {

if ( 'revision' === $post->post_type ) {

return;

}

// Return if the user doesn't have edit permissions.

if ( ! current_user_can( 'edit_post', $post_id ) ) {

return $post_id;

}

// Now that we're authenticated, time to save the data.

$filter_meta = $_POST['jb_filter'];

// Cycle through the $filter_meta array.

foreach ( $filter_meta as $key => $value ) :

$value = implode(',',$value);

if ( get_post_meta( $post_id, $key, false ) ) {

// If the custom field already has a value, update it.

update_post_meta( $post_id, $key, $value );

} else {

// If the custom field doesn't have a value, add it.

add_post_meta( $post_id, $key, $value);

}

if ( ! $value ) {

// Delete the meta key if there's no value

delete_post_meta( $post_id, $key );

}

endforeach;

}

/**

* Filter products based on submitted filters

add_action( 'pre_get_posts', 'jb_filter_products' );

function jb_filter_products( $query ) {

if(is_tax()){

if(! empty($_POST['psearch'])){

$query->set('s', $_POST['psearch'] );

}

if(! empty($_POST['jb_filter'])){

$meta_query = array('relation' => 'AND');

foreach($_POST['jb_filter'] as $key => $filter){

foreach($filter as $value){

$meta_query[] = array(

'key' => $key,

'compare' => 'LIKE',

'value' => $value

);

}

$query->set( 'meta_query', $meta_query );

}

Here is an example of what the front end HTML might look like.

<form id="filter-form" action="<?php echo $_SERVER[REQUEST_URI]; ?>" method="post">
	<div class="search-input">
		<div class="input-group mb-3">
			<input type="text" maxlength="30" class="form-control" id="basic-url" placeholder="Search" name="psearch" value="<?php echo $_POST['psearch']; ?>">
			<div class="input-group-append">
				<button type="submit" class="input-group-text" id="basic-addon2"><i class="far fa-search"></i></button>
			</div>
		</div>
	</div>
	<?php if(! empty($filters)): ?>
		<div class="filter-wrapper">
			<?php 
				foreach($filters as $filter){
					$meta_key = sanitize_title( $filter['filter_name'] );

					echo '<p style="font-weight: bold; margin: 0;">'.$filter['filter_name'].'</p>';

					echo '<ul id="product_filters" class="categorychecklist form-no-clear" style="margin: 0 0 20px;">';
					
					//'.(in_array($option['option'], $current_filters)?'checked="checked"':'').'
					if(! empty($filter['filter_options'])){
						foreach($filter['filter_options'] as $okey => $option){
							echo '<li>
									<input value="'.$option['option'].'" '.(is_array($_POST['jb_filter'][$meta_key]) && in_array($option['option'], $_POST['jb_filter'][$meta_key])?'checked="checked"':'').' id="'.$meta_key.'-'.$okey.'" type="checkbox" class="awesomebox" name="jb_filter['.$meta_key.'][]"><label for="'.$meta_key.'-'.$okey.'" class="selectit">'.$option['option'].'</label>
								</li>';
						}
					}
						
					echo '</ul>';
				}
			?>
		</div>
	<?php endif; ?>
</form>

<form id="filter-form" action="<?php echo $_SERVER[REQUEST_URI]; ?>" method="post">

</div>

<?php if(! empty($filters)): ?>

<?php

foreach($filters as $filter){

$meta_key = sanitize_title( $filter['filter_name'] );

echo '<p style="font-weight: bold; margin: 0;">'.$filter['filter_name'].'</p>';

echo '<ul id="product_filters" class="categorychecklist form-no-clear" style="margin: 0 0 20px;">';

//'.(in_array($option['option'], $current_filters)?'checked="checked"':'').'

if(! empty($filter['filter_options'])){

foreach($filter['filter_options'] as $okey => $option){

echo '<li>

<input value="'.$option['option'].'" '.(is_array($_POST['jb_filter'][$meta_key]) && in_array($option['option'], $_POST['jb_filter'][$meta_key])?'checked="checked"':'').' id="'.$meta_key.'-'.$okey.'" type="checkbox" class="awesomebox" name="jb_filter['.$meta_key.'][]"><label for="'.$meta_key.'-'.$okey.'" class="selectit">'.$option['option'].'</label>

</li>';

}

echo '</ul>';

}

</div>

<?php endif; ?>

</form>

Reorder Posts By Menu Order, then Post Title

This can be done using $args = array( ‘orderby’ => array(‘menu_order’,’title’)) however then you are using a 0 index menu_order (0 menu order goes first) and the first letter of the post title (rather than by say, the last name in the post title). So this is just a function to give a little more control over that ordering

//sort our posts by their menu_order then by alpha value
function jb_reorder_posts($a, $b){
	
	//First take anyone with a menu order and order then first
	if($a->menu_order && ! $b->menu_order){
		return -1;
	}else if(! $a->menu_order && $b->menu_order){
		return 1;
	}else if($a->menu_order > $b->menu_order){
		return 1;
	}else if($a->menu_order < $b->menu_order){
		return -1;
	}

	//if neither person has a menu order, order by last name
	//$a_last_name = end(explode(' ', $a->post_title));
	//$b_last_name = end(explode(' ', $b->post_title));

	//return strcmp($a_last_name, $b_last_name);
        return strcmp($a->post_title, $b->post_title);
}

//Using WP_Query
usort($new_query->posts, 'jb_reorder_posts' );

//Using get_posts()
usort($posts, 'jb_reorder_posts' );

//sort our posts by their menu_order then by alpha value

function jb_reorder_posts($a, $b){

//First take anyone with a menu order and order then first

if($a->menu_order && ! $b->menu_order){

return -1;

}else if(! $a->menu_order && $b->menu_order){

return 1;

}else if($a->menu_order > $b->menu_order){

return 1;

}else if($a->menu_order < $b->menu_order){

return -1;

}

//if neither person has a menu order, order by last name

//$a_last_name = end(explode(' ', $a->post_title));

//$b_last_name = end(explode(' ', $b->post_title));

//return strcmp($a_last_name, $b_last_name);

return strcmp($a->post_title, $b->post_title);

}

//Using WP_Query

usort($new_query->posts, 'jb_reorder_posts' );

//Using get_posts()

usort($posts, 'jb_reorder_posts' );

List Woocommerce Cart Item Attributes

90% of the time I am very thankful for plugins like Woocommerce, that handle so much of the architecture associated with an e-commerce site.

10% of the time I curse their name in the more profane manner possible. This seems to happen most often when using variable products.

For reasons that defy reason, Woocommerce does not list the variable product’s attributes when it is in your cart. There is also no Woocommerce function, afaik, to easily list a cart items selected attributes. Why on earth would someone want to know what type of product they put in their cart! Bah!

Anyway, here is some simple code to list the attributes for the variable products in your cart:

//inside of the /themes/woocommerce/cart.php template
//usually in the "name" or "details" area

$item_data = $cart_item['data'];
$attributes = $item_data->get_attributes();
foreach ( $attributes as $attribute => $attribute_name ) {
	$term = get_term_by('slug', $attribute_name, $attribute);

	echo wc_attribute_label( $attribute ).': '.$term->name;

}

//inside of the /themes/woocommerce/cart.php template

//usually in the "name" or "details" area

$item_data = $cart_item['data'];

$attributes = $item_data->get_attributes();

foreach ( $attributes as $attribute => $attribute_name ) {

$term = get_term_by('slug', $attribute_name, $attribute);

echo wc_attribute_label( $attribute ).': '.$term->name;

}

Hopefully that will save you 1% more time of cursing the name Woocommerce!