class-wc-admin-attributes.php — WooCommerce 8.9.3

woocommerce / includes / admin / class-wc-admin-attributes.php

woocommerce / includes / admin Last commit date

class-wc-admin-attributes.php

511 lines

1	<?php
2	/**
3	* Attributes Page
4	*
5	* The attributes section lets users add custom attributes to assign to products - they can also be used in the "Filter Products by Attribute" widget.
6	*
7	* @package WooCommerce\Admin
8	* @version 2.3.0
9	*/
10
11	defined( 'ABSPATH' ) \|\| exit;
12
13	/**
14	* WC_Admin_Attributes Class.
15	*/
16	class WC_Admin_Attributes {
17
18	/**
19	* Edited attribute ID.
20	*
21	* @var int
22	*/
23	private static $edited_attribute_id;
24
25	/**
26	* Handles output of the attributes page in admin.
27	*
28	* Shows the created attributes and lets you add new ones or edit existing ones.
29	* The added attributes are stored in the database and can be used for layered navigation.
30	*/
31	public static function output() {
32	$result = '';
33	$action = '';
34
35	// Action to perform: add, edit, delete or none.
36	if ( ! empty( $_POST['add_new_attribute'] ) ) { // WPCS: CSRF ok.
37	$action = 'add';
38	} elseif ( ! empty( $_POST['save_attribute'] ) && ! empty( $_GET['edit'] ) ) { // WPCS: CSRF ok.
39	$action = 'edit';
40	} elseif ( ! empty( $_GET['delete'] ) ) {
41	$action = 'delete';
42	}
43
44	switch ( $action ) {
45	case 'add':
46	$result = self::process_add_attribute();
47	break;
48	case 'edit':
49	$result = self::process_edit_attribute();
50	break;
51	case 'delete':
52	$result = self::process_delete_attribute();
53	break;
54	}
55
56	if ( is_wp_error( $result ) ) {
57	echo '<div id="woocommerce_errors" class="error"><p>' . wp_kses_post( $result->get_error_message() ) . '</p></div>';
58	}
59
60	// Show admin interface.
61	if ( ! empty( $_GET['edit'] ) ) {
62	self::edit_attribute();
63	} else {
64	self::add_attribute();
65	}
66	}
67
68	/**
69	* Get and sanitize posted attribute data.
70	*
71	* @return array
72	*/
73	private static function get_posted_attribute() {
74	$attribute = array(
75	'attribute_label' => isset( $_POST['attribute_label'] ) ? wc_clean( wp_unslash( $_POST['attribute_label'] ) ) : '', // WPCS: input var ok, CSRF ok.
76	'attribute_name' => isset( $_POST['attribute_name'] ) ? wc_sanitize_taxonomy_name( wp_unslash( $_POST['attribute_name'] ) ) : '', // WPCS: input var ok, CSRF ok, sanitization ok.
77	'attribute_type' => isset( $_POST['attribute_type'] ) ? wc_clean( wp_unslash( $_POST['attribute_type'] ) ) : 'select', // WPCS: input var ok, CSRF ok.
78	'attribute_orderby' => isset( $_POST['attribute_orderby'] ) ? wc_clean( wp_unslash( $_POST['attribute_orderby'] ) ) : '', // WPCS: input var ok, CSRF ok.
79	'attribute_public' => isset( $_POST['attribute_public'] ) ? 1 : 0, // WPCS: input var ok, CSRF ok.
80	);
81
82	if ( empty( $attribute['attribute_type'] ) ) {
83	$attribute['attribute_type'] = 'select';
84	}
85	if ( empty( $attribute['attribute_label'] ) ) {
86	$attribute['attribute_label'] = ucfirst( $attribute['attribute_name'] );
87	}
88	if ( empty( $attribute['attribute_name'] ) ) {
89	$attribute['attribute_name'] = wc_sanitize_taxonomy_name( $attribute['attribute_label'] );
90	}
91
92	return $attribute;
93	}
94
95	/**
96	* Add an attribute.
97	*
98	* @return bool\|WP_Error
99	*/
100	private static function process_add_attribute() {
101	check_admin_referer( 'woocommerce-add-new_attribute' );
102
103	$attribute = self::get_posted_attribute();
104	$args = array(
105	'name' => $attribute['attribute_label'],
106	'slug' => $attribute['attribute_name'],
107	'type' => $attribute['attribute_type'],
108	'order_by' => $attribute['attribute_orderby'],
109	'has_archives' => $attribute['attribute_public'],
110	);
111
112	$id = wc_create_attribute( $args );
113
114	if ( is_wp_error( $id ) ) {
115	return $id;
116	}
117
118	return true;
119	}
120
121	/**
122	* Edit an attribute.
123	*
124	* @return bool\|WP_Error
125	*/
126	private static function process_edit_attribute() {
127	$attribute_id = isset( $_GET['edit'] ) ? absint( $_GET['edit'] ) : 0;
128	check_admin_referer( 'woocommerce-save-attribute_' . $attribute_id );
129
130	$attribute = self::get_posted_attribute();
131	$args = array(
132	'name' => $attribute['attribute_label'],
133	'slug' => $attribute['attribute_name'],
134	'type' => $attribute['attribute_type'],
135	'order_by' => $attribute['attribute_orderby'],
136	'has_archives' => $attribute['attribute_public'],
137	);
138
139	$id = wc_update_attribute( $attribute_id, $args );
140
141	if ( is_wp_error( $id ) ) {
142	return $id;
143	}
144
145	self::$edited_attribute_id = $id;
146
147	return true;
148	}
149
150	/**
151	* Delete an attribute.
152	*
153	* @return bool
154	*/
155	private static function process_delete_attribute() {
156	$attribute_id = isset( $_GET['delete'] ) ? absint( $_GET['delete'] ) : 0;
157	check_admin_referer( 'woocommerce-delete-attribute_' . $attribute_id );
158
159	return wc_delete_attribute( $attribute_id );
160	}
161
162	/**
163	* Edit Attribute admin panel.
164	*
165	* Shows the interface for changing an attributes type between select and text.
166	*/
167	public static function edit_attribute() {
168	global $wpdb;
169
170	$edit = isset( $_GET['edit'] ) ? absint( $_GET['edit'] ) : 0;
171
172	$attribute_to_edit = $wpdb->get_row(
173	$wpdb->prepare(
174	"
175	SELECT attribute_type, attribute_label, attribute_name, attribute_orderby, attribute_public
176	FROM {$wpdb->prefix}woocommerce_attribute_taxonomies WHERE attribute_id = %d
177	",
178	$edit
179	)
180	);
181
182	?>
183	<div class="wrap woocommerce">
184	<h1><?php esc_html_e( 'Edit attribute', 'woocommerce' ); ?></h1>
185
186	<?php
187	if ( ! $attribute_to_edit ) {
188	echo '<div id="woocommerce_errors" class="error"><p>' . esc_html__( 'Error: non-existing attribute ID.', 'woocommerce' ) . '</p></div>';
189	} else {
190	if ( self::$edited_attribute_id > 0 ) {
191	echo '<div id="message" class="updated"><p>' . esc_html__( 'Attribute updated successfully', 'woocommerce' ) . '</p><p><a href="' . esc_url( admin_url( 'edit.php?post_type=product&page=product_attributes' ) ) . '">' . esc_html__( 'Back to Attributes', 'woocommerce' ) . '</a></p></div>';
192	self::$edited_attribute_id = null;
193	}
194	$att_type = $attribute_to_edit->attribute_type;
195	$att_label = format_to_edit( $attribute_to_edit->attribute_label );
196	$att_name = $attribute_to_edit->attribute_name;
197	$att_orderby = $attribute_to_edit->attribute_orderby;
198	$att_public = $attribute_to_edit->attribute_public;
199	?>
200	<form action="edit.php?post_type=product&page=product_attributes&edit=<?php echo absint( $edit ); ?>" method="post">
201	<table class="form-table">
202	<tbody>
203	<?php do_action( 'woocommerce_before_edit_attribute_fields' ); ?>
204	<tr class="form-field form-required">
205	<th scope="row" valign="top">
206	<label for="attribute_label"><?php esc_html_e( 'Name', 'woocommerce' ); ?></label>
207	</th>
208	<td>
209	<input name="attribute_label" id="attribute_label" type="text" value="<?php echo esc_attr( $att_label ); ?>" />
210	<p class="description"><?php esc_html_e( 'Name for the attribute (shown on the front-end).', 'woocommerce' ); ?></p>
211	</td>
212	</tr>
213	<tr class="form-field form-required">
214	<th scope="row" valign="top">
215	<label for="attribute_name"><?php esc_html_e( 'Slug', 'woocommerce' ); ?></label>
216	</th>
217	<td>
218	<input name="attribute_name" id="attribute_name" type="text" value="<?php echo esc_attr( $att_name ); ?>" maxlength="28" />
219	<p class="description"><?php esc_html_e( 'Unique slug/reference for the attribute; must be no more than 28 characters.', 'woocommerce' ); ?></p>
220	</td>
221	</tr>
222	<tr class="form-field form-required">
223	<th scope="row" valign="top">
224	<label for="attribute_public"><?php esc_html_e( 'Enable archives?', 'woocommerce' ); ?></label>
225	</th>
226	<td>
227	<input name="attribute_public" id="attribute_public" type="checkbox" value="1" <?php checked( $att_public, 1 ); ?> />
228	<p class="description"><?php esc_html_e( 'Enable this if you want this attribute to have product archives in your store.', 'woocommerce' ); ?></p>
229	</td>
230	</tr>
231	<?php
232	/**
233	* Attribute types can change the way attributes are displayed on the frontend and admin.
234	*
235	* By Default WooCommerce only includes the `select` type. Others can be added with the
236	* `product_attributes_type_selector` filter. If there is only the default type registered,
237	* this setting will be hidden.
238	*/
239	if ( wc_has_custom_attribute_types() ) {
240	?>
241	<tr class="form-field form-required">
242	<th scope="row" valign="top">
243	<label for="attribute_type"><?php esc_html_e( 'Type', 'woocommerce' ); ?></label>
244	</th>
245	<td>
246	<select name="attribute_type" id="attribute_type">
247	<?php foreach ( wc_get_attribute_types() as $key => $value ) : ?>
248	<option value="<?php echo esc_attr( $key ); ?>" <?php selected( $att_type, $key ); ?>><?php echo esc_html( $value ); ?></option>
249	<?php endforeach; ?>
250	<?php
251	/**
252	* Deprecated action in favor of product_attributes_type_selector filter.
253	*
254	* @todo Remove in 4.0.0
255	* @deprecated 2.4.0
256	*/
257	do_action( 'woocommerce_admin_attribute_types' );
258	?>
259	</select>
260	<p class="description"><?php esc_html_e( "Determines how this attribute's values are displayed.", 'woocommerce' ); ?></p>
261	</td>
262	</tr>
263	<?php
264	}
265	?>
266	<tr class="form-field form-required">
267	<th scope="row" valign="top">
268	<label for="attribute_orderby"><?php esc_html_e( 'Default sort order', 'woocommerce' ); ?></label>
269	</th>
270	<td>
271	<select name="attribute_orderby" id="attribute_orderby">
272	<option value="menu_order" <?php selected( $att_orderby, 'menu_order' ); ?>><?php esc_html_e( 'Custom ordering', 'woocommerce' ); ?></option>
273	<option value="name" <?php selected( $att_orderby, 'name' ); ?>><?php esc_html_e( 'Name', 'woocommerce' ); ?></option>
274	<option value="name_num" <?php selected( $att_orderby, 'name_num' ); ?>><?php esc_html_e( 'Name (numeric)', 'woocommerce' ); ?></option>
275	<option value="id" <?php selected( $att_orderby, 'id' ); ?>><?php esc_html_e( 'Term ID', 'woocommerce' ); ?></option>
276	</select>
277	<p class="description"><?php esc_html_e( 'Determines the sort order of the terms on the frontend shop product pages. If using custom ordering, you can drag and drop the terms in this attribute.', 'woocommerce' ); ?></p>
278	</td>
279	</tr>
280	<?php do_action( 'woocommerce_after_edit_attribute_fields' ); ?>
281	</tbody>
282	</table>
283	<p class="submit"><button type="submit" name="save_attribute" id="submit" class="button-primary" value="<?php esc_attr_e( 'Update', 'woocommerce' ); ?>"><?php esc_html_e( 'Update', 'woocommerce' ); ?></button></p>
284	<?php wp_nonce_field( 'woocommerce-save-attribute_' . $edit ); ?>
285	</form>
286	<?php } ?>
287	</div>
288	<?php
289	}
290
291	/**
292	* Add Attribute admin panel.
293	*
294	* Shows the interface for adding new attributes.
295	*/
296	public static function add_attribute() {
297	?>
298	<div class="wrap woocommerce">
299	<h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
300
301	<br class="clear" />
302	<div id="col-container">
303	<div id="col-right">
304	<div class="col-wrap">
305	<table class="widefat attributes-table wp-list-table ui-sortable" style="width:100%">
306	<thead>
307	<tr>
308	<th scope="col"><?php esc_html_e( 'Name', 'woocommerce' ); ?></th>
309	<th scope="col"><?php esc_html_e( 'Slug', 'woocommerce' ); ?></th>
310	<?php if ( wc_has_custom_attribute_types() ) : ?>
311	<th scope="col"><?php esc_html_e( 'Type', 'woocommerce' ); ?></th>
312	<?php endif; ?>
313	<th scope="col"><?php esc_html_e( 'Order by', 'woocommerce' ); ?></th>
314	<th scope="col"><?php esc_html_e( 'Terms', 'woocommerce' ); ?></th>
315	</tr>
316	</thead>
317	<tbody>
318	<?php
319	$attribute_taxonomies = wc_get_attribute_taxonomies();
320	if ( $attribute_taxonomies ) {
321	/**
322	* Filters the maximum number of terms that will be displayed for each taxonomy in the Attributes page.
323	*
324	* @param int @default_max_terms_to_display Default value.
325	* @returns int Actual value to use, may be zero.
326	*
327	* @since 6.9.0
328	*/
329	$max_terms_to_display = apply_filters( 'woocommerce_max_terms_displayed_in_attributes_page', 100 );
330	foreach ( $attribute_taxonomies as $tax ) :
331	?>
332	<tr>
333	<td>
334	<strong><a href="edit-tags.php?taxonomy=<?php echo esc_attr( wc_attribute_taxonomy_name( $tax->attribute_name ) ); ?>&post_type=product"><?php echo esc_html( $tax->attribute_label ); ?></a></strong>
335
336	<div class="row-actions"><span class="edit"><a href="<?php echo esc_url( add_query_arg( 'edit', $tax->attribute_id, 'edit.php?post_type=product&page=product_attributes' ) ); ?>"><?php esc_html_e( 'Edit', 'woocommerce' ); ?></a> \| </span><span class="delete"><a class="delete" href="<?php echo esc_url( wp_nonce_url( add_query_arg( 'delete', $tax->attribute_id, 'edit.php?post_type=product&page=product_attributes' ), 'woocommerce-delete-attribute_' . $tax->attribute_id ) ); ?>"><?php esc_html_e( 'Delete', 'woocommerce' ); ?></a></span></div>
337	</td>
338	<td><?php echo esc_html( $tax->attribute_name ); ?></td>
339	<?php if ( wc_has_custom_attribute_types() ) : ?>
340	<td><?php echo esc_html( wc_get_attribute_type_label( $tax->attribute_type ) ); ?> <?php echo $tax->attribute_public ? esc_html__( '(Public)', 'woocommerce' ) : ''; ?></td>
341	<?php endif; ?>
342	<td>
343	<?php
344	switch ( $tax->attribute_orderby ) {
345	case 'name':
346	esc_html_e( 'Name', 'woocommerce' );
347	break;
348	case 'name_num':
349	esc_html_e( 'Name (numeric)', 'woocommerce' );
350	break;
351	case 'id':
352	esc_html_e( 'Term ID', 'woocommerce' );
353	break;
354	default:
355	esc_html_e( 'Custom ordering', 'woocommerce' );
356	break;
357	}
358	?>
359	</td>
360	<td class="attribute-terms">
361	<?php
362	$taxonomy = wc_attribute_taxonomy_name( $tax->attribute_name );
363
364	if ( taxonomy_exists( $taxonomy ) ) {
365	$total_count = (int) get_terms(
366	array(
367	'taxonomy' => $taxonomy,
368	'fields' => 'count',
369	'hide_empty' => false,
370	)
371	);
372	if ( 0 === $total_count ) {
373	echo '<span class="na">–</span>';
374	} elseif ( $max_terms_to_display > 0 ) {
375	$terms = get_terms(
376	array(
377	'taxonomy' => $taxonomy,
378	'number' => $max_terms_to_display,
379	'fields' => 'names',
380	'hide_empty' => false,
381	)
382	);
383	$terms_string = implode( ', ', $terms );
384	if ( $total_count > $max_terms_to_display ) {
385	$remaining = $total_count - $max_terms_to_display;
386	/* translators: 1: Comma-separated terms list, 2: how many terms are hidden */
387	$terms_string = sprintf( __( '%1$s... (%2$s more)', 'woocommerce' ), $terms_string, $remaining );
388	}
389	echo esc_html( $terms_string );
390	} elseif ( 1 === $total_count ) {
391	echo esc_html( __( '1 term', 'woocommerce' ) );
392	} else {
393	/* translators: %s: Total count of terms available for the attribute */
394	echo esc_html( sprintf( __( '%s terms', 'woocommerce' ), $total_count ) );
395	}
396	} else {
397	echo '<span class="na">–</span><br />';
398	}
399	?>
400	<br /><a href="edit-tags.php?taxonomy=<?php echo esc_attr( wc_attribute_taxonomy_name( $tax->attribute_name ) ); ?>&post_type=product" class="configure-terms"><?php esc_html_e( 'Configure terms', 'woocommerce' ); ?></a>
401	</td>
402	</tr>
403	<?php
404	endforeach;
405	} else {
406	?>
407	<tr>
408	<td colspan="6"><?php esc_html_e( 'No attributes currently exist.', 'woocommerce' ); ?></td>
409	</tr>
410	<?php
411	}
412	?>
413	</tbody>
414	</table>
415	</div>
416	</div>
417	<div id="col-left">
418	<div class="col-wrap">
419	<div class="form-wrap">
420	<h2><?php esc_html_e( 'Add new attribute', 'woocommerce' ); ?></h2>
421	<p><?php esc_html_e( 'Attributes let you define extra product data, such as size or color. You can use these attributes in the shop sidebar using the "layered nav" widgets.', 'woocommerce' ); ?></p>
422	<form action="edit.php?post_type=product&page=product_attributes" method="post">
423	<?php do_action( 'woocommerce_before_add_attribute_fields' ); ?>
424
425	<div class="form-field">
426	<label for="attribute_label"><?php esc_html_e( 'Name', 'woocommerce' ); ?></label>
427	<input name="attribute_label" id="attribute_label" type="text" value="" />
428	<p class="description"><?php esc_html_e( 'Name for the attribute (shown on the front-end).', 'woocommerce' ); ?></p>
429	</div>
430
431	<div class="form-field">
432	<label for="attribute_name"><?php esc_html_e( 'Slug', 'woocommerce' ); ?></label>
433	<input name="attribute_name" id="attribute_name" type="text" value="" maxlength="28" />
434	<p class="description"><?php esc_html_e( 'Unique slug/reference for the attribute; must be no more than 28 characters.', 'woocommerce' ); ?></p>
435	</div>
436
437	<div class="form-field">
438	<label for="attribute_public"><input name="attribute_public" id="attribute_public" type="checkbox" value="1" /> <?php esc_html_e( 'Enable Archives?', 'woocommerce' ); ?></label>
439
440	<p class="description"><?php esc_html_e( 'Enable this if you want this attribute to have product archives in your store.', 'woocommerce' ); ?></p>
441	</div>
442
443	<?php
444	/**
445	* Attribute types can change the way attributes are displayed on the frontend and admin.
446	*
447	* By Default WooCommerce only includes the `select` type. Others can be added with the
448	* `product_attributes_type_selector` filter. If there is only the default type registered,
449	* this setting will be hidden.
450	*/
451	if ( wc_has_custom_attribute_types() ) {
452	?>
453	<div class="form-field">
454	<label for="attribute_type"><?php esc_html_e( 'Type', 'woocommerce' ); ?></label>
455	<select name="attribute_type" id="attribute_type">
456	<?php foreach ( wc_get_attribute_types() as $key => $value ) : ?>
457	<option value="<?php echo esc_attr( $key ); ?>"><?php echo esc_html( $value ); ?></option>
458	<?php endforeach; ?>
459	<?php
460	/**
461	* Deprecated action in favor of product_attributes_type_selector filter.
462	*
463	* @todo Remove in 4.0.0
464	* @deprecated 2.4.0
465	*/
466	do_action( 'woocommerce_admin_attribute_types' );
467	?>
468	</select>
469	<p class="description"><?php esc_html_e( "Determines how this attribute's values are displayed.", 'woocommerce' ); ?></p>
470	</div>
471	<?php
472	}
473	?>
474
475	<div class="form-field">
476	<label for="attribute_orderby"><?php esc_html_e( 'Default sort order', 'woocommerce' ); ?></label>
477	<select name="attribute_orderby" id="attribute_orderby">
478	<option value="menu_order"><?php esc_html_e( 'Custom ordering', 'woocommerce' ); ?></option>
479	<option value="name"><?php esc_html_e( 'Name', 'woocommerce' ); ?></option>
480	<option value="name_num"><?php esc_html_e( 'Name (numeric)', 'woocommerce' ); ?></option>
481	<option value="id"><?php esc_html_e( 'Term ID', 'woocommerce' ); ?></option>
482	</select>
483	<p class="description"><?php esc_html_e( 'Determines the sort order of the terms on the frontend shop product pages. If using custom ordering, you can drag and drop the terms in this attribute.', 'woocommerce' ); ?></p>
484	</div>
485
486	<?php do_action( 'woocommerce_after_add_attribute_fields' ); ?>
487
488	<p class="submit"><button type="submit" name="add_new_attribute" id="submit" class="button button-primary" value="<?php esc_attr_e( 'Add attribute', 'woocommerce' ); ?>"><?php esc_html_e( 'Add attribute', 'woocommerce' ); ?></button></p>
489	<?php wp_nonce_field( 'woocommerce-add-new_attribute' ); ?>
490	</form>
491	</div>
492	</div>
493	</div>
494	</div>
495	<script type="text/javascript">
496	/* <![CDATA[ */
497
498	jQuery( 'a.delete' ).on( 'click', function() {
499	if ( window.confirm( '<?php esc_html_e( 'Are you sure you want to delete this attribute?', 'woocommerce' ); ?>' ) ) {
500	return true;
501	}
502	return false;
503	});
504
505	/* ]]> */
506	</script>
507	</div>
508	<?php
509	}
510	}
511