/woocommerce-template.php
PHP | 1500 lines | 742 code | 277 blank | 481 comment | 178 complexity | 22aba0ed7c3f996d7232f62fd3366c62 MD5 | raw file
Possible License(s): GPL-3.0
- <?php
- /**
- * WooCommerce Template Functions
- *
- * Functions used in the template files to output content - in most cases hooked in via the template actions. All functions are pluggable.
- *
- * @author WooThemes
- * @category Core
- * @package WooCommerce/Templates
- * @version 1.6.4
- */
- if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
- /** Template pages ********************************************************/
- if ( ! function_exists( 'woocommerce_content' ) ) {
- /**
- * Output WooCommerce content.
- *
- * This function is only used in the optional 'woocommerce.php' template
- * which people can add to their themes to add basic woocommerce support
- * without hooks or modifying core templates.
- *
- * @access public
- * @return void
- */
- function woocommerce_content() {
- if ( is_singular( 'product' ) ) {
- while ( have_posts() ) : the_post();
- woocommerce_get_template_part( 'content', 'single-product' );
- endwhile;
- } else {
- ?><h1 class="page-title"><?php woocommerce_page_title(); ?></h1>
- <?php do_action( 'woocommerce_archive_description' ); ?>
- <?php if ( have_posts() ) : ?>
- <?php do_action('woocommerce_before_shop_loop'); ?>
- <?php woocommerce_product_loop_start(); ?>
- <?php woocommerce_product_subcategories(); ?>
- <?php while ( have_posts() ) : the_post(); ?>
- <?php woocommerce_get_template_part( 'content', 'product' ); ?>
- <?php endwhile; // end of the loop. ?>
- <?php woocommerce_product_loop_end(); ?>
- <?php do_action('woocommerce_after_shop_loop'); ?>
- <?php elseif ( ! woocommerce_product_subcategories( array( 'before' => woocommerce_product_loop_start( false ), 'after' => woocommerce_product_loop_end( false ) ) ) ) : ?>
- <?php woocommerce_get_template( 'loop/no-products-found.php' ); ?>
- <?php endif;
- }
- }
- }
- if ( ! function_exists( 'woocommerce_single_product_content' ) ) {
- /**
- * woocommerce_single_product_content function.
- *
- * @access public
- * @return void
- * @deprecated 1.6
- */
- function woocommerce_single_product_content() {
- _deprecated_function( __FUNCTION__, '1.6' );
- woocommerce_content();
- }
- }
- if ( ! function_exists( 'woocommerce_archive_product_content' ) ) {
- /**
- * woocommerce_archive_product_content function.
- *
- * @access public
- * @return void
- * @deprecated 1.6
- */
- function woocommerce_archive_product_content() {
- _deprecated_function( __FUNCTION__, '1.6' );
- woocommerce_content();
- }
- }
- if ( ! function_exists( 'woocommerce_product_taxonomy_content' ) ) {
- /**
- * woocommerce_product_taxonomy_content function.
- *
- * @access public
- * @return void
- * @deprecated 1.6
- */
- function woocommerce_product_taxonomy_content() {
- _deprecated_function( __FUNCTION__, '1.6' );
- woocommerce_content();
- }
- }
- /** Global ****************************************************************/
- if ( ! function_exists( 'woocommerce_output_content_wrapper' ) ) {
- /**
- * Output the start of the page wrapper.
- *
- * @access public
- * @return void
- */
- function woocommerce_output_content_wrapper() {
- woocommerce_get_template( 'shop/wrapper-start.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_output_content_wrapper_end' ) ) {
- /**
- * Output the end of the page wrapper.
- *
- * @access public
- * @return void
- */
- function woocommerce_output_content_wrapper_end() {
- woocommerce_get_template( 'shop/wrapper-end.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_show_messages' ) ) {
- /**
- * Show messages on the frontend.
- *
- * @access public
- * @return void
- */
- function woocommerce_show_messages() {
- global $woocommerce;
- if ( $woocommerce->error_count() > 0 )
- woocommerce_get_template( 'shop/errors.php', array(
- 'errors' => $woocommerce->get_errors()
- ) );
- if ( $woocommerce->message_count() > 0 )
- woocommerce_get_template( 'shop/messages.php', array(
- 'messages' => $woocommerce->get_messages()
- ) );
- $woocommerce->clear_messages();
- }
- }
- if ( ! function_exists( 'woocommerce_get_sidebar' ) ) {
- /**
- * Get the shop sidebar template.
- *
- * @access public
- * @return void
- */
- function woocommerce_get_sidebar() {
- woocommerce_get_template( 'shop/sidebar.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_demo_store' ) ) {
- /**
- * Adds a demo store banner to the site if enabled
- *
- * @access public
- * @return void
- */
- function woocommerce_demo_store() {
- if ( get_option( 'woocommerce_demo_store' ) == 'no' )
- return;
- $notice = get_option( 'woocommerce_demo_store_notice' );
- if ( empty( $notice ) )
- $notice = __( 'This is a demo store for testing purposes — no orders shall be fulfilled.', 'woocommerce' );
- echo apply_filters( 'woocommerce_demo_store', '<p class="demo_store">' . $notice . '</p>' );
- }
- }
- /** Loop ******************************************************************/
- if ( ! function_exists( 'woocommerce_page_title' ) ) {
- /**
- * woocommerce_page_title function.
- *
- * @access public
- * @return void
- */
- function woocommerce_page_title() {
- if ( is_search() ) {
- $page_title = sprintf( __( 'Search Results: “%s”', 'woocommerce' ), get_search_query() );
- if ( get_query_var( 'paged' ) )
- $page_title .= sprintf( __( ' – Page %s', 'woocommerce' ), get_query_var( 'paged' ) );
- } elseif ( is_tax() ) {
- $page_title = single_term_title( "", false );
- } else {
- $shop_page_id = woocommerce_get_page_id( 'shop' );
- $page_title = apply_filters( 'the_title', ( $shop_page_title = get_option( 'woocommerce_shop_page_title' ) ) ? $shop_page_title : get_the_title( $shop_page_id ), $shop_page_id );
- }
- echo apply_filters( 'woocommerce_page_title', $page_title );
- }
- }
- if ( ! function_exists( 'woocommerce_product_loop_start' ) ) {
- /**
- * Output the start of a product loop. By default this is a UL
- *
- * @access public
- * @return void
- */
- function woocommerce_product_loop_start( $echo = true ) {
- ob_start();
- woocommerce_get_template( 'loop/loop-start.php' );
- if ( $echo )
- echo ob_get_clean();
- else
- return ob_get_clean();
- }
- }
- if ( ! function_exists( 'woocommerce_product_loop_end' ) ) {
- /**
- * Output the end of a product loop. By default this is a UL
- *
- * @access public
- * @return void
- */
- function woocommerce_product_loop_end( $echo = true ) {
- ob_start();
- woocommerce_get_template( 'loop/loop-end.php' );
- if ( $echo )
- echo ob_get_clean();
- else
- return ob_get_clean();
- }
- }
- if ( ! function_exists( 'woocommerce_taxonomy_archive_description' ) ) {
- /**
- * Show an archive description on taxonomy archives
- *
- * @access public
- * @subpackage Archives
- * @return void
- */
- function woocommerce_taxonomy_archive_description() {
- if ( is_tax( array( 'product_cat', 'product_tag' ) ) && get_query_var( 'paged' ) == 0 ) {
- $description = term_description();
- if ( $description ) {
- echo '<div class="term-description">' . wpautop( wptexturize( $description ) ) . '</div>';
- }
- }
- }
- }
- if ( ! function_exists( 'woocommerce_product_archive_description' ) ) {
- /**
- * Show a shop page description on product archives
- *
- * @access public
- * @subpackage Archives
- * @return void
- */
- function woocommerce_product_archive_description() {
- if ( is_post_type_archive( 'product' ) && get_query_var( 'paged' ) == 0 ) {
- $shop_page = get_post( woocommerce_get_page_id( 'shop' ) );
- $description = apply_filters( 'the_content', $shop_page->post_content );
- if ( $description ) {
- echo '<div class="page-description">' . $description . '</div>';
- }
- }
- }
- }
- if ( ! function_exists( 'woocommerce_template_loop_add_to_cart' ) ) {
- /**
- * Get the add to cart template for the loop.
- *
- * @access public
- * @subpackage Loop
- * @return void
- */
- function woocommerce_template_loop_add_to_cart() {
- woocommerce_get_template( 'loop/add-to-cart.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_template_loop_product_thumbnail' ) ) {
- /**
- * Get the product thumbnail for the loop.
- *
- * @access public
- * @subpackage Loop
- * @return void
- */
- function woocommerce_template_loop_product_thumbnail() {
- echo woocommerce_get_product_thumbnail();
- }
- }
- if ( ! function_exists( 'woocommerce_template_loop_price' ) ) {
- /**
- * Get the product price for the loop.
- *
- * @access public
- * @subpackage Loop
- * @return void
- */
- function woocommerce_template_loop_price() {
- woocommerce_get_template( 'loop/price.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_template_loop_rating' ) ) {
- /**
- * Display the average rating in the loop
- *
- * @access public
- * @subpackage Loop
- * @return void
- */
- function woocommerce_template_loop_rating() {
- woocommerce_get_template( 'loop/rating.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_show_product_loop_sale_flash' ) ) {
- /**
- * Get the sale flash for the loop.
- *
- * @access public
- * @subpackage Loop
- * @return void
- */
- function woocommerce_show_product_loop_sale_flash() {
- woocommerce_get_template( 'loop/sale-flash.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_reset_loop' ) ) {
- /**
- * Reset the loop's index and columns when we're done outputting a product loop.
- *
- * @access public
- * @subpackage Loop
- * @return void
- */
- function woocommerce_reset_loop() {
- global $woocommerce_loop;
- // Reset loop/columns globals when starting a new loop
- $woocommerce_loop['loop'] = $woocommerce_loop['column'] = '';
- }
- }
- add_filter( 'loop_end', 'woocommerce_reset_loop' );
- if ( ! function_exists( 'woocommerce_get_product_thumbnail' ) ) {
- /**
- * Get the product thumbnail, or the placeholder if not set.
- *
- * @access public
- * @subpackage Loop
- * @param string $size (default: 'shop_catalog')
- * @param int $placeholder_width (default: 0)
- * @param int $placeholder_height (default: 0)
- * @return string
- */
- function woocommerce_get_product_thumbnail( $size = 'shop_catalog', $placeholder_width = 0, $placeholder_height = 0 ) {
- global $post;
- if ( has_post_thumbnail() )
- return get_the_post_thumbnail( $post->ID, $size );
- elseif ( woocommerce_placeholder_img_src() )
- return woocommerce_placeholder_img( $size );
- }
- }
- if ( ! function_exists( 'woocommerce_result_count' ) ) {
- /**
- * Output the result count text (Showing x - x of x results).
- *
- * @access public
- * @subpackage Loop
- * @return void
- */
- function woocommerce_result_count() {
- woocommerce_get_template( 'loop/result-count.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_catalog_ordering' ) ) {
- /**
- * Output the product sorting options.
- *
- * @access public
- * @subpackage Loop
- * @return void
- */
- function woocommerce_catalog_ordering() {
- global $woocommerce;
- $orderby = isset( $_GET['orderby'] ) ? woocommerce_clean( $_GET['orderby'] ) : apply_filters( 'woocommerce_default_catalog_orderby', get_option( 'woocommerce_default_catalog_orderby' ) );
- woocommerce_get_template( 'loop/orderby.php', array( 'orderby' => $orderby ) );
- }
- }
- if ( ! function_exists( 'woocommerce_pagination' ) ) {
- /**
- * Output the pagination.
- *
- * @access public
- * @subpackage Loop
- * @return void
- */
- function woocommerce_pagination() {
- woocommerce_get_template( 'loop/pagination.php' );
- }
- }
- /** Single Product ********************************************************/
- if ( ! function_exists( 'woocommerce_show_product_images' ) ) {
- /**
- * Output the product image before the single product summary.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_show_product_images() {
- woocommerce_get_template( 'single-product/product-image.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_show_product_thumbnails' ) ) {
- /**
- * Output the product thumbnails.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_show_product_thumbnails() {
- woocommerce_get_template( 'single-product/product-thumbnails.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_output_product_data_tabs' ) ) {
- /**
- * Output the product tabs.
- *
- * @access public
- * @subpackage Product/Tabs
- * @return void
- */
- function woocommerce_output_product_data_tabs() {
- woocommerce_get_template( 'single-product/tabs/tabs.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_template_single_title' ) ) {
- /**
- * Output the product title.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_template_single_title() {
- woocommerce_get_template( 'single-product/title.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_template_single_price' ) ) {
- /**
- * Output the product price.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_template_single_price() {
- woocommerce_get_template( 'single-product/price.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_template_single_excerpt' ) ) {
- /**
- * Output the product short description (excerpt).
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_template_single_excerpt() {
- woocommerce_get_template( 'single-product/short-description.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_template_single_meta' ) ) {
- /**
- * Output the product meta.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_template_single_meta() {
- woocommerce_get_template( 'single-product/meta.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_template_single_sharing' ) ) {
- /**
- * Output the product sharing.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_template_single_sharing() {
- woocommerce_get_template( 'single-product/share.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_show_product_sale_flash' ) ) {
- /**
- * Output the product sale flash.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_show_product_sale_flash() {
- woocommerce_get_template( 'single-product/sale-flash.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_template_single_add_to_cart' ) ) {
- /**
- * Trigger the single product add to cart action.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_template_single_add_to_cart() {
- global $product;
- do_action( 'woocommerce_' . $product->product_type . '_add_to_cart' );
- }
- }
- if ( ! function_exists( 'woocommerce_simple_add_to_cart' ) ) {
- /**
- * Output the simple product add to cart area.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_simple_add_to_cart() {
- woocommerce_get_template( 'single-product/add-to-cart/simple.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_grouped_add_to_cart' ) ) {
- /**
- * Output the grouped product add to cart area.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_grouped_add_to_cart() {
- woocommerce_get_template( 'single-product/add-to-cart/grouped.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_variable_add_to_cart' ) ) {
- /**
- * Output the variable product add to cart area.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_variable_add_to_cart() {
- global $product;
- // Enqueue variation scripts
- wp_enqueue_script( 'wc-add-to-cart-variation' );
- // Load the template
- woocommerce_get_template( 'single-product/add-to-cart/variable.php', array(
- 'available_variations' => $product->get_available_variations(),
- 'attributes' => $product->get_variation_attributes(),
- 'selected_attributes' => $product->get_variation_default_attributes()
- ) );
- }
- }
- if ( ! function_exists( 'woocommerce_external_add_to_cart' ) ) {
- /**
- * Output the external product add to cart area.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_external_add_to_cart() {
- global $product;
- if ( ! $product->get_product_url() )
- return;
- woocommerce_get_template( 'single-product/add-to-cart/external.php', array(
- 'product_url' => $product->get_product_url(),
- 'button_text' => $product->get_button_text()
- ) );
- }
- }
- if ( ! function_exists( 'woocommerce_quantity_input' ) ) {
- /**
- * Output the quantity input for add to cart forms.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_quantity_input( $args = array() ) {
- global $product;
- $defaults = array(
- 'input_name' => 'quantity',
- 'input_value' => '1',
- 'max_value' => apply_filters( 'woocommerce_quantity_input_max', '', $product ),
- 'min_value' => apply_filters( 'woocommerce_quantity_input_min', '', $product ),
- 'step' => apply_filters( 'woocommerce_quantity_input_step', '1', $product )
- );
- $args = apply_filters( 'woocommerce_quantity_input_args', wp_parse_args( $args, $defaults ), $product );
- woocommerce_get_template( 'single-product/add-to-cart/quantity.php', $args );
- }
- }
- if ( ! function_exists( 'woocommerce_product_description_tab' ) ) {
- /**
- * Output the description tab content.
- *
- * @access public
- * @subpackage Product/Tabs
- * @return void
- */
- function woocommerce_product_description_tab() {
- woocommerce_get_template( 'single-product/tabs/description.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_product_additional_information_tab' ) ) {
- /**
- * Output the attributes tab content.
- *
- * @access public
- * @subpackage Product/Tabs
- * @return void
- */
- function woocommerce_product_additional_information_tab() {
- woocommerce_get_template( 'single-product/tabs/additional-information.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_product_reviews_tab' ) ) {
- /**
- * Output the reviews tab content.
- *
- * @access public
- * @subpackage Product/Tabs
- * @return void
- */
- function woocommerce_product_reviews_tab() {
- woocommerce_get_template( 'single-product/tabs/reviews.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_default_product_tabs' ) ) {
- /**
- * Add default product tabs to product pages.
- *
- * @access public
- * @param mixed $tabs
- * @return void
- */
- function woocommerce_default_product_tabs( $tabs = array() ) {
- global $product, $post;
- // Description tab - shows product content
- if ( $post->post_content )
- $tabs['description'] = array(
- 'title' => __( 'Description', 'woocommerce' ),
- 'priority' => 10,
- 'callback' => 'woocommerce_product_description_tab'
- );
- // Additonal information tab - shows attributes
- if ( $product->has_attributes() || ( get_option( 'woocommerce_enable_dimension_product_attributes' ) == 'yes' && ( $product->has_dimensions() || $product->has_weight() ) ) )
- $tabs['additional_information'] = array(
- 'title' => __( 'Additional Information', 'woocommerce' ),
- 'priority' => 20,
- 'callback' => 'woocommerce_product_additional_information_tab'
- );
- // Reviews tab - shows comments
- if ( comments_open() )
- $tabs['reviews'] = array(
- 'title' => sprintf( __( 'Reviews (%d)', 'woocommerce' ), get_comments_number( $post->ID ) ),
- 'priority' => 30,
- 'callback' => 'comments_template'
- );
- return $tabs;
- }
- }
- if ( ! function_exists( 'woocommerce_sort_product_tabs' ) ) {
- /**
- * Sort tabs by priority
- *
- * @access public
- * @return void
- */
- function woocommerce_sort_product_tabs( $tabs = array() ) {
- // Re-order tabs by priority
- if ( ! function_exists( '_sort_priority_callback' ) ) {
- function _sort_priority_callback( $a, $b ) {
- if ( $a['priority'] == $b['priority'] )
- return 0;
- return ( $a['priority'] < $b['priority'] ) ? -1 : 1;
- }
- }
- uasort( $tabs, '_sort_priority_callback' );
- return $tabs;
- }
- }
- if ( ! function_exists( 'woocommerce_comments' ) ) {
- /**
- * Output the Review comments template.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_comments( $comment, $args, $depth ) {
- $GLOBALS['comment'] = $comment;
- woocommerce_get_template( 'single-product/review.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_output_related_products' ) ) {
- /**
- * Output the related products.
- *
- * @access public
- * @subpackage Product
- * @return void
- */
- function woocommerce_output_related_products() {
- woocommerce_related_products( 2, 2 );
- }
- }
- if ( ! function_exists( 'woocommerce_related_products' ) ) {
- /**
- * Output the related products.
- *
- * @access public
- * @param int $posts_per_page (default: 2)
- * @param int $columns (default: 2)
- * @param string $orderby (default: 'rand')
- * @return void
- */
- function woocommerce_related_products( $posts_per_page = 2, $columns = 2, $orderby = 'rand' ) {
- woocommerce_get_template( 'single-product/related.php', array(
- 'posts_per_page' => $posts_per_page,
- 'orderby' => $orderby,
- 'columns' => $columns
- ) );
- }
- }
- if ( ! function_exists( 'woocommerce_upsell_display' ) ) {
- /**
- * Output product up sells.
- *
- * @access public
- * @param int $posts_per_page (default: -1)
- * @param int $columns (default: 2)
- * @param string $orderby (default: 'rand')
- * @return void
- */
- function woocommerce_upsell_display( $posts_per_page = '-1', $columns = 2, $orderby = 'rand' ) {
- woocommerce_get_template( 'single-product/up-sells.php', array(
- 'posts_per_page' => $posts_per_page,
- 'orderby' => $orderby,
- 'columns' => $columns
- ) );
- }
- }
- /** Cart ******************************************************************/
- if ( ! function_exists( 'woocommerce_shipping_calculator' ) ) {
- /**
- * Output the cart shipping calculator.
- *
- * @access public
- * @subpackage Cart
- * @return void
- */
- function woocommerce_shipping_calculator() {
- woocommerce_get_template( 'cart/shipping-calculator.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_cart_totals' ) ) {
- /**
- * Output the cart totals.
- *
- * @access public
- * @subpackage Cart
- * @return void
- */
- function woocommerce_cart_totals() {
- woocommerce_get_template( 'cart/totals.php' );
- }
- }
- if ( ! function_exists( 'woocommerce_cross_sell_display' ) ) {
- /**
- * Output the cart cross-sells.
- *
- * @access public
- * @subpackage Cart
- * @return void
- */
- function woocommerce_cross_sell_display() {
- woocommerce_get_template( 'cart/cross-sells.php' );
- }
- }
- /** Mini-Cart *************************************************************/
- if ( ! function_exists( 'woocommerce_mini_cart' ) ) {
- /**
- * Output the Mini-cart - used by cart widget
- *
- * @access public
- * @return void
- */
- function woocommerce_mini_cart( $args = array() ) {
- $defaults = array(
- 'list_class' => ''
- );
- $args = wp_parse_args( $args, $defaults );
- woocommerce_get_template( 'cart/mini-cart.php', $args );
- }
- }
- /** Login *****************************************************************/
- if ( ! function_exists( 'woocommerce_login_form' ) ) {
- /**
- * Output the WooCommerce Login Form
- *
- * @access public
- * @subpackage Forms
- * @return void
- */
- function woocommerce_login_form( $args = array() ) {
- $defaults = array(
- 'message' => '',
- 'redirect' => ''
- );
- $args = wp_parse_args( $args, $defaults );
- woocommerce_get_template( 'shop/form-login.php', $args );
- }
- }
- if ( ! function_exists( 'woocommerce_checkout_login_form' ) ) {
- /**
- * Output the WooCommerce Checkout Login Form
- *
- * @access public
- * @subpackage Checkout
- * @return void
- */
- function woocommerce_checkout_login_form() {
- global $woocommerce;
- woocommerce_get_template( 'checkout/form-login.php', array( 'checkout' => $woocommerce->checkout() ) );
- }
- }
- if ( ! function_exists( 'woocommerce_breadcrumb' ) ) {
- /**
- * Output the WooCommerce Breadcrumb
- *
- * @access public
- * @return void
- */
- function woocommerce_breadcrumb( $args = array() ) {
- $defaults = apply_filters( 'woocommerce_breadcrumb_defaults', array(
- 'delimiter' => ' / ',
- 'wrap_before' => '<nav class="woocommerce-breadcrumb" itemprop="breadcrumb">',
- 'wrap_after' => '</nav>',
- 'before' => '',
- 'after' => '',
- 'home' => _x( 'Home', 'breadcrumb', 'woocommerce' ),
- ) );
- $args = wp_parse_args( $args, $defaults );
- woocommerce_get_template( 'shop/breadcrumb.php', $args );
- }
- }
- if ( ! function_exists( 'woocommerce_order_review' ) ) {
- /**
- * Output the Order review table for the checkout.
- *
- * @access public
- * @subpackage Checkout
- * @return void
- */
- function woocommerce_order_review() {
- global $woocommerce;
- woocommerce_get_template( 'checkout/review-order.php', array( 'checkout' => $woocommerce->checkout() ) );
- }
- }
- if ( ! function_exists( 'woocommerce_checkout_coupon_form' ) ) {
- /**
- * Output the Coupon form for the checkout.
- *
- * @access public
- * @subpackage Checkout
- * @return void
- */
- function woocommerce_checkout_coupon_form() {
- global $woocommerce;
- woocommerce_get_template( 'checkout/form-coupon.php', array( 'checkout' => $woocommerce->checkout() ) );
- }
- }
- if ( ! function_exists( 'woocommerce_products_will_display' ) ) {
- /**
- * Check if we will be showing products or not (and not subcats only)
- *
- * @access public
- * @subpackage Loop
- * @return void
- */
- function woocommerce_products_will_display() {
- global $woocommerce, $wpdb;
- if ( ! is_product_category() && ! is_shop() )
- return false;
- if ( is_search() || is_filtered() || is_paged() )
- return true;
- if ( is_shop() && get_option( 'woocommerce_shop_page_display' ) != 'subcategories' )
- return true;
- $term = get_queried_object();
- if ( is_product_category() ) {
- switch ( get_woocommerce_term_meta( $term->term_id, 'display_type', true ) ) {
- case 'products' :
- case 'both' :
- return true;
- break;
- case '' :
- if ( get_option( 'woocommerce_category_archive_display' ) != 'subcategories' )
- return true;
- break;
- }
- }
- $parent_id = empty( $term->term_id ) ? 0 : $term->term_id;
- $has_children = $wpdb->get_col( $wpdb->prepare( "SELECT term_id FROM {$wpdb->term_taxonomy} WHERE parent = %d", $parent_id ) );
- if ( $has_children ) {
- // Check terms have products inside
- $children = array();
- foreach ( $has_children as $term ) {
- $children = array_merge( $children, get_term_children( $term, 'product_cat' ) );
- $children[] = $term;
- }
- $objects = get_objects_in_term( $children, 'product_cat' );
- if ( sizeof( $objects ) > 0 ) {
- return false;
- } else {
- return true;
- }
- } else {
- return true;
- }
- }
- }
- if ( ! function_exists( 'woocommerce_product_subcategories' ) ) {
- /**
- * Display product sub categories as thumbnails.
- *
- * @access public
- * @subpackage Loop
- * @return void
- */
- function woocommerce_product_subcategories( $args = array() ) {
- global $woocommerce, $wp_query;
- $defaults = array(
- 'before' => '',
- 'after' => '',
- 'force_display' => false
- );
- $args = wp_parse_args( $args, $defaults );
- extract( $args );
- // Main query only
- if ( ! is_main_query() && ! $force_display ) return;
- // Don't show when filtering, searching or when on page > 1 and ensure we're on a product archive
- if ( is_search() || is_filtered() || is_paged() || ( ! is_product_category() && ! is_shop() ) ) return;
- // Check categories are enabled
- if ( is_shop() && get_option( 'woocommerce_shop_page_display' ) == '' ) return;
- // Find the category + category parent, if applicable
- $term = get_queried_object();
- $parent_id = empty( $term->term_id ) ? 0 : $term->term_id;
- if ( is_product_category() ) {
- $display_type = get_woocommerce_term_meta( $term->term_id, 'display_type', true );
- switch ( $display_type ) {
- case 'products' :
- return;
- break;
- case '' :
- if ( get_option( 'woocommerce_category_archive_display' ) == '' )
- return;
- break;
- }
- }
- // NOTE: using child_of instead of parent - this is not ideal but due to a WP bug ( http://core.trac.wordpress.org/ticket/15626 ) pad_counts won't work
- $args = array(
- 'child_of' => $parent_id,
- 'menu_order' => 'ASC',
- 'hide_empty' => 1,
- 'hierarchical' => 1,
- 'taxonomy' => 'product_cat',
- 'pad_counts' => 1
- );
- $product_categories = get_categories( apply_filters( 'woocommerce_product_subcategories_args', $args ) );
- $product_category_found = false;
- if ( $product_categories ) {
- foreach ( $product_categories as $category ) {
- if ( $category->parent != $parent_id )
- continue;
- if ( ! $product_category_found ) {
- // We found a category
- $product_category_found = true;
- echo $before;
- }
- woocommerce_get_template( 'content-product_cat.php', array(
- 'category' => $category
- ) );
- }
- }
- // If we are hiding products disable the loop and pagination
- if ( $product_category_found ) {
- if ( is_product_category() ) {
- $display_type = get_woocommerce_term_meta( $term->term_id, 'display_type', true );
- switch ( $display_type ) {
- case 'subcategories' :
- $wp_query->post_count = 0;
- $wp_query->max_num_pages = 0;
- break;
- case '' :
- if ( get_option( 'woocommerce_category_archive_display' ) == 'subcategories' ) {
- $wp_query->post_count = 0;
- $wp_query->max_num_pages = 0;
- }
- break;
- }
- }
- if ( is_shop() && get_option( 'woocommerce_shop_page_display' ) == 'subcategories' ) {
- $wp_query->post_count = 0;
- $wp_query->max_num_pages = 0;
- }
- echo $after;
- return true;
- }
- }
- }
- if ( ! function_exists( 'woocommerce_subcategory_thumbnail' ) ) {
- /**
- * Show subcategory thumbnails.
- *
- * @access public
- * @param mixed $category
- * @subpackage Loop
- * @return void
- */
- function woocommerce_subcategory_thumbnail( $category ) {
- global $woocommerce;
- $small_thumbnail_size = apply_filters( 'single_product_small_thumbnail_size', 'shop_catalog' );
- $dimensions = $woocommerce->get_image_size( $small_thumbnail_size );
- $thumbnail_id = get_woocommerce_term_meta( $category->term_id, 'thumbnail_id', true );
- if ( $thumbnail_id ) {
- $image = wp_get_attachment_image_src( $thumbnail_id, $small_thumbnail_size );
- $image = $image[0];
- } else {
- $image = woocommerce_placeholder_img_src();
- }
- if ( $image )
- echo '<img src="' . $image . '" alt="' . $category->name . '" width="' . $dimensions['width'] . '" height="' . $dimensions['height'] . '" />';
- }
- }
- if ( ! function_exists( 'woocommerce_order_details_table' ) ) {
- /**
- * Displays order details in a table.
- *
- * @access public
- * @param mixed $order_id
- * @subpackage Orders
- * @return void
- */
- function woocommerce_order_details_table( $order_id ) {
- if ( ! $order_id ) return;
- woocommerce_get_template( 'order/order-details.php', array(
- 'order_id' => $order_id
- ) );
- }
- }
- /** Forms ****************************************************************/
- if ( ! function_exists( 'woocommerce_form_field' ) ) {
- /**
- * Outputs a checkout/address form field.
- *
- * @access public
- * @subpackage Forms
- * @param mixed $key
- * @param mixed $args
- * @param string $value (default: '')
- * @return void
- */
- function woocommerce_form_field( $key, $args, $value = '' ) {
- global $woocommerce;
- $defaults = array(
- 'type' => 'text',
- 'label' => '',
- 'placeholder' => '',
- 'maxlength' => false,
- 'required' => false,
- 'class' => array(),
- 'label_class' => array(),
- 'return' => false,
- 'options' => array(),
- 'custom_attributes' => array(),
- 'validate' => array()
- );
- $args = wp_parse_args( $args, $defaults );
- if ( ( ! empty( $args['clear'] ) ) ) $after = '<div class="clear"></div>'; else $after = '';
- if ( $args['required'] ) {
- $args['class'][] = 'validate-required';
- $required = ' <abbr class="required" title="' . esc_attr__( 'required', 'woocommerce' ) . '">*</abbr>';
- } else {
- $required = '';
- }
- $args['maxlength'] = ( $args['maxlength'] ) ? 'maxlength="' . absint( $args['maxlength'] ) . '"' : '';
- // Custom attribute handling
- $custom_attributes = array();
- if ( ! empty( $args['custom_attributes'] ) && is_array( $args['custom_attributes'] ) )
- foreach ( $args['custom_attributes'] as $attribute => $value )
- $custom_attributes[] = esc_attr( $attribute ) . '="' . esc_attr( $value ) . '"';
- if ( ! empty( $args['validate'] ) )
- foreach( $args['validate'] as $validate )
- $args['class'][] = 'validate-' . $validate;
- switch ( $args['type'] ) {
- case "country" :
- if ( sizeof( $woocommerce->countries->get_allowed_countries() ) == 1 ) {
- $field = '<p class="form-row ' . esc_attr( implode( ' ', $args['class'] ) ) .'" id="' . esc_attr( $key ) . '_field">';
- if ( $args['label'] )
- $field .= '<label class="' . implode( ' ', $args['label_class'] ) .'">' . $args['label'] . '</label>';
- $field .= '<strong>' . current( array_values( $woocommerce->countries->get_allowed_countries() ) ) . '</strong>';
- $field .= '<input type="hidden" name="' . esc_attr( $key ) . '" id="' . esc_attr( $key ) . '" value="' . current( array_keys( $woocommerce->countries->get_allowed_countries() ) ) . '" ' . implode( ' ', $custom_attributes ) . ' />';
- $field .= '</p>' . $after;
- } else {
- $field = '<p class="form-row ' . esc_attr( implode( ' ', $args['class'] ) ) .'" id="' . esc_attr( $key ) . '_field">
- <label for="' . esc_attr( $key ) . '" class="' . implode( ' ', $args['label_class'] ) .'">' . $args['label']. $required . '</label>
- <select name="' . esc_attr( $key ) . '" id="' . esc_attr( $key ) . '" class="country_to_state country_select" ' . implode( ' ', $custom_attributes ) . '>
- <option value="">'.__( 'Select a country…', 'woocommerce' ) .'</option>';
- foreach ( $woocommerce->countries->get_allowed_countries() as $ckey => $cvalue )
- $field .= '<option value="' . $ckey . '" '.selected( $value, $ckey, false ) .'>'.__( $cvalue, 'woocommerce' ) .'</option>';
- $field .= '</select>';
- $field .= '<noscript><input type="submit" name="woocommerce_checkout_update_totals" value="' . __( 'Update country', 'woocommerce' ) . '" /></noscript>';
- $field .= '</p>' . $after;
- }
- break;
- case "state" :
- /* Get Country */
- $country_key = $key == 'billing_state'? 'billing_country' : 'shipping_country';
- if ( isset( $_POST[ $country_key ] ) ) {
- $current_cc = woocommerce_clean( $_POST[ $country_key ] );
- } elseif ( is_user_logged_in() ) {
- $current_cc = get_user_meta( get_current_user_id() , $country_key, true );
- if ( ! $current_cc) {
- $current_cc = apply_filters('default_checkout_country', ($woocommerce->customer->get_country()) ? $woocommerce->customer->get_country() : $woocommerce->countries->get_base_country());
- }
- } elseif ( $country_key == 'billing_country' ) {
- $current_cc = apply_filters('default_checkout_country', ($woocommerce->customer->get_country()) ? $woocommerce->customer->get_country() : $woocommerce->countries->get_base_country());
- } else {
- $current_cc = apply_filters('default_checkout_country', ($woocommerce->customer->get_shipping_country()) ? $woocommerce->customer->get_shipping_country() : $woocommerce->countries->get_base_country());
- }
- $states = $woocommerce->countries->get_states( $current_cc );
- if ( is_array( $states ) && empty( $states ) ) {
- $field = '<p class="form-row ' . esc_attr( implode( ' ', $args['class'] ) ) .'" id="' . esc_attr( $key ) . '_field" style="display: none">';
- if ( $args['label'] )
- $field .= '<label for="' . esc_attr( $key ) . '" class="' . implode( ' ', $args['label_class'] ) .'">' . $args['label'] . $required . '</label>';
- $field .= '<input type="hidden" class="hidden" name="' . esc_attr( $key ) . '" id="' . esc_attr( $key ) . '" value="" ' . implode( ' ', $custom_attributes ) . ' placeholder="' . $args['placeholder'] . '" />';
- $field .= '</p>' . $after;
- } elseif ( is_array( $states ) ) {
- $field = '<p class="form-row ' . esc_attr( implode( ' ', $args['class'] ) ) .'" id="' . esc_attr( $key ) . '_field">';
- if ( $args['label'] )
- $field .= '<label for="' . esc_attr( $key ) . '" class="' . implode( ' ', $args['label_class'] ) .'">' . $args['label']. $required . '</label>';
- $field .= '<select name="' . esc_attr( $key ) . '" id="' . esc_attr( $key ) . '" class="state_select" ' . implode( ' ', $custom_attributes ) . ' placeholder="' . $args['placeholder'] . '">
- <option value="">'.__( 'Select a state…', 'woocommerce' ) .'</option>';
- foreach ( $states as $ckey => $cvalue )
- $field .= '<option value="' . $ckey . '" '.selected( $value, $ckey, false ) .'>'.__( $cvalue, 'woocommerce' ) .'</option>';
- $field .= '</select>';
- $field .= '</p>' . $after;
- } else {
- $field = '<p class="form-row ' . esc_attr( implode( ' ', $args['class'] ) ) .'" id="' . esc_attr( $key ) . '_field">';
- if ( $args['label'] )
- $field .= '<label for="' . esc_attr( $key ) . '" class="' . implode( ' ', $args['label_class'] ) .'">' . $args['label']. $required . '</label>';
- $field .= '<input type="text" class="input-text" value="' . $value . '" placeholder="' . $args['placeholder'] . '" name="' . esc_attr( $key ) . '" id="' . esc_attr( $key ) . '" ' . implode( ' ', $custom_attributes ) . ' />';
- $field .= '</p>' . $after;
- }
- break;
- case "textarea" :
- $field = '<p class="form-row ' . esc_attr( implode( ' ', $args['class'] ) ) .'" id="' . esc_attr( $key ) . '_field">';
- if ( $args['label'] )
- $field .= '<label for="' . esc_attr( $key ) . '" class="' . implode( ' ', $args['label_class'] ) .'">' . $args['label']. $required . '</label>';
- $field .= '<textarea name="' . esc_attr( $key ) . '" class="input-text" id="' . esc_attr( $key ) . '" placeholder="' . $args['placeholder'] . '" cols="5" rows="2" ' . implode( ' ', $custom_attributes ) . '>'. esc_textarea( $value ) .'</textarea>
- </p>' . $after;
- break;
- case "checkbox" :
- $field = '<p class="form-row ' . esc_attr( implode( ' ', $args['class'] ) ) .'" id="' . esc_attr( $key ) . '_field">
- <input type="' . $args['type'] . '" class="input-checkbox" name="' . esc_attr( $key ) . '" id="' . esc_attr( $key ) . '" value="1" '.checked( $value, 1, false ) .' />
- <label for="' . esc_attr( $key ) . '" class="checkbox ' . implode( ' ', $args['label_class'] ) .'" ' . implode( ' ', $custom_attributes ) . '>' . $args['label'] . $required . '</label>
- </p>' . $after;
- break;
- case "password" :
- $field = '<p class="form-row ' . esc_attr( implode( ' ', $args['class'] ) ) .'" id="' . esc_attr( $key ) . '_field">';
- if ( $args['label'] )
- $field .= '<label for="' . esc_attr( $key ) . '" class="' . implode( ' ', $args['label_class'] ) .'">' . $args['label']. $required . '</label>';
- $field .= '<input type="password" class="input-text" name="' . esc_attr( $key ) . '" id="' . esc_attr( $key ) . '" placeholder="' . $args['placeholder'] . '" value="' . esc_attr( $value ) . '" ' . implode( ' ', $custom_attributes ) . ' />
- </p>' . $after;
- break;
- case "text" :
- $field = '<p class="form-row ' . esc_attr( implode( ' ', $args['class'] ) ) .'" id="' . esc_attr( $key ) . '_field">';
- if ( $args['label'] )
- $field .= '<label for="' . esc_attr( $key ) . '" class="' . implode( ' ', $args['label_class'] ) .'">' . $args['label'] . $required . '</label>';
- $field .= '<input type="text" class="input-text" name="' . esc_attr( $key ) . '" id="' . esc_attr( $key ) . '" placeholder="' . $args['placeholder'] . '" '.$args['maxlength'].' value="' . esc_attr( $value ) . '" ' . implode( ' ', $custom_attributes ) . ' />
- </p>' . $after;
- break;
- case "select" :
- $options = '';
- if ( ! empty( $args['options'] ) )
- foreach ( $args['options'] as $option_key => $option_text )
- $options .= '<option value="' . esc_attr( $option_key ) . '" '. selected( $value, $option_key, false ) . '>' . esc_attr( $option_text ) .'</option>';
- $field = '<p class="form-row ' . esc_attr( implode( ' ', $args['class'] ) ) .'" id="' . esc_attr( $key ) . '_field">';
- if ( $args['label'] )
- $field .= '<label for="' . esc_attr( $key ) . '" class="' . implode( ' ', $args['label_class'] ) .'">' . $args['label']. $required . '</label>';
- $field .= '<select name="' . esc_attr( $key ) . '" id="' . esc_attr( $key ) . '" class="select" ' . implode( ' ', $custom_attributes ) . '>
- ' . $options . '
- </select>
- </p>' . $after;
- break;
- default :
- $field = apply_filters( 'woocommerce_form_field_' . $args['type'], '', $key, $args, $value );
- break;
- }
- if ( $args['return'] ) return $field; else echo $field;
- }
- }
- if ( ! function_exists( 'get_product_search_form' ) ) {
- /**
- * Output Product search forms.
- *
- * @access public
- * @subpackage Forms
- * @param bool $echo (default: true)
- * @return void
- */
- function get_product_search_form( $echo = true ) {
- do_action( 'get_product_search_form' );
- $search_form_template = locate_template( 'product-searchform.php' );
- if ( '' != $search_form_template ) {
- require $search_form_template;
- return;
- }
- $form = '<form role="search" method="get" id="searchform" action="' . esc_url( home_url( '/' ) ) . '">
- <div>
- <label class="screen-reader-text" for="s">' . __( 'Search for:', 'woocommerce' ) . '</label>
- <input type="text" value="' . get_search_query() . '" name="s" id="s" placeholder="' . __( 'Search for products', 'woocommerce' ) . '" />
- <input type="submit" id="searchsubmit" value="'. esc_attr__( 'Search', 'woocommerce' ) .'" />
- <input type="hidden" name="post_type" value="product" />
- </div>
- </form>';
- if ( $echo )
- echo apply_filters( 'get_product_search_form', $form );
- else
- return apply_filters( 'get_product_search_form', $form );
- }
- }