2013-09-12 13:41:02 +00:00
< ? php
/**
2015-11-03 13:53:50 +00:00
* WooCommerce Attribute Functions
2013-09-12 13:41:02 +00:00
*
* @ author WooThemes
* @ category Core
* @ package WooCommerce / Functions
* @ version 2.1 . 0
*/
2014-09-20 19:04:38 +00:00
if ( ! defined ( 'ABSPATH' ) ) {
exit ; // Exit if accessed directly
}
2013-09-12 13:41:02 +00:00
2015-06-11 13:42:37 +00:00
/**
2015-11-03 13:31:20 +00:00
* Gets text attributes from a string .
2015-06-11 13:42:37 +00:00
*
* @ since 2.4
* @ return array
*/
function wc_get_text_attributes ( $raw_attributes ) {
2016-10-25 11:42:31 +00:00
return array_filter ( array_map ( 'trim' , explode ( WC_DELIMITER , html_entity_decode ( $raw_attributes , ENT_QUOTES , get_bloginfo ( 'charset' ) ) ) ), 'wc_get_text_attributes_filter_callback' );
}
/**
* See if an attribute is actually valid .
* @ since 2.7 . 0
* @ param string $value
* @ return bool
*/
function wc_get_text_attributes_filter_callback ( $value ) {
return '' !== $value ;
2015-06-11 13:42:37 +00:00
}
2013-09-12 13:41:02 +00:00
/**
* Get attribute taxonomies .
*
2015-08-11 16:10:32 +00:00
* @ return array of objects
2013-09-12 13:41:02 +00:00
*/
function wc_get_attribute_taxonomies () {
2015-11-13 23:06:51 +00:00
if ( false === ( $attribute_taxonomies = get_transient ( 'wc_attribute_taxonomies' ) ) ) {
2013-09-12 13:41:02 +00:00
global $wpdb ;
2015-12-27 21:32:55 +00:00
$attribute_taxonomies = $wpdb -> get_results ( " SELECT * FROM " . $wpdb -> prefix . " woocommerce_attribute_taxonomies order by attribute_name ASC; " );
2013-09-12 13:41:02 +00:00
2015-11-13 23:06:51 +00:00
set_transient ( 'wc_attribute_taxonomies' , $attribute_taxonomies );
2013-09-12 13:41:02 +00:00
}
2015-08-11 16:10:32 +00:00
return ( array ) array_filter ( apply_filters ( 'woocommerce_attribute_taxonomies' , $attribute_taxonomies ) );
2013-09-12 13:41:02 +00:00
}
/**
2015-12-04 18:02:07 +00:00
* Get a product attribute name .
2013-09-12 13:41:02 +00:00
*
2015-12-04 18:02:07 +00:00
* @ param string $attribute_name Attribute name .
2013-09-12 13:41:02 +00:00
* @ return string
*/
2015-12-04 18:02:07 +00:00
function wc_attribute_taxonomy_name ( $attribute_name ) {
return 'pa_' . wc_sanitize_taxonomy_name ( $attribute_name );
}
2016-02-15 15:53:43 +00:00
/**
* Get the attribute name used when storing values in post meta .
*
* @ param string $attribute_name Attribute name .
* @ since 2.6 . 0
* @ return string
*/
function wc_variation_attribute_name ( $attribute_name ) {
return 'attribute_' . sanitize_title ( $attribute_name );
}
2015-12-04 18:02:07 +00:00
/**
* Get a product attribute name by ID .
*
* @ since 2.4 . 0
* @ param int $attribute_id Attribute ID .
* @ return string Return an empty string if attribute doesn ' t exist .
*/
function wc_attribute_taxonomy_name_by_id ( $attribute_id ) {
global $wpdb ;
$attribute_name = $wpdb -> get_var ( $wpdb -> prepare ( "
SELECT attribute_name
FROM { $wpdb -> prefix } woocommerce_attribute_taxonomies
WHERE attribute_id = % d
" , $attribute_id ) );
if ( $attribute_name && ! is_wp_error ( $attribute_name ) ) {
return wc_attribute_taxonomy_name ( $attribute_name );
}
return '' ;
2013-09-12 13:41:02 +00:00
}
2016-06-02 20:34:26 +00:00
/**
* Get a product attribute ID by name .
*
* @ since 2.6 . 0
* @ param string $name Attribute name .
* @ return int
*/
function wc_attribute_taxonomy_id_by_name ( $name ) {
$name = str_replace ( 'pa_' , '' , $name );
$taxonomies = wp_list_pluck ( wc_get_attribute_taxonomies (), 'attribute_id' , 'attribute_name' );
return isset ( $taxonomies [ $name ] ) ? ( int ) $taxonomies [ $name ] : 0 ;
}
2013-09-12 13:41:02 +00:00
/**
* Get a product attributes label .
*
2015-03-09 13:40:07 +00:00
* @ param string $name
* @ param object $product object Optional
2013-09-12 13:41:02 +00:00
* @ return string
*/
2015-03-09 13:40:07 +00:00
function wc_attribute_label ( $name , $product = '' ) {
2013-09-12 13:41:02 +00:00
global $wpdb ;
if ( taxonomy_is_product_attribute ( $name ) ) {
2016-08-25 16:34:18 +00:00
$name = wc_sanitize_taxonomy_name ( str_replace ( 'pa_' , '' , $name ) );
$all_labels = wp_list_pluck ( wc_get_attribute_taxonomies (), 'attribute_label' , 'attribute_name' );
$label = isset ( $all_labels [ $name ] ) ? $all_labels [ $name ] : $name ;
2015-03-09 13:40:07 +00:00
} elseif ( $product && ( $attributes = $product -> get_attributes () ) && isset ( $attributes [ sanitize_title ( $name ) ][ 'name' ] ) ) {
// Attempt to get label from product, as entered by the user
$label = $attributes [ sanitize_title ( $name ) ][ 'name' ];
2013-09-12 13:41:02 +00:00
} else {
2016-09-06 09:40:08 +00:00
$label = $name ;
2013-09-12 13:41:02 +00:00
}
2015-03-09 13:40:07 +00:00
return apply_filters ( 'woocommerce_attribute_label' , $label , $name , $product );
2013-09-12 13:41:02 +00:00
}
/**
* Get a product attributes orderby setting .
*
* @ param mixed $name
* @ return string
*/
function wc_attribute_orderby ( $name ) {
2016-02-10 11:07:42 +00:00
global $wc_product_attributes , $wpdb ;
2013-09-12 13:41:02 +00:00
$name = str_replace ( 'pa_' , '' , sanitize_title ( $name ) );
2016-02-10 11:07:42 +00:00
if ( isset ( $wc_product_attributes [ 'pa_' . $name ] ) ) {
$orderby = $wc_product_attributes [ 'pa_' . $name ] -> attribute_orderby ;
} else {
$orderby = $wpdb -> get_var ( $wpdb -> prepare ( " SELECT attribute_orderby FROM " . $wpdb -> prefix . " woocommerce_attribute_taxonomies WHERE attribute_name = %s; " , $name ) );
}
2013-09-12 13:41:02 +00:00
return apply_filters ( 'woocommerce_attribute_orderby' , $orderby , $name );
}
/**
* Get an array of product attribute taxonomies .
*
* @ return array
*/
function wc_get_attribute_taxonomy_names () {
$taxonomy_names = array ();
$attribute_taxonomies = wc_get_attribute_taxonomies ();
2016-06-06 16:24:31 +00:00
if ( ! empty ( $attribute_taxonomies ) ) {
2013-09-12 13:41:02 +00:00
foreach ( $attribute_taxonomies as $tax ) {
$taxonomy_names [] = wc_attribute_taxonomy_name ( $tax -> attribute_name );
}
}
return $taxonomy_names ;
2014-03-07 08:29:01 +00:00
}
2015-04-27 15:31:34 +00:00
/**
* Get attribute types .
*
* @ since 2.4 . 0
* @ return array
*/
function wc_get_attribute_types () {
return ( array ) apply_filters ( 'product_attributes_type_selector' , array (
'select' => __ ( 'Select' , 'woocommerce' ),
2016-08-27 01:46:45 +00:00
'text' => __ ( 'Text' , 'woocommerce' ),
2015-04-27 15:31:34 +00:00
) );
}
2015-04-27 16:06:28 +00:00
/**
2015-11-03 13:31:20 +00:00
* Check if attribute name is reserved .
2016-05-27 01:48:49 +00:00
* https :// codex . wordpress . org / Function_Reference / register_taxonomy #Reserved_Terms.
2015-04-27 16:06:28 +00:00
*
* @ since 2.4 . 0
* @ param string $attribute_name
* @ return bool
*/
function wc_check_if_attribute_name_is_reserved ( $attribute_name ) {
// Forbidden attribute names
$reserved_terms = array (
2016-08-27 03:04:10 +00:00
'attachment' ,
'attachment_id' ,
'author' ,
'author_name' ,
'calendar' ,
'cat' ,
'category' ,
'category__and' ,
'category__in' ,
'category__not_in' ,
'category_name' ,
'comments_per_page' ,
'comments_popup' ,
'cpage' ,
'day' ,
'debug' ,
'error' ,
'exact' ,
'feed' ,
'hour' ,
'link_category' ,
'm' ,
'minute' ,
'monthnum' ,
'more' ,
'name' ,
'nav_menu' ,
'nopaging' ,
'offset' ,
'order' ,
'orderby' ,
'p' ,
'page' ,
'page_id' ,
'paged' ,
'pagename' ,
'pb' ,
'perm' ,
'post' ,
'post__in' ,
'post__not_in' ,
'post_format' ,
'post_mime_type' ,
'post_status' ,
'post_tag' ,
'post_type' ,
'posts' ,
'posts_per_archive_page' ,
'posts_per_page' ,
'preview' ,
'robots' ,
's' ,
'search' ,
'second' ,
'sentence' ,
'showposts' ,
'static' ,
'subpost' ,
'subpost_id' ,
'tag' ,
'tag__and' ,
'tag__in' ,
'tag__not_in' ,
'tag_id' ,
'tag_slug__and' ,
'tag_slug__in' ,
'taxonomy' ,
'tb' ,
'term' ,
'type' ,
'w' ,
'withcomments' ,
'withoutcomments' ,
'year' ,
2015-04-27 16:06:28 +00:00
);
return in_array ( $attribute_name , $reserved_terms );
}