WC_Admin_Taxonomies

WC_Admin_Taxonomies class.

Defined (1)

The class is defined in the following location(s).

/includes/admin/class-wc-admin-taxonomies.php  
  1. class WC_Admin_Taxonomies { 
  2.  
  3.     /** 
  4.      * Constructor. 
  5.      */ 
  6.     public function __construct() { 
  7.         // Category/term ordering 
  8.         add_action( 'create_term', array( $this, 'create_term' ), 5, 3 ); 
  9.         add_action( 'delete_term', array( $this, 'delete_term' ), 5 ); 
  10.  
  11.         // Add form 
  12.         add_action( 'product_cat_add_form_fields', array( $this, 'add_category_fields' ) ); 
  13.         add_action( 'product_cat_edit_form_fields', array( $this, 'edit_category_fields' ), 10 ); 
  14.         add_action( 'created_term', array( $this, 'save_category_fields' ), 10, 3 ); 
  15.         add_action( 'edit_term', array( $this, 'save_category_fields' ), 10, 3 ); 
  16.  
  17.         // Add columns 
  18.         add_filter( 'manage_edit-product_cat_columns', array( $this, 'product_cat_columns' ) ); 
  19.         add_filter( 'manage_product_cat_custom_column', array( $this, 'product_cat_column' ), 10, 3 ); 
  20.  
  21.         // Taxonomy page descriptions 
  22.         add_action( 'product_cat_pre_add_form', array( $this, 'product_cat_description' ) ); 
  23.  
  24.         $attribute_taxonomies = wc_get_attribute_taxonomies(); 
  25.  
  26.         if ( ! empty( $attribute_taxonomies ) ) { 
  27.             foreach ( $attribute_taxonomies as $attribute ) { 
  28.                 add_action( 'pa_' . $attribute->attribute_name . '_pre_add_form', array( $this, 'product_attribute_description' ) ); 
  29.             } 
  30.         } 
  31.  
  32.         // Maintain hierarchy of terms 
  33.         add_filter( 'wp_terms_checklist_args', array( $this, 'disable_checked_ontop' ) ); 
  34.     } 
  35.  
  36.     /** 
  37.      * Order term when created (put in position 0). 
  38.      * 
  39.      * @param mixed $term_id 
  40.      * @param mixed $tt_id 
  41.      * @param string $taxonomy 
  42.      */ 
  43.     public function create_term( $term_id, $tt_id = '', $taxonomy = '' ) { 
  44.         if ( 'product_cat' != $taxonomy && ! taxonomy_is_product_attribute( $taxonomy ) ) { 
  45.             return; 
  46.         } 
  47.  
  48.         $meta_name = taxonomy_is_product_attribute( $taxonomy ) ? 'order_' . esc_attr( $taxonomy ) : 'order'; 
  49.  
  50.         update_woocommerce_term_meta( $term_id, $meta_name, 0 ); 
  51.     } 
  52.  
  53.     /** 
  54.      * When a term is deleted, delete its meta. 
  55.      * 
  56.      * @param mixed $term_id 
  57.      */ 
  58.     public function delete_term( $term_id ) { 
  59.         global $wpdb; 
  60.  
  61.         $term_id = absint( $term_id ); 
  62.  
  63.         if ( $term_id && get_option( 'db_version' ) < 34370 ) { 
  64.             $wpdb->delete( $wpdb->woocommerce_termmeta, array( 'woocommerce_term_id' => $term_id ), array( '%d' ) ); 
  65.         } 
  66.     } 
  67.  
  68.     /** 
  69.      * Category thumbnail fields. 
  70.      */ 
  71.     public function add_category_fields() { 
  72.         ?> 
  73.         <div class="form-field term-display-type-wrap"> 
  74.             <label for="display_type"><?php _e( 'Display type', 'woocommerce' ); ?></label> 
  75.             <select id="display_type" name="display_type" class="postform"> 
  76.                 <option value=""><?php _e( 'Default', 'woocommerce' ); ?></option> 
  77.                 <option value="products"><?php _e( 'Products', 'woocommerce' ); ?></option> 
  78.                 <option value="subcategories"><?php _e( 'Subcategories', 'woocommerce' ); ?></option> 
  79.                 <option value="both"><?php _e( 'Both', 'woocommerce' ); ?></option> 
  80.             </select> 
  81.         </div> 
  82.         <div class="form-field term-thumbnail-wrap"> 
  83.             <label><?php _e( 'Thumbnail', 'woocommerce' ); ?></label> 
  84.             <div id="product_cat_thumbnail" style="float: left; margin-right: 10px;"><img src="<?php echo esc_url( wc_placeholder_img_src() ); ?>" width="60px" height="60px" /></div> 
  85.             <div style="line-height: 60px;"> 
  86.                 <input type="hidden" id="product_cat_thumbnail_id" name="product_cat_thumbnail_id" /> 
  87.                 <button type="button" class="upload_image_button button"><?php _e( 'Upload/Add image', 'woocommerce' ); ?></button> 
  88.                 <button type="button" class="remove_image_button button"><?php _e( 'Remove image', 'woocommerce' ); ?></button> 
  89.             </div> 
  90.             <script type="text/javascript"> 
  91.  
  92.                 // Only show the "remove image" button when needed 
  93.                 if ( ! jQuery( '#product_cat_thumbnail_id' ).val() ) { 
  94.                     jQuery( '.remove_image_button' ).hide(); 
  95.                 } 
  96.  
  97.                 // Uploading files 
  98.                 var file_frame; 
  99.  
  100.                 jQuery( document ).on( 'click', '.upload_image_button', function( event ) { 
  101.  
  102.                     event.preventDefault(); 
  103.  
  104.                     // If the media frame already exists, reopen it. 
  105.                     if ( file_frame ) { 
  106.                         file_frame.open(); 
  107.                         return; 
  108.                     } 
  109.  
  110.                     // Create the media frame. 
  111.                     file_frame = wp.media.frames.downloadable_file = wp.media({ 
  112.                         title: '<?php _e( "Choose an image", "woocommerce" ); ?>',  
  113.                         button: { 
  114.                             text: '<?php _e( "Use image", "woocommerce" ); ?>' 
  115.                         },  
  116.                         multiple: false 
  117.                     }); 
  118.  
  119.                     // When an image is selected, run a callback. 
  120.                     file_frame.on( 'select', function() { 
  121.                         var attachment = file_frame.state().get( 'selection' ).first().toJSON(); 
  122.                         var attachment_thumbnail = attachment.sizes.thumbnail || attachment.sizes.full; 
  123.  
  124.                         jQuery( '#product_cat_thumbnail_id' ).val( attachment.id ); 
  125.                         jQuery( '#product_cat_thumbnail' ).find( 'img' ).attr( 'src', attachment_thumbnail.url ); 
  126.                         jQuery( '.remove_image_button' ).show(); 
  127.                     }); 
  128.  
  129.                     // Finally, open the modal. 
  130.                     file_frame.open(); 
  131.                 }); 
  132.  
  133.                 jQuery( document ).on( 'click', '.remove_image_button', function() { 
  134.                     jQuery( '#product_cat_thumbnail' ).find( 'img' ).attr( 'src', '<?php echo esc_js( wc_placeholder_img_src() ); ?>' ); 
  135.                     jQuery( '#product_cat_thumbnail_id' ).val( '' ); 
  136.                     jQuery( '.remove_image_button' ).hide(); 
  137.                     return false; 
  138.                 }); 
  139.  
  140.                 jQuery( document ).ajaxComplete( function( event, request, options ) { 
  141.                     if ( request && 4 === request.readyState && 200 === request.status 
  142.                         && options.data && 0 <= options.data.indexOf( 'action=add-tag' ) ) { 
  143.  
  144.                         var res = wpAjax.parseAjaxResponse( request.responseXML, 'ajax-response' ); 
  145.                         if ( ! res || res.errors ) { 
  146.                             return; 
  147.                         } 
  148.                         // Clear Thumbnail fields on submit 
  149.                         jQuery( '#product_cat_thumbnail' ).find( 'img' ).attr( 'src', '<?php echo esc_js( wc_placeholder_img_src() ); ?>' ); 
  150.                         jQuery( '#product_cat_thumbnail_id' ).val( '' ); 
  151.                         jQuery( '.remove_image_button' ).hide(); 
  152.                         // Clear Display type field on submit 
  153.                         jQuery( '#display_type' ).val( '' ); 
  154.                         return; 
  155.                     } 
  156.                 } ); 
  157.  
  158.             </script> 
  159.             <div class="clear"></div> 
  160.         </div> 
  161.         <?php 
  162.     } 
  163.  
  164.     /** 
  165.      * Edit category thumbnail field. 
  166.      * 
  167.      * @param mixed $term Term (category) being edited 
  168.      */ 
  169.     public function edit_category_fields( $term ) { 
  170.  
  171.         $display_type = get_woocommerce_term_meta( $term->term_id, 'display_type', true ); 
  172.         $thumbnail_id = absint( get_woocommerce_term_meta( $term->term_id, 'thumbnail_id', true ) ); 
  173.  
  174.         if ( $thumbnail_id ) { 
  175.             $image = wp_get_attachment_thumb_url( $thumbnail_id ); 
  176.         } else { 
  177.             $image = wc_placeholder_img_src(); 
  178.         } 
  179.         ?> 
  180.         <tr class="form-field"> 
  181.             <th scope="row" valign="top"><label><?php _e( 'Display type', 'woocommerce' ); ?></label></th> 
  182.             <td> 
  183.                 <select id="display_type" name="display_type" class="postform"> 
  184.                     <option value="" <?php selected( '', $display_type ); ?>><?php _e( 'Default', 'woocommerce' ); ?></option> 
  185.                     <option value="products" <?php selected( 'products', $display_type ); ?>><?php _e( 'Products', 'woocommerce' ); ?></option> 
  186.                     <option value="subcategories" <?php selected( 'subcategories', $display_type ); ?>><?php _e( 'Subcategories', 'woocommerce' ); ?></option> 
  187.                     <option value="both" <?php selected( 'both', $display_type ); ?>><?php _e( 'Both', 'woocommerce' ); ?></option> 
  188.                 </select> 
  189.             </td> 
  190.         </tr> 
  191.         <tr class="form-field"> 
  192.             <th scope="row" valign="top"><label><?php _e( 'Thumbnail', 'woocommerce' ); ?></label></th> 
  193.             <td> 
  194.                 <div id="product_cat_thumbnail" style="float: left; margin-right: 10px;"><img src="<?php echo esc_url( $image ); ?>" width="60px" height="60px" /></div> 
  195.                 <div style="line-height: 60px;"> 
  196.                     <input type="hidden" id="product_cat_thumbnail_id" name="product_cat_thumbnail_id" value="<?php echo $thumbnail_id; ?>" /> 
  197.                     <button type="button" class="upload_image_button button"><?php _e( 'Upload/Add image', 'woocommerce' ); ?></button> 
  198.                     <button type="button" class="remove_image_button button"><?php _e( 'Remove image', 'woocommerce' ); ?></button> 
  199.                 </div> 
  200.                 <script type="text/javascript"> 
  201.  
  202.                     // Only show the "remove image" button when needed 
  203.                     if ( '0' === jQuery( '#product_cat_thumbnail_id' ).val() ) { 
  204.                         jQuery( '.remove_image_button' ).hide(); 
  205.                     } 
  206.  
  207.                     // Uploading files 
  208.                     var file_frame; 
  209.  
  210.                     jQuery( document ).on( 'click', '.upload_image_button', function( event ) { 
  211.  
  212.                         event.preventDefault(); 
  213.  
  214.                         // If the media frame already exists, reopen it. 
  215.                         if ( file_frame ) { 
  216.                             file_frame.open(); 
  217.                             return; 
  218.                         } 
  219.  
  220.                         // Create the media frame. 
  221.                         file_frame = wp.media.frames.downloadable_file = wp.media({ 
  222.                             title: '<?php _e( "Choose an image", "woocommerce" ); ?>',  
  223.                             button: { 
  224.                                 text: '<?php _e( "Use image", "woocommerce" ); ?>' 
  225.                             },  
  226.                             multiple: false 
  227.                         }); 
  228.  
  229.                         // When an image is selected, run a callback. 
  230.                         file_frame.on( 'select', function() { 
  231.                             var attachment = file_frame.state().get( 'selection' ).first().toJSON(); 
  232.                             var attachment_thumbnail = attachment.sizes.thumbnail || attachment.sizes.full; 
  233.  
  234.                             jQuery( '#product_cat_thumbnail_id' ).val( attachment.id ); 
  235.                             jQuery( '#product_cat_thumbnail' ).find( 'img' ).attr( 'src', attachment_thumbnail.url ); 
  236.                             jQuery( '.remove_image_button' ).show(); 
  237.                         }); 
  238.  
  239.                         // Finally, open the modal. 
  240.                         file_frame.open(); 
  241.                     }); 
  242.  
  243.                     jQuery( document ).on( 'click', '.remove_image_button', function() { 
  244.                         jQuery( '#product_cat_thumbnail' ).find( 'img' ).attr( 'src', '<?php echo esc_js( wc_placeholder_img_src() ); ?>' ); 
  245.                         jQuery( '#product_cat_thumbnail_id' ).val( '' ); 
  246.                         jQuery( '.remove_image_button' ).hide(); 
  247.                         return false; 
  248.                     }); 
  249.  
  250.                 </script> 
  251.                 <div class="clear"></div> 
  252.             </td> 
  253.         </tr> 
  254.         <?php 
  255.     } 
  256.  
  257.     /** 
  258.      * save_category_fields function. 
  259.      * 
  260.      * @param mixed $term_id Term ID being saved 
  261.      * @param mixed $tt_id 
  262.      * @param string $taxonomy 
  263.      */ 
  264.     public function save_category_fields( $term_id, $tt_id = '', $taxonomy = '' ) { 
  265.         if ( isset( $_POST['display_type'] ) && 'product_cat' === $taxonomy ) { 
  266.             update_woocommerce_term_meta( $term_id, 'display_type', esc_attr( $_POST['display_type'] ) ); 
  267.         } 
  268.         if ( isset( $_POST['product_cat_thumbnail_id'] ) && 'product_cat' === $taxonomy ) { 
  269.             update_woocommerce_term_meta( $term_id, 'thumbnail_id', absint( $_POST['product_cat_thumbnail_id'] ) ); 
  270.         } 
  271.     } 
  272.  
  273.     /** 
  274.      * Description for product_cat page to aid users. 
  275.      */ 
  276.     public function product_cat_description() { 
  277.         echo wpautop( __( 'Product categories for your store can be managed here. To change the order of categories on the front-end you can drag and drop to sort them. To see more categories listed click the "screen options" link at the top-right of this page.', 'woocommerce' ) ); 
  278.     } 
  279.  
  280.     /** 
  281.      * Description for shipping class page to aid users. 
  282.      */ 
  283.     public function product_attribute_description() { 
  284.         echo wpautop( __( 'Attribute terms can be assigned to products and variations.<br/><br/><b>Note</b>: Deleting a term will remove it from all products and variations to which it has been assigned. Recreating a term will not automatically assign it back to products.', 'woocommerce' ) ); 
  285.     } 
  286.  
  287.     /** 
  288.      * Thumbnail column added to category admin. 
  289.      * 
  290.      * @param mixed $columns 
  291.      * @return array 
  292.      */ 
  293.     public function product_cat_columns( $columns ) { 
  294.         $new_columns = array(); 
  295.  
  296.         if ( isset( $columns['cb'] ) ) { 
  297.             $new_columns['cb'] = $columns['cb']; 
  298.             unset( $columns['cb'] ); 
  299.         } 
  300.  
  301.         $new_columns['thumb'] = __( 'Image', 'woocommerce' ); 
  302.  
  303.         return array_merge( $new_columns, $columns ); 
  304.     } 
  305.  
  306.     /** 
  307.      * Thumbnail column value added to category admin. 
  308.      * 
  309.      * @param string $columns 
  310.      * @param string $column 
  311.      * @param int $id 
  312.      * @return array 
  313.      */ 
  314.     public function product_cat_column( $columns, $column, $id ) { 
  315.  
  316.         if ( 'thumb' == $column ) { 
  317.  
  318.             $thumbnail_id = get_woocommerce_term_meta( $id, 'thumbnail_id', true ); 
  319.  
  320.             if ( $thumbnail_id ) { 
  321.                 $image = wp_get_attachment_thumb_url( $thumbnail_id ); 
  322.             } else { 
  323.                 $image = wc_placeholder_img_src(); 
  324.             } 
  325.  
  326.             // Prevent esc_url from breaking spaces in urls for image embeds 
  327.             // Ref: https://core.trac.wordpress.org/ticket/23605 
  328.             $image = str_replace( ' ', '%20', $image ); 
  329.  
  330.             $columns .= '<img src="' . esc_url( $image ) . '" alt="' . esc_attr__( 'Thumbnail', 'woocommerce' ) . '" class="wp-post-image" height="48" width="48" />'; 
  331.  
  332.         } 
  333.  
  334.         return $columns; 
  335.     } 
  336.  
  337.     /** 
  338.      * Maintain term hierarchy when editing a product. 
  339.      * 
  340.      * @param  array $args 
  341.      * @return array 
  342.      */ 
  343.     public function disable_checked_ontop( $args ) { 
  344.         if ( ! empty( $args['taxonomy'] ) && 'product_cat' === $args['taxonomy'] ) { 
  345.             $args['checked_ontop'] = false; 
  346.         } 
  347.         return $args; 
  348.     } 
  349. }