No Description

class-wc-admin-taxonomies.php 17KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498
  1. <?php
  2. /**
  3. * Handles taxonomies in admin
  4. *
  5. * @class WC_Admin_Taxonomies
  6. * @version 2.3.10
  7. * @package WooCommerce\Admin
  8. */
  9. if ( ! defined( 'ABSPATH' ) ) {
  10. exit; // Exit if accessed directly.
  11. }
  12. use Automattic\WooCommerce\Internal\AssignDefaultCategory;
  13. /**
  14. * WC_Admin_Taxonomies class.
  15. */
  16. class WC_Admin_Taxonomies {
  17. /**
  18. * Class instance.
  19. *
  20. * @var WC_Admin_Taxonomies instance
  21. */
  22. protected static $instance = false;
  23. /**
  24. * Default category ID.
  25. *
  26. * @var int
  27. */
  28. private $default_cat_id = 0;
  29. /**
  30. * Get class instance
  31. */
  32. public static function get_instance() {
  33. if ( ! self::$instance ) {
  34. self::$instance = new self();
  35. }
  36. return self::$instance;
  37. }
  38. /**
  39. * Constructor.
  40. */
  41. public function __construct() {
  42. // Default category ID.
  43. $this->default_cat_id = get_option( 'default_product_cat', 0 );
  44. // Category/term ordering.
  45. add_action( 'create_term', array( $this, 'create_term' ), 5, 3 );
  46. add_action(
  47. 'delete_product_cat',
  48. function() {
  49. wc_get_container()->get( AssignDefaultCategory::class )->schedule_action();
  50. }
  51. );
  52. // Add form.
  53. add_action( 'product_cat_add_form_fields', array( $this, 'add_category_fields' ) );
  54. add_action( 'product_cat_edit_form_fields', array( $this, 'edit_category_fields' ), 10 );
  55. add_action( 'created_term', array( $this, 'save_category_fields' ), 10, 3 );
  56. add_action( 'edit_term', array( $this, 'save_category_fields' ), 10, 3 );
  57. // Add columns.
  58. add_filter( 'manage_edit-product_cat_columns', array( $this, 'product_cat_columns' ) );
  59. add_filter( 'manage_product_cat_custom_column', array( $this, 'product_cat_column' ), 10, 3 );
  60. // Add row actions.
  61. add_filter( 'product_cat_row_actions', array( $this, 'product_cat_row_actions' ), 10, 2 );
  62. add_filter( 'admin_init', array( $this, 'handle_product_cat_row_actions' ) );
  63. // Taxonomy page descriptions.
  64. add_action( 'product_cat_pre_add_form', array( $this, 'product_cat_description' ) );
  65. add_action( 'after-product_cat-table', array( $this, 'product_cat_notes' ) );
  66. $attribute_taxonomies = wc_get_attribute_taxonomies();
  67. if ( ! empty( $attribute_taxonomies ) ) {
  68. foreach ( $attribute_taxonomies as $attribute ) {
  69. add_action( 'pa_' . $attribute->attribute_name . '_pre_add_form', array( $this, 'product_attribute_description' ) );
  70. }
  71. }
  72. // Maintain hierarchy of terms.
  73. add_filter( 'wp_terms_checklist_args', array( $this, 'disable_checked_ontop' ) );
  74. // Admin footer scripts for this product categories admin screen.
  75. add_action( 'admin_footer', array( $this, 'scripts_at_product_cat_screen_footer' ) );
  76. }
  77. /**
  78. * Order term when created (put in position 0).
  79. *
  80. * @param mixed $term_id Term ID.
  81. * @param mixed $tt_id Term taxonomy ID.
  82. * @param string $taxonomy Taxonomy slug.
  83. */
  84. public function create_term( $term_id, $tt_id = '', $taxonomy = '' ) {
  85. if ( 'product_cat' !== $taxonomy && ! taxonomy_is_product_attribute( $taxonomy ) ) {
  86. return;
  87. }
  88. $meta_name = taxonomy_is_product_attribute( $taxonomy ) ? 'order_' . esc_attr( $taxonomy ) : 'order';
  89. update_term_meta( $term_id, $meta_name, 0 );
  90. }
  91. /**
  92. * When a term is deleted, delete its meta.
  93. *
  94. * @deprecated 3.6.0 No longer needed.
  95. * @param mixed $term_id Term ID.
  96. */
  97. public function delete_term( $term_id ) {
  98. wc_deprecated_function( 'delete_term', '3.6' );
  99. }
  100. /**
  101. * Category thumbnail fields.
  102. */
  103. public function add_category_fields() {
  104. ?>
  105. <div class="form-field term-display-type-wrap">
  106. <label for="display_type"><?php esc_html_e( 'Display type', 'woocommerce' ); ?></label>
  107. <select id="display_type" name="display_type" class="postform">
  108. <option value=""><?php esc_html_e( 'Default', 'woocommerce' ); ?></option>
  109. <option value="products"><?php esc_html_e( 'Products', 'woocommerce' ); ?></option>
  110. <option value="subcategories"><?php esc_html_e( 'Subcategories', 'woocommerce' ); ?></option>
  111. <option value="both"><?php esc_html_e( 'Both', 'woocommerce' ); ?></option>
  112. </select>
  113. </div>
  114. <div class="form-field term-thumbnail-wrap">
  115. <label><?php esc_html_e( 'Thumbnail', 'woocommerce' ); ?></label>
  116. <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>
  117. <div style="line-height: 60px;">
  118. <input type="hidden" id="product_cat_thumbnail_id" name="product_cat_thumbnail_id" />
  119. <button type="button" class="upload_image_button button"><?php esc_html_e( 'Upload/Add image', 'woocommerce' ); ?></button>
  120. <button type="button" class="remove_image_button button"><?php esc_html_e( 'Remove image', 'woocommerce' ); ?></button>
  121. </div>
  122. <script type="text/javascript">
  123. // Only show the "remove image" button when needed
  124. if ( ! jQuery( '#product_cat_thumbnail_id' ).val() ) {
  125. jQuery( '.remove_image_button' ).hide();
  126. }
  127. // Uploading files
  128. var file_frame;
  129. jQuery( document ).on( 'click', '.upload_image_button', function( event ) {
  130. event.preventDefault();
  131. // If the media frame already exists, reopen it.
  132. if ( file_frame ) {
  133. file_frame.open();
  134. return;
  135. }
  136. // Create the media frame.
  137. file_frame = wp.media.frames.downloadable_file = wp.media({
  138. title: '<?php esc_html_e( 'Choose an image', 'woocommerce' ); ?>',
  139. button: {
  140. text: '<?php esc_html_e( 'Use image', 'woocommerce' ); ?>'
  141. },
  142. multiple: false
  143. });
  144. // When an image is selected, run a callback.
  145. file_frame.on( 'select', function() {
  146. var attachment = file_frame.state().get( 'selection' ).first().toJSON();
  147. var attachment_thumbnail = attachment.sizes.thumbnail || attachment.sizes.full;
  148. jQuery( '#product_cat_thumbnail_id' ).val( attachment.id );
  149. jQuery( '#product_cat_thumbnail' ).find( 'img' ).attr( 'src', attachment_thumbnail.url );
  150. jQuery( '.remove_image_button' ).show();
  151. });
  152. // Finally, open the modal.
  153. file_frame.open();
  154. });
  155. jQuery( document ).on( 'click', '.remove_image_button', function() {
  156. jQuery( '#product_cat_thumbnail' ).find( 'img' ).attr( 'src', '<?php echo esc_js( wc_placeholder_img_src() ); ?>' );
  157. jQuery( '#product_cat_thumbnail_id' ).val( '' );
  158. jQuery( '.remove_image_button' ).hide();
  159. return false;
  160. });
  161. jQuery( document ).ajaxComplete( function( event, request, options ) {
  162. if ( request && 4 === request.readyState && 200 === request.status
  163. && options.data && 0 <= options.data.indexOf( 'action=add-tag' ) ) {
  164. var res = wpAjax.parseAjaxResponse( request.responseXML, 'ajax-response' );
  165. if ( ! res || res.errors ) {
  166. return;
  167. }
  168. // Clear Thumbnail fields on submit
  169. jQuery( '#product_cat_thumbnail' ).find( 'img' ).attr( 'src', '<?php echo esc_js( wc_placeholder_img_src() ); ?>' );
  170. jQuery( '#product_cat_thumbnail_id' ).val( '' );
  171. jQuery( '.remove_image_button' ).hide();
  172. // Clear Display type field on submit
  173. jQuery( '#display_type' ).val( '' );
  174. return;
  175. }
  176. } );
  177. </script>
  178. <div class="clear"></div>
  179. </div>
  180. <?php
  181. }
  182. /**
  183. * Edit category thumbnail field.
  184. *
  185. * @param mixed $term Term (category) being edited.
  186. */
  187. public function edit_category_fields( $term ) {
  188. $display_type = get_term_meta( $term->term_id, 'display_type', true );
  189. $thumbnail_id = absint( get_term_meta( $term->term_id, 'thumbnail_id', true ) );
  190. if ( $thumbnail_id ) {
  191. $image = wp_get_attachment_thumb_url( $thumbnail_id );
  192. } else {
  193. $image = wc_placeholder_img_src();
  194. }
  195. ?>
  196. <tr class="form-field term-display-type-wrap">
  197. <th scope="row" valign="top"><label><?php esc_html_e( 'Display type', 'woocommerce' ); ?></label></th>
  198. <td>
  199. <select id="display_type" name="display_type" class="postform">
  200. <option value="" <?php selected( '', $display_type ); ?>><?php esc_html_e( 'Default', 'woocommerce' ); ?></option>
  201. <option value="products" <?php selected( 'products', $display_type ); ?>><?php esc_html_e( 'Products', 'woocommerce' ); ?></option>
  202. <option value="subcategories" <?php selected( 'subcategories', $display_type ); ?>><?php esc_html_e( 'Subcategories', 'woocommerce' ); ?></option>
  203. <option value="both" <?php selected( 'both', $display_type ); ?>><?php esc_html_e( 'Both', 'woocommerce' ); ?></option>
  204. </select>
  205. </td>
  206. </tr>
  207. <tr class="form-field term-thumbnail-wrap">
  208. <th scope="row" valign="top"><label><?php esc_html_e( 'Thumbnail', 'woocommerce' ); ?></label></th>
  209. <td>
  210. <div id="product_cat_thumbnail" style="float: left; margin-right: 10px;"><img src="<?php echo esc_url( $image ); ?>" width="60px" height="60px" /></div>
  211. <div style="line-height: 60px;">
  212. <input type="hidden" id="product_cat_thumbnail_id" name="product_cat_thumbnail_id" value="<?php echo esc_attr( $thumbnail_id ); ?>" />
  213. <button type="button" class="upload_image_button button"><?php esc_html_e( 'Upload/Add image', 'woocommerce' ); ?></button>
  214. <button type="button" class="remove_image_button button"><?php esc_html_e( 'Remove image', 'woocommerce' ); ?></button>
  215. </div>
  216. <script type="text/javascript">
  217. // Only show the "remove image" button when needed
  218. if ( '0' === jQuery( '#product_cat_thumbnail_id' ).val() ) {
  219. jQuery( '.remove_image_button' ).hide();
  220. }
  221. // Uploading files
  222. var file_frame;
  223. jQuery( document ).on( 'click', '.upload_image_button', function( event ) {
  224. event.preventDefault();
  225. // If the media frame already exists, reopen it.
  226. if ( file_frame ) {
  227. file_frame.open();
  228. return;
  229. }
  230. // Create the media frame.
  231. file_frame = wp.media.frames.downloadable_file = wp.media({
  232. title: '<?php esc_html_e( 'Choose an image', 'woocommerce' ); ?>',
  233. button: {
  234. text: '<?php esc_html_e( 'Use image', 'woocommerce' ); ?>'
  235. },
  236. multiple: false
  237. });
  238. // When an image is selected, run a callback.
  239. file_frame.on( 'select', function() {
  240. var attachment = file_frame.state().get( 'selection' ).first().toJSON();
  241. var attachment_thumbnail = attachment.sizes.thumbnail || attachment.sizes.full;
  242. jQuery( '#product_cat_thumbnail_id' ).val( attachment.id );
  243. jQuery( '#product_cat_thumbnail' ).find( 'img' ).attr( 'src', attachment_thumbnail.url );
  244. jQuery( '.remove_image_button' ).show();
  245. });
  246. // Finally, open the modal.
  247. file_frame.open();
  248. });
  249. jQuery( document ).on( 'click', '.remove_image_button', function() {
  250. jQuery( '#product_cat_thumbnail' ).find( 'img' ).attr( 'src', '<?php echo esc_js( wc_placeholder_img_src() ); ?>' );
  251. jQuery( '#product_cat_thumbnail_id' ).val( '' );
  252. jQuery( '.remove_image_button' ).hide();
  253. return false;
  254. });
  255. </script>
  256. <div class="clear"></div>
  257. </td>
  258. </tr>
  259. <?php
  260. }
  261. /**
  262. * Save category fields
  263. *
  264. * @param mixed $term_id Term ID being saved.
  265. * @param mixed $tt_id Term taxonomy ID.
  266. * @param string $taxonomy Taxonomy slug.
  267. */
  268. public function save_category_fields( $term_id, $tt_id = '', $taxonomy = '' ) {
  269. if ( isset( $_POST['display_type'] ) && 'product_cat' === $taxonomy ) { // WPCS: CSRF ok, input var ok.
  270. update_term_meta( $term_id, 'display_type', esc_attr( $_POST['display_type'] ) ); // WPCS: CSRF ok, sanitization ok, input var ok.
  271. }
  272. if ( isset( $_POST['product_cat_thumbnail_id'] ) && 'product_cat' === $taxonomy ) { // WPCS: CSRF ok, input var ok.
  273. update_term_meta( $term_id, 'thumbnail_id', absint( $_POST['product_cat_thumbnail_id'] ) ); // WPCS: CSRF ok, input var ok.
  274. }
  275. }
  276. /**
  277. * Description for product_cat page to aid users.
  278. */
  279. public function product_cat_description() {
  280. echo wp_kses(
  281. 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' ) ),
  282. array( 'p' => array() )
  283. );
  284. }
  285. /**
  286. * Add some notes to describe the behavior of the default category.
  287. */
  288. public function product_cat_notes() {
  289. $category_id = get_option( 'default_product_cat', 0 );
  290. $category = get_term( $category_id, 'product_cat' );
  291. $category_name = ( ! $category || is_wp_error( $category ) ) ? _x( 'Uncategorized', 'Default category slug', 'woocommerce' ) : $category->name;
  292. ?>
  293. <div class="form-wrap edit-term-notes">
  294. <p>
  295. <strong><?php esc_html_e( 'Note:', 'woocommerce' ); ?></strong><br>
  296. <?php
  297. printf(
  298. /* translators: %s: default category */
  299. esc_html__( 'Deleting a category does not delete the products in that category. Instead, products that were only assigned to the deleted category are set to the category %s.', 'woocommerce' ),
  300. '<strong>' . esc_html( $category_name ) . '</strong>'
  301. );
  302. ?>
  303. </p>
  304. </div>
  305. <?php
  306. }
  307. /**
  308. * Description for shipping class page to aid users.
  309. */
  310. public function product_attribute_description() {
  311. echo wp_kses(
  312. 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' ) ),
  313. array( 'p' => array() )
  314. );
  315. }
  316. /**
  317. * Thumbnail column added to category admin.
  318. *
  319. * @param mixed $columns Columns array.
  320. * @return array
  321. */
  322. public function product_cat_columns( $columns ) {
  323. $new_columns = array();
  324. if ( isset( $columns['cb'] ) ) {
  325. $new_columns['cb'] = $columns['cb'];
  326. unset( $columns['cb'] );
  327. }
  328. $new_columns['thumb'] = __( 'Image', 'woocommerce' );
  329. $columns = array_merge( $new_columns, $columns );
  330. $columns['handle'] = '';
  331. return $columns;
  332. }
  333. /**
  334. * Adjust row actions.
  335. *
  336. * @param array $actions Array of actions.
  337. * @param object $term Term object.
  338. * @return array
  339. */
  340. public function product_cat_row_actions( $actions, $term ) {
  341. $default_category_id = absint( get_option( 'default_product_cat', 0 ) );
  342. if ( $default_category_id !== $term->term_id && current_user_can( 'edit_term', $term->term_id ) ) {
  343. $actions['make_default'] = sprintf(
  344. '<a href="%s" aria-label="%s">%s</a>',
  345. wp_nonce_url( 'edit-tags.php?action=make_default&amp;taxonomy=product_cat&amp;post_type=product&amp;tag_ID=' . absint( $term->term_id ), 'make_default_' . absint( $term->term_id ) ),
  346. /* translators: %s: taxonomy term name */
  347. esc_attr( sprintf( __( 'Make &#8220;%s&#8221; the default category', 'woocommerce' ), $term->name ) ),
  348. __( 'Make default', 'woocommerce' )
  349. );
  350. }
  351. return $actions;
  352. }
  353. /**
  354. * Handle custom row actions.
  355. */
  356. public function handle_product_cat_row_actions() {
  357. if ( isset( $_GET['action'], $_GET['tag_ID'], $_GET['_wpnonce'] ) && 'make_default' === $_GET['action'] ) { // WPCS: CSRF ok, input var ok.
  358. $make_default_id = absint( $_GET['tag_ID'] ); // WPCS: Input var ok.
  359. if ( wp_verify_nonce( $_GET['_wpnonce'], 'make_default_' . $make_default_id ) && current_user_can( 'edit_term', $make_default_id ) ) { // WPCS: Sanitization ok, input var ok, CSRF ok.
  360. update_option( 'default_product_cat', $make_default_id );
  361. }
  362. }
  363. }
  364. /**
  365. * Thumbnail column value added to category admin.
  366. *
  367. * @param string $columns Column HTML output.
  368. * @param string $column Column name.
  369. * @param int $id Product ID.
  370. *
  371. * @return string
  372. */
  373. public function product_cat_column( $columns, $column, $id ) {
  374. if ( 'thumb' === $column ) {
  375. // Prepend tooltip for default category.
  376. $default_category_id = absint( get_option( 'default_product_cat', 0 ) );
  377. if ( $default_category_id === $id ) {
  378. $columns .= wc_help_tip( __( 'This is the default category and it cannot be deleted. It will be automatically assigned to products with no category.', 'woocommerce' ) );
  379. }
  380. $thumbnail_id = get_term_meta( $id, 'thumbnail_id', true );
  381. if ( $thumbnail_id ) {
  382. $image = wp_get_attachment_thumb_url( $thumbnail_id );
  383. } else {
  384. $image = wc_placeholder_img_src();
  385. }
  386. // Prevent esc_url from breaking spaces in urls for image embeds. Ref: https://core.trac.wordpress.org/ticket/23605 .
  387. $image = str_replace( ' ', '%20', $image );
  388. $columns .= '<img src="' . esc_url( $image ) . '" alt="' . esc_attr__( 'Thumbnail', 'woocommerce' ) . '" class="wp-post-image" height="48" width="48" />';
  389. }
  390. if ( 'handle' === $column ) {
  391. $columns .= '<input type="hidden" name="term_id" value="' . esc_attr( $id ) . '" />';
  392. }
  393. return $columns;
  394. }
  395. /**
  396. * Maintain term hierarchy when editing a product.
  397. *
  398. * @param array $args Term checklist args.
  399. * @return array
  400. */
  401. public function disable_checked_ontop( $args ) {
  402. if ( ! empty( $args['taxonomy'] ) && 'product_cat' === $args['taxonomy'] ) {
  403. $args['checked_ontop'] = false;
  404. }
  405. return $args;
  406. }
  407. /**
  408. * Admin footer scripts for the product categories admin screen
  409. *
  410. * @return void
  411. */
  412. public function scripts_at_product_cat_screen_footer() {
  413. if ( ! isset( $_GET['taxonomy'] ) || 'product_cat' !== $_GET['taxonomy'] ) { // WPCS: CSRF ok, input var ok.
  414. return;
  415. }
  416. // Ensure the tooltip is displayed when the image column is disabled on product categories.
  417. wc_enqueue_js(
  418. "(function( $ ) {
  419. 'use strict';
  420. var product_cat = $( 'tr#tag-" . absint( $this->default_cat_id ) . "' );
  421. product_cat.find( 'th' ).empty();
  422. product_cat.find( 'td.thumb span' ).detach( 'span' ).appendTo( product_cat.find( 'th' ) );
  423. })( jQuery );"
  424. );
  425. }
  426. }
  427. $wc_admin_taxonomies = WC_Admin_Taxonomies::get_instance();