woocommerce/woocommerce-core-functions.php

767 lines
23 KiB
PHP

<?php
/**
* WooCommerce Core Functions
*
* Functions available on both the front-end and admin.
*
* @package WooCommerce
* @category Core
* @author WooThemes
*/
/**
* HTML emails from WooCommerce
**/
function woocommerce_mail( $to, $subject, $message, $headers = "Content-Type: text/html\r\n", $attachments = "" ) {
global $woocommerce;
$mailer = $woocommerce->mailer();
$mailer->send( $to, $subject, $message, $headers, $attachments );
}
/**
* Prevent caching
**/
function woocommerce_nocache() {
if(!defined('DONOTCACHEPAGE')) {
define("DONOTCACHEPAGE", "true"); // WP Super Cache constant
}
}
/**
* WooCommerce page IDs
*
* retrieve page ids - used for myaccount, edit_address, change_password, shop, cart, checkout, pay, view_order, thanks, terms, order_tracking
*
* returns -1 if no page is found
**/
if (!function_exists('woocommerce_get_page_id')) {
function woocommerce_get_page_id( $page ) {
$page = apply_filters('woocommerce_get_' . $page . '_page_id', get_option('woocommerce_' . $page . '_page_id'));
return ($page) ? $page : -1;
}
}
/**
* WooCommerce clear cart
*
* Clears the cart session when called
**/
if (!function_exists('woocommerce_empty_cart')) {
function woocommerce_empty_cart() {
global $woocommerce;
if (!isset($woocommerce->cart) || $woocommerce->cart == '' ) $woocommerce->cart = new WC_Cart();
$woocommerce->cart->empty_cart();
}
}
/**
* WooCommerce conditionals
*
* is_woocommerce - Returns true if on a page which uses WooCommerce templates (cart and checkout are standard pages with shortcodes and thus are not included)
**/
function is_woocommerce() {
if (is_shop() || is_product_category() || is_product_tag() || is_product()) return true; else return false;
}
if (!function_exists('is_shop')) {
function is_shop() {
if (is_post_type_archive( 'product' ) || is_page(woocommerce_get_page_id('shop'))) return true; else return false;
}
}
if (!function_exists('is_product_category')) {
function is_product_category() {
return is_tax( 'product_cat' );
}
}
if (!function_exists('is_product_tag')) {
function is_product_tag() {
return is_tax( 'product_tag' );
}
}
if (!function_exists('is_product')) {
function is_product() {
return is_singular( array('product') );
}
}
if (!function_exists('is_cart')) {
function is_cart() {
return is_page(woocommerce_get_page_id('cart'));
}
}
if (!function_exists('is_checkout')) {
function is_checkout() {
if (is_page(woocommerce_get_page_id('checkout')) || is_page(woocommerce_get_page_id('pay'))) return true; else return false;
}
}
if (!function_exists('is_account_page')) {
function is_account_page() {
if ( is_page(woocommerce_get_page_id('myaccount')) || is_page(woocommerce_get_page_id('edit_address')) || is_page(woocommerce_get_page_id('view_order')) || is_page(woocommerce_get_page_id('change_password')) ) return true; else return false;
}
}
if (!function_exists('is_ajax')) {
function is_ajax() {
if ( defined('DOING_AJAX') ) return true;
if ( isset($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest' ) return true; else return false;
}
}
/**
* Get template part (for templates like the shop-loop)
*/
function woocommerce_get_template_part( $slug, $name = '' ) {
global $woocommerce;
if ($name=='shop' && !locate_template(array( 'loop-shop.php', $woocommerce->template_url . 'loop-shop.php' ))) {
load_template( $woocommerce->plugin_path() . '/templates/loop-shop.php',false );
return;
} elseif ($name=='shop' && locate_template(array( $woocommerce->template_url . 'loop-shop.php' ))) {
get_template_part( $woocommerce->template_url . $slug, $name );
return;
}
get_template_part( $slug, $name );
}
/**
* Get other templates (e.g. product attributes) passing attributes and including the file
*/
function woocommerce_get_template($template_name, $args = array()) {
global $woocommerce;
if ( $args && is_array($args) )
extract( $args );
include( woocommerce_locate_template( $template_name ) );
}
/**
* Locate a template and return the path for inclusion
*/
function woocommerce_locate_template( $template_name ) {
global $woocommerce;
// Look in yourtheme/woocommerce/template-name and yourtheme/template-name
$template = locate_template( array( $woocommerce->template_url . $template_name , $template_name ) );
// Get default template
if (!$template) $template = $woocommerce->plugin_path() . '/templates/' . $template_name;
return $template;
}
/**
* Currency
**/
function get_woocommerce_currency_symbol( $currency = '' ) {
if (!$currency) $currency = get_option('woocommerce_currency');
$currency_symbol = '';
switch ($currency) :
case 'BRL' : $currency_symbol = 'R&#36;'; break; // in Brazil the correct is R$ 0.00,00
case 'AUD' :
case 'CAD' :
case 'MXN' :
case 'NZD' :
case 'HKD' :
case 'SGD' :
case 'USD' : $currency_symbol = '&#36;'; break;
case 'EUR' : $currency_symbol = '&euro;'; break;
case 'JPY' : $currency_symbol = '&yen;'; break;
case 'TRY' : $currency_symbol = 'TL'; break;
case 'NOK' : $currency_symbol = 'kr'; break;
case 'ZAR' : $currency_symbol = 'R'; break;
case 'CZK' : $currency_symbol = '&#75;&#269;'; break;
case 'DKK' :
case 'HUF' :
case 'ILS' :
case 'MYR' :
case 'PHP' :
case 'PLN' :
case 'SEK' :
case 'CHF' :
case 'TWD' :
case 'THB' : $currency_symbol = $currency; break;
case 'GBP' :
default : $currency_symbol = '&pound;'; break;
endswitch;
return apply_filters('woocommerce_currency_symbol', $currency_symbol, $currency);
}
/**
* Price Formatting Helper
**/
function woocommerce_price( $price, $args = array() ) {
global $woocommerce;
extract(shortcode_atts(array(
'ex_tax_label' => '0'
), $args));
$return = '';
$num_decimals = (int) get_option('woocommerce_price_num_decimals');
$currency_pos = get_option('woocommerce_currency_pos');
$currency_symbol = get_woocommerce_currency_symbol();
$price = number_format( (double) $price, $num_decimals, get_option('woocommerce_price_decimal_sep'), get_option('woocommerce_price_thousand_sep') );
if (get_option('woocommerce_price_trim_zeros')=='yes' && $num_decimals>0) :
$price = woocommerce_trim_zeros($price);
endif;
switch ($currency_pos) :
case 'left' :
$return = '<span class="amount">'. $currency_symbol . $price . '</span>';
break;
case 'right' :
$return = '<span class="amount">'. $price . $currency_symbol . '</span>';
break;
case 'left_space' :
$return = '<span class="amount">'. $currency_symbol . ' ' . $price . '</span>';
break;
case 'right_space' :
$return = '<span class="amount">'. $price . ' ' . $currency_symbol . '</span>';
break;
endswitch;
if ($ex_tax_label && get_option('woocommerce_calc_taxes')=='yes') $return .= ' <small>'.$woocommerce->countries->ex_tax_or_vat().'</small>';
return $return;
}
/**
* Trim trailing zeros
**/
function woocommerce_trim_zeros( $price ) {
return preg_replace('/'.preg_quote(get_option('woocommerce_price_decimal_sep'), '/').'0++$/', '', $price);
}
/**
* Clean variables
**/
function woocommerce_clean( $var ) {
return trim(strip_tags(stripslashes($var)));
}
/**
* Merge two arrays
**/
function woocommerce_array_overlay($a1,$a2) {
foreach($a1 as $k => $v) {
if(!array_key_exists($k,$a2)) continue;
if(is_array($v) && is_array($a2[$k])){
$a1[$k] = woocommerce_array_overlay($v,$a2[$k]);
}else{
$a1[$k] = $a2[$k];
}
}
return $a1;
}
/**
* Get top term
* http://wordpress.stackexchange.com/questions/24794/get-the-the-top-level-parent-of-a-custom-taxonomy-term
**/
function woocommerce_get_term_top_most_parent($term_id, $taxonomy) {
// start from the current term
$parent = get_term_by( 'id', $term_id, $taxonomy);
// climb up the hierarchy until we reach a term with parent = '0'
while ($parent->parent != '0'){
$term_id = $parent->parent;
$parent = get_term_by( 'id', $term_id, $taxonomy);
}
return $parent;
}
/**
* Variation Formatting
*
* Gets a formatted version of variation data or item meta
**/
function woocommerce_get_formatted_variation( $variation = '', $flat = false ) {
global $woocommerce;
if (is_array($variation)) :
if (!$flat) $return = '<dl class="variation">'; else $return = '';
$variation_list = array();
foreach ($variation as $name => $value) :
if (!$value) continue;
// If this is a term slug, get the term's nice name
if (taxonomy_exists(esc_attr(str_replace('attribute_', '', $name)))) :
$term = get_term_by('slug', $value, esc_attr(str_replace('attribute_', '', $name)));
if (!is_wp_error($term) && $term->name) :
$value = $term->name;
endif;
else :
$value = ucfirst($value);
endif;
if ($flat) :
$variation_list[] = $woocommerce->attribute_label(str_replace('attribute_', '', $name)).': '.$value;
else :
$variation_list[] = '<dt>'.$woocommerce->attribute_label(str_replace('attribute_', '', $name)).':</dt><dd>'.$value.'</dd>';
endif;
endforeach;
if ($flat) :
$return .= implode(', ', $variation_list);
else :
$return .= implode('', $variation_list);
endif;
if (!$flat) $return .= '</dl>';
return $return;
endif;
}
/**
* Hex darker/lighter/contrast functions for colours
**/
if (!function_exists('woocommerce_hex_darker')) {
function woocommerce_hex_darker( $color, $factor = 30 ) {
$color = str_replace('#', '', $color);
$base['R'] = hexdec($color{0}.$color{1});
$base['G'] = hexdec($color{2}.$color{3});
$base['B'] = hexdec($color{4}.$color{5});
$color = '#';
foreach ($base as $k => $v) :
$amount = $v / 100;
$amount = round($amount * $factor);
$new_decimal = $v - $amount;
$new_hex_component = dechex($new_decimal);
if(strlen($new_hex_component) < 2) :
$new_hex_component = "0".$new_hex_component;
endif;
$color .= $new_hex_component;
endforeach;
return $color;
}
}
if (!function_exists('woocommerce_hex_lighter')) {
function woocommerce_hex_lighter( $color, $factor = 30 ) {
$color = str_replace('#', '', $color);
$base['R'] = hexdec($color{0}.$color{1});
$base['G'] = hexdec($color{2}.$color{3});
$base['B'] = hexdec($color{4}.$color{5});
$color = '#';
foreach ($base as $k => $v) :
$amount = 255 - $v;
$amount = $amount / 100;
$amount = round($amount * $factor);
$new_decimal = $v + $amount;
$new_hex_component = dechex($new_decimal);
if(strlen($new_hex_component) < 2) :
$new_hex_component = "0".$new_hex_component;
endif;
$color .= $new_hex_component;
endforeach;
return $color;
}
}
if (!function_exists('woocommerce_light_or_dark')) {
function woocommerce_light_or_dark( $color, $dark = '#000000', $light = '#FFFFFF' ) {
return (hexdec($color) > 0xffffff/2) ? $dark : $light;
}
}
/**
* Exclude order comments from queries and RSS
*
* This code should exclude shop_order comments from queries. Some queries (like the recent comments widget on the dashboard) are hardcoded
* and are not filtered, however, the code current_user_can( 'read_post', $comment->comment_post_ID ) should keep them safe since only admin and
* shop managers can view orders anyway.
*
* The frontend view order pages get around this filter by using remove_filter('comments_clauses', 'woocommerce_exclude_order_comments');
**/
add_filter( 'comments_clauses', 'woocommerce_exclude_order_comments', 10, 1);
add_action( 'comment_feed_join', 'woocommerce_exclude_order_comments_from_feed_join' );
add_action( 'comment_feed_where', 'woocommerce_exclude_order_comments_from_feed_where' );
function woocommerce_exclude_order_comments( $clauses ) {
global $wpdb, $typenow;
if (is_admin() && $typenow=='shop_order') return $clauses; // Don't hide when viewing orders in admin
$clauses['join'] = "LEFT JOIN $wpdb->posts ON $wpdb->comments.comment_post_ID = $wpdb->posts.ID";
if ($clauses['where']) $clauses['where'] .= ' AND ';
$clauses['where'] .= "
$wpdb->posts.post_type NOT IN ('shop_order')
";
return $clauses;
}
function woocommerce_exclude_order_comments_from_feed_join( $join ) {
global $wpdb;
if (!$join) $join = "JOIN $wpdb->posts ON ( $wpdb->comments.comment_post_ID = $wpdb->posts.ID )";
return $join;
}
function woocommerce_exclude_order_comments_from_feed_where( $where ) {
global $wpdb;
if ($where) $where .= ' AND ';
$where .= "$wpdb->posts.post_type NOT IN ('shop_order')";
return $where;
}
/**
* Order Status completed - GIVE DOWNLOADABLE PRODUCT ACCESS TO CUSTOMER
**/
add_action('woocommerce_order_status_completed', 'woocommerce_downloadable_product_permissions');
function woocommerce_downloadable_product_permissions( $order_id ) {
global $wpdb;
$order = new WC_Order( $order_id );
if (sizeof($order->get_items())>0) foreach ($order->get_items() as $item) :
if ($item['id']>0) :
$_product = $order->get_product_from_item( $item );
if ( $_product->exists && $_product->is_downloadable() ) :
$download_id = ($item['variation_id']>0) ? $item['variation_id'] : $item['id'];
$user_email = $order->billing_email;
if ($order->user_id>0) :
$user_info = get_userdata($order->user_id);
if ($user_info->user_email) :
$user_email = $user_info->user_email;
endif;
else :
$order->user_id = 0;
endif;
$limit = trim(get_post_meta($download_id, '_download_limit', true));
if (!empty($limit)) :
$limit = (int) $limit;
else :
$limit = '';
endif;
// Downloadable product - give access to the customer
$wpdb->insert( $wpdb->prefix . 'woocommerce_downloadable_product_permissions', array(
'product_id' => $download_id,
'user_id' => $order->user_id,
'user_email' => $user_email,
'order_id' => $order->id,
'order_key' => $order->order_key,
'downloads_remaining' => $limit
), array(
'%s',
'%s',
'%s',
'%s',
'%s',
'%s'
) );
endif;
endif;
endforeach;
}
/**
* Order Status completed - This is a paying customer
**/
add_action('woocommerce_order_status_completed', 'woocommerce_paying_customer');
function woocommerce_paying_customer( $order_id ) {
$order = new WC_Order( $order_id );
if ( $order->user_id > 0 ) update_user_meta( $order->user_id, 'paying_customer', 1 );
}
/**
* Filter to allow product_cat in the permalinks for products.
*
* @param string $permalink The existing permalink URL.
*/
add_filter( 'post_type_link', 'woocommerce_product_cat_filter_post_link', 10, 4 );
function woocommerce_product_cat_filter_post_link( $permalink, $post, $leavename, $sample ) {
// Abort if post is not a product
if ($post->post_type!=='product') return $permalink;
// Abort early if the placeholder rewrite tag isn't in the generated URL
if ( false === strpos( $permalink, '%product_cat%' ) ) return $permalink;
// Get the custom taxonomy terms in use by this post
$terms = get_the_terms( $post->ID, 'product_cat' );
if ( empty( $terms ) ) :
// If no terms are assigned to this post, use a string instead (can't leave the placeholder there)
$permalink = str_replace( '%product_cat%', __('product', 'woocommerce'), $permalink );
else :
// Replace the placeholder rewrite tag with the first term's slug
$first_term = array_shift( $terms );
$permalink = str_replace( '%product_cat%', $first_term->slug, $permalink );
endif;
return $permalink;
}
/**
* Add term ordering to get_terms
*
* It enables the support a 'menu_order' parameter to get_terms for the product_cat taxonomy.
* By default it is 'ASC'. It accepts 'DESC' too
*
* To disable it, set it ot false (or 0)
*
*/
add_filter( 'terms_clauses', 'woocommerce_terms_clauses', 10, 3);
function woocommerce_terms_clauses($clauses, $taxonomies, $args ) {
global $wpdb, $woocommerce;
// No sorting when menu_order is false
if ( isset($args['menu_order']) && $args['menu_order'] == false ) return $clauses;
// No sorting when orderby is non default
if ( isset($args['orderby']) && $args['orderby'] != 'name' ) return $clauses;
// No sorting in admin when sorting by a column
if ( isset($_GET['orderby']) ) return $clauses;
// wordpress should give us the taxonomies asked when calling the get_terms function. Only apply to categories and pa_ attributes
$found = false;
foreach ((array) $taxonomies as $taxonomy) :
if ($taxonomy=='product_cat' || strstr($taxonomy, 'pa_')) :
$found = true;
break;
endif;
endforeach;
if (!$found) return $clauses;
// Meta name
if (strstr($taxonomies[0], 'pa_')) :
$meta_name = 'order_' . esc_attr($taxonomies[0]);
else :
$meta_name = 'order';
endif;
// query fields
if( strpos('COUNT(*)', $clauses['fields']) === false ) $clauses['fields'] .= ', tm.* ';
//query join
$clauses['join'] .= " LEFT JOIN {$wpdb->woocommerce_termmeta} AS tm ON (t.term_id = tm.woocommerce_term_id AND tm.meta_key = '". $meta_name ."') ";
// default to ASC
if( ! isset($args['menu_order']) || ! in_array( strtoupper($args['menu_order']), array('ASC', 'DESC')) ) $args['menu_order'] = 'ASC';
$order = "ORDER BY CAST(tm.meta_value AS SIGNED) " . $args['menu_order'];
if ( $clauses['orderby'] ):
$clauses['orderby'] = str_replace('ORDER BY', $order . ',', $clauses['orderby'] );
else:
$clauses['orderby'] = $order;
endif;
return $clauses;
}
/**
* WooCommerce Dropdown categories
*
* Stuck with this until a fix for http://core.trac.wordpress.org/ticket/13258
* We use a custom walker, just like WordPress does it
*/
function woocommerce_product_dropdown_categories( $show_counts = 1, $hierarchal = 1 ) {
global $wp_query;
$r = array();
$r['pad_counts'] = 1;
$r['hierarchal'] = $hierarchal;
$r['hide_empty'] = 1;
$r['show_count'] = 1;
$r['selected'] = (isset($wp_query->query['product_cat'])) ? $wp_query->query['product_cat'] : '';
$terms = get_terms( 'product_cat', $r );
if (!$terms) return;
$output = "<select name='product_cat' id='dropdown_product_cat'>";
$output .= '<option value="">'.__('Select a category', 'woocommerce').'</option>';
$output .= woocommerce_walk_category_dropdown_tree( $terms, 0, $r );
$output .="</select>";
echo $output;
}
/**
* Walk the Product Categories.
*/
function woocommerce_walk_category_dropdown_tree() {
$args = func_get_args();
// the user's options are the third parameter
if ( empty($args[2]['walker']) || !is_a($args[2]['walker'], 'Walker') )
$walker = new WC_Walker_CategoryDropdown;
else
$walker = $args[2]['walker'];
return call_user_func_array(array( &$walker, 'walk' ), $args );
}
/**
* Create HTML dropdown list of Product Categories.
*/
class WC_Walker_CategoryDropdown extends Walker {
var $tree_type = 'category';
var $db_fields = array ('parent' => 'parent', 'id' => 'term_id', 'slug' => 'slug' );
function start_el(&$output, $category, $depth, $args) {
$pad = str_repeat('&nbsp;', $depth * 3);
$cat_name = apply_filters('list_product_cats', $category->name, $category);
$output .= "\t<option class=\"level-$depth\" value=\"".$category->slug."\"";
if ( $category->slug == $args['selected'] )
$output .= ' selected="selected"';
$output .= '>';
$output .= $pad.$cat_name;
if ( $args['show_count'] )
$output .= '&nbsp;('. $category->count .')';
$output .= "</option>\n";
}
}
/**
* WooCommerce Term Meta API
*
* API for working with term meta data. Adapted from 'Term meta API' by Nikolay Karev
*
*/
add_action( 'init', 'woocommerce_taxonomy_metadata_wpdbfix', 0 );
add_action( 'switch_blog', 'woocommerce_taxonomy_metadata_wpdbfix', 0 );
function woocommerce_taxonomy_metadata_wpdbfix() {
global $wpdb;
$variable_name = 'woocommerce_termmeta';
$wpdb->$variable_name = $wpdb->prefix . $variable_name;
$wpdb->tables[] = $variable_name;
}
function update_woocommerce_term_meta($term_id, $meta_key, $meta_value, $prev_value = ''){
return update_metadata('woocommerce_term', $term_id, $meta_key, $meta_value, $prev_value);
}
function add_woocommerce_term_meta($term_id, $meta_key, $meta_value, $unique = false){
return add_metadata('woocommerce_term', $term_id, $meta_key, $meta_value, $unique);
}
function delete_woocommerce_term_meta($term_id, $meta_key, $meta_value = '', $delete_all = false){
return delete_metadata('woocommerce_term', $term_id, $meta_key, $meta_value, $delete_all);
}
function get_woocommerce_term_meta($term_id, $key, $single = true){
return get_metadata('woocommerce_term', $term_id, $key, $single);
}
/**
* Move a term before the a given element of its hierarchy level
*
* @param object $the_term
* @param int $next_id the id of the next slibling element in save hierachy level
* @param int $index
* @param int $terms
*/
function woocommerce_order_terms( $the_term, $next_id, $taxonomy, $index=0, $terms=null ) {
if( ! $terms ) $terms = get_terms($taxonomy, 'menu_order=ASC&hide_empty=0&parent=0');
if( empty( $terms ) ) return $index;
$id = $the_term->term_id;
$term_in_level = false; // flag: is our term to order in this level of terms
foreach ($terms as $term) {
if( $term->term_id == $id ) { // our term to order, we skip
$term_in_level = true;
continue; // our term to order, we skip
}
// the nextid of our term to order, lets move our term here
if(null !== $next_id && $term->term_id == $next_id) {
$index++;
$index = woocommerce_set_term_order($id, $index, $taxonomy, true);
}
// set order
$index++;
$index = woocommerce_set_term_order($term->term_id, $index, $taxonomy);
// if that term has children we walk through them
$children = get_terms($taxonomy, "parent={$term->term_id}&menu_order=ASC&hide_empty=0");
if( !empty($children) ) {
$index = woocommerce_order_terms( $the_term, $next_id, $taxonomy, $index, $children );
}
}
// no nextid meaning our term is in last position
if( $term_in_level && null === $next_id )
$index = woocommerce_set_term_order($id, $index+1, $taxonomy, true);
return $index;
}
/**
* Set the sort order of a term
*
* @param int $term_id
* @param int $index
* @param bool $recursive
*/
function woocommerce_set_term_order($term_id, $index, $taxonomy, $recursive=false) {
global $wpdb;
$term_id = (int) $term_id;
$index = (int) $index;
// Meta name
if (strstr($taxonomy, 'pa_')) :
$meta_name = 'order_' . esc_attr($taxonomy);
else :
$meta_name = 'order';
endif;
update_woocommerce_term_meta( $term_id, $meta_name, $index );
if( ! $recursive ) return $index;
$children = get_terms($taxonomy, "parent=$term_id&menu_order=ASC&hide_empty=0");
foreach ( $children as $term ) {
$index ++;
$index = woocommerce_set_term_order($term->term_id, $index, $taxonomy, true);
}
return $index;
}