wc-account-functions.php — WooCommerce 4.2.4

woocommerce / includes / wc-account-functions.php

woocommerce / includes Last commit date

wc-account-functions.php

423 lines

1	<?php
2	/**
3	* WooCommerce Account Functions
4	*
5	* Functions for account specific things.
6	*
7	* @package WooCommerce/Functions
8	* @version 2.6.0
9	*/
10
11	defined( 'ABSPATH' ) \|\| exit;
12
13	/**
14	* Returns the url to the lost password endpoint url.
15	*
16	* @param string $default_url Default lost password URL.
17	* @return string
18	*/
19	function wc_lostpassword_url( $default_url = '' ) {
20	// Avoid loading too early.
21	if ( ! did_action( 'init' ) ) {
22	return $default_url;
23	}
24
25	// Don't redirect to the woocommerce endpoint on global network admin lost passwords.
26	if ( is_multisite() && isset( $_GET['redirect_to'] ) && false !== strpos( wp_unslash( $_GET['redirect_to'] ), network_admin_url() ) ) { // WPCS: input var ok, sanitization ok, CSRF ok.
27	return $default_url;
28	}
29
30	$wc_account_page_url = wc_get_page_permalink( 'myaccount' );
31	$wc_account_page_exists = wc_get_page_id( 'myaccount' ) > 0;
32	$lost_password_endpoint = get_option( 'woocommerce_myaccount_lost_password_endpoint' );
33
34	if ( $wc_account_page_exists && ! empty( $lost_password_endpoint ) ) {
35	return wc_get_endpoint_url( $lost_password_endpoint, '', $wc_account_page_url );
36	} else {
37	return $default_url;
38	}
39	}
40
41	add_filter( 'lostpassword_url', 'wc_lostpassword_url', 10, 1 );
42
43	/**
44	* Get the link to the edit account details page.
45	*
46	* @return string
47	*/
48	function wc_customer_edit_account_url() {
49	$edit_account_url = wc_get_endpoint_url( 'edit-account', '', wc_get_page_permalink( 'myaccount' ) );
50
51	return apply_filters( 'woocommerce_customer_edit_account_url', $edit_account_url );
52	}
53
54	/**
55	* Get the edit address slug translation.
56	*
57	* @param string $id Address ID.
58	* @param bool $flip Flip the array to make it possible to retrieve the values from both sides.
59	*
60	* @return string Address slug i18n.
61	*/
62	function wc_edit_address_i18n( $id, $flip = false ) {
63	$slugs = apply_filters(
64	'woocommerce_edit_address_slugs',
65	array(
66	'billing' => sanitize_title( _x( 'billing', 'edit-address-slug', 'woocommerce' ) ),
67	'shipping' => sanitize_title( _x( 'shipping', 'edit-address-slug', 'woocommerce' ) ),
68	)
69	);
70
71	if ( $flip ) {
72	$slugs = array_flip( $slugs );
73	}
74
75	if ( ! isset( $slugs[ $id ] ) ) {
76	return $id;
77	}
78
79	return $slugs[ $id ];
80	}
81
82	/**
83	* Get My Account menu items.
84	*
85	* @since 2.6.0
86	* @return array
87	*/
88	function wc_get_account_menu_items() {
89	$endpoints = array(
90	'orders' => get_option( 'woocommerce_myaccount_orders_endpoint', 'orders' ),
91	'downloads' => get_option( 'woocommerce_myaccount_downloads_endpoint', 'downloads' ),
92	'edit-address' => get_option( 'woocommerce_myaccount_edit_address_endpoint', 'edit-address' ),
93	'payment-methods' => get_option( 'woocommerce_myaccount_payment_methods_endpoint', 'payment-methods' ),
94	'edit-account' => get_option( 'woocommerce_myaccount_edit_account_endpoint', 'edit-account' ),
95	'customer-logout' => get_option( 'woocommerce_logout_endpoint', 'customer-logout' ),
96	);
97
98	$items = array(
99	'dashboard' => __( 'Dashboard', 'woocommerce' ),
100	'orders' => __( 'Orders', 'woocommerce' ),
101	'downloads' => __( 'Downloads', 'woocommerce' ),
102	'edit-address' => __( 'Addresses', 'woocommerce' ),
103	'payment-methods' => __( 'Payment methods', 'woocommerce' ),
104	'edit-account' => __( 'Account details', 'woocommerce' ),
105	'customer-logout' => __( 'Logout', 'woocommerce' ),
106	);
107
108	// Remove missing endpoints.
109	foreach ( $endpoints as $endpoint_id => $endpoint ) {
110	if ( empty( $endpoint ) ) {
111	unset( $items[ $endpoint_id ] );
112	}
113	}
114
115	// Check if payment gateways support add new payment methods.
116	if ( isset( $items['payment-methods'] ) ) {
117	$support_payment_methods = false;
118	foreach ( WC()->payment_gateways->get_available_payment_gateways() as $gateway ) {
119	if ( $gateway->supports( 'add_payment_method' ) \|\| $gateway->supports( 'tokenization' ) ) {
120	$support_payment_methods = true;
121	break;
122	}
123	}
124
125	if ( ! $support_payment_methods ) {
126	unset( $items['payment-methods'] );
127	}
128	}
129
130	return apply_filters( 'woocommerce_account_menu_items', $items, $endpoints );
131	}
132
133	/**
134	* Get account menu item classes.
135	*
136	* @since 2.6.0
137	* @param string $endpoint Endpoint.
138	* @return string
139	*/
140	function wc_get_account_menu_item_classes( $endpoint ) {
141	global $wp;
142
143	$classes = array(
144	'woocommerce-MyAccount-navigation-link',
145	'woocommerce-MyAccount-navigation-link--' . $endpoint,
146	);
147
148	// Set current item class.
149	$current = isset( $wp->query_vars[ $endpoint ] );
150	if ( 'dashboard' === $endpoint && ( isset( $wp->query_vars['page'] ) \|\| empty( $wp->query_vars ) ) ) {
151	$current = true; // Dashboard is not an endpoint, so needs a custom check.
152	} elseif ( 'orders' === $endpoint && isset( $wp->query_vars['view-order'] ) ) {
153	$current = true; // When looking at individual order, highlight Orders list item (to signify where in the menu the user currently is).
154	} elseif ( 'payment-methods' === $endpoint && isset( $wp->query_vars['add-payment-method'] ) ) {
155	$current = true;
156	}
157
158	if ( $current ) {
159	$classes[] = 'is-active';
160	}
161
162	$classes = apply_filters( 'woocommerce_account_menu_item_classes', $classes, $endpoint );
163
164	return implode( ' ', array_map( 'sanitize_html_class', $classes ) );
165	}
166
167	/**
168	* Get account endpoint URL.
169	*
170	* @since 2.6.0
171	* @param string $endpoint Endpoint.
172	* @return string
173	*/
174	function wc_get_account_endpoint_url( $endpoint ) {
175	if ( 'dashboard' === $endpoint ) {
176	return wc_get_page_permalink( 'myaccount' );
177	}
178
179	if ( 'customer-logout' === $endpoint ) {
180	return wc_logout_url();
181	}
182
183	return wc_get_endpoint_url( $endpoint, '', wc_get_page_permalink( 'myaccount' ) );
184	}
185
186	/**
187	* Get My Account > Orders columns.
188	*
189	* @since 2.6.0
190	* @return array
191	*/
192	function wc_get_account_orders_columns() {
193	$columns = apply_filters(
194	'woocommerce_account_orders_columns',
195	array(
196	'order-number' => __( 'Order', 'woocommerce' ),
197	'order-date' => __( 'Date', 'woocommerce' ),
198	'order-status' => __( 'Status', 'woocommerce' ),
199	'order-total' => __( 'Total', 'woocommerce' ),
200	'order-actions' => __( 'Actions', 'woocommerce' ),
201	)
202	);
203
204	// Deprecated filter since 2.6.0.
205	return apply_filters( 'woocommerce_my_account_my_orders_columns', $columns );
206	}
207
208	/**
209	* Get My Account > Downloads columns.
210	*
211	* @since 2.6.0
212	* @return array
213	*/
214	function wc_get_account_downloads_columns() {
215	$columns = apply_filters(
216	'woocommerce_account_downloads_columns',
217	array(
218	'download-product' => __( 'Product', 'woocommerce' ),
219	'download-remaining' => __( 'Downloads remaining', 'woocommerce' ),
220	'download-expires' => __( 'Expires', 'woocommerce' ),
221	'download-file' => __( 'Download', 'woocommerce' ),
222	'download-actions' => ' ',
223	)
224	);
225
226	if ( ! has_filter( 'woocommerce_account_download_actions' ) ) {
227	unset( $columns['download-actions'] );
228	}
229
230	return $columns;
231	}
232
233	/**
234	* Get My Account > Payment methods columns.
235	*
236	* @since 2.6.0
237	* @return array
238	*/
239	function wc_get_account_payment_methods_columns() {
240	return apply_filters(
241	'woocommerce_account_payment_methods_columns',
242	array(
243	'method' => __( 'Method', 'woocommerce' ),
244	'expires' => __( 'Expires', 'woocommerce' ),
245	'actions' => ' ',
246	)
247	);
248	}
249
250	/**
251	* Get My Account > Payment methods types
252	*
253	* @since 2.6.0
254	* @return array
255	*/
256	function wc_get_account_payment_methods_types() {
257	return apply_filters(
258	'woocommerce_payment_methods_types',
259	array(
260	'cc' => __( 'Credit card', 'woocommerce' ),
261	'echeck' => __( 'eCheck', 'woocommerce' ),
262	)
263	);
264	}
265
266	/**
267	* Get account orders actions.
268	*
269	* @since 3.2.0
270	* @param int\|WC_Order $order Order instance or ID.
271	* @return array
272	*/
273	function wc_get_account_orders_actions( $order ) {
274	if ( ! is_object( $order ) ) {
275	$order_id = absint( $order );
276	$order = wc_get_order( $order_id );
277	}
278
279	$actions = array(
280	'pay' => array(
281	'url' => $order->get_checkout_payment_url(),
282	'name' => __( 'Pay', 'woocommerce' ),
283	),
284	'view' => array(
285	'url' => $order->get_view_order_url(),
286	'name' => __( 'View', 'woocommerce' ),
287	),
288	'cancel' => array(
289	'url' => $order->get_cancel_order_url( wc_get_page_permalink( 'myaccount' ) ),
290	'name' => __( 'Cancel', 'woocommerce' ),
291	),
292	);
293
294	if ( ! $order->needs_payment() ) {
295	unset( $actions['pay'] );
296	}
297
298	if ( ! in_array( $order->get_status(), apply_filters( 'woocommerce_valid_order_statuses_for_cancel', array( 'pending', 'failed' ), $order ), true ) ) {
299	unset( $actions['cancel'] );
300	}
301
302	return apply_filters( 'woocommerce_my_account_my_orders_actions', $actions, $order );
303	}
304
305	/**
306	* Get account formatted address.
307	*
308	* @since 3.2.0
309	* @param string $address_type Address type.
310	* Accepts: 'billing' or 'shipping'.
311	* Default to 'billing'.
312	* @param int $customer_id Customer ID.
313	* Default to 0.
314	* @return string
315	*/
316	function wc_get_account_formatted_address( $address_type = 'billing', $customer_id = 0 ) {
317	$getter = "get_{$address_type}";
318	$address = array();
319
320	if ( 0 === $customer_id ) {
321	$customer_id = get_current_user_id();
322	}
323
324	$customer = new WC_Customer( $customer_id );
325
326	if ( is_callable( array( $customer, $getter ) ) ) {
327	$address = $customer->$getter();
328	unset( $address['email'], $address['tel'] );
329	}
330
331	return WC()->countries->get_formatted_address( apply_filters( 'woocommerce_my_account_my_address_formatted_address', $address, $customer->get_id(), $address_type ) );
332	}
333
334	/**
335	* Returns an array of a user's saved payments list for output on the account tab.
336	*
337	* @since 2.6
338	* @param array $list List of payment methods passed from wc_get_customer_saved_methods_list().
339	* @param int $customer_id The customer to fetch payment methods for.
340	* @return array Filtered list of customers payment methods.
341	*/
342	function wc_get_account_saved_payment_methods_list( $list, $customer_id ) {
343	$payment_tokens = WC_Payment_Tokens::get_customer_tokens( $customer_id );
344	foreach ( $payment_tokens as $payment_token ) {
345	$delete_url = wc_get_endpoint_url( 'delete-payment-method', $payment_token->get_id() );
346	$delete_url = wp_nonce_url( $delete_url, 'delete-payment-method-' . $payment_token->get_id() );
347	$set_default_url = wc_get_endpoint_url( 'set-default-payment-method', $payment_token->get_id() );
348	$set_default_url = wp_nonce_url( $set_default_url, 'set-default-payment-method-' . $payment_token->get_id() );
349
350	$type = strtolower( $payment_token->get_type() );
351	$list[ $type ][] = array(
352	'method' => array(
353	'gateway' => $payment_token->get_gateway_id(),
354	),
355	'expires' => esc_html__( 'N/A', 'woocommerce' ),
356	'is_default' => $payment_token->is_default(),
357	'actions' => array(
358	'delete' => array(
359	'url' => $delete_url,
360	'name' => esc_html__( 'Delete', 'woocommerce' ),
361	),
362	),
363	);
364	$key = key( array_slice( $list[ $type ], -1, 1, true ) );
365
366	if ( ! $payment_token->is_default() ) {
367	$list[ $type ][ $key ]['actions']['default'] = array(
368	'url' => $set_default_url,
369	'name' => esc_html__( 'Make default', 'woocommerce' ),
370	);
371	}
372
373	$list[ $type ][ $key ] = apply_filters( 'woocommerce_payment_methods_list_item', $list[ $type ][ $key ], $payment_token );
374	}
375	return $list;
376	}
377
378	add_filter( 'woocommerce_saved_payment_methods_list', 'wc_get_account_saved_payment_methods_list', 10, 2 );
379
380	/**
381	* Controls the output for credit cards on the my account page.
382	*
383	* @since 2.6
384	* @param array $item Individual list item from woocommerce_saved_payment_methods_list.
385	* @param WC_Payment_Token $payment_token The payment token associated with this method entry.
386	* @return array Filtered item.
387	*/
388	function wc_get_account_saved_payment_methods_list_item_cc( $item, $payment_token ) {
389	if ( 'cc' !== strtolower( $payment_token->get_type() ) ) {
390	return $item;
391	}
392
393	$card_type = $payment_token->get_card_type();
394	$item['method']['last4'] = $payment_token->get_last4();
395	$item['method']['brand'] = ( ! empty( $card_type ) ? ucfirst( $card_type ) : esc_html__( 'Credit card', 'woocommerce' ) );
396	$item['expires'] = $payment_token->get_expiry_month() . '/' . substr( $payment_token->get_expiry_year(), -2 );
397
398	return $item;
399	}
400
401	add_filter( 'woocommerce_payment_methods_list_item', 'wc_get_account_saved_payment_methods_list_item_cc', 10, 2 );
402
403	/**
404	* Controls the output for eChecks on the my account page.
405	*
406	* @since 2.6
407	* @param array $item Individual list item from woocommerce_saved_payment_methods_list.
408	* @param WC_Payment_Token $payment_token The payment token associated with this method entry.
409	* @return array Filtered item.
410	*/
411	function wc_get_account_saved_payment_methods_list_item_echeck( $item, $payment_token ) {
412	if ( 'echeck' !== strtolower( $payment_token->get_type() ) ) {
413	return $item;
414	}
415
416	$item['method']['last4'] = $payment_token->get_last4();
417	$item['method']['brand'] = esc_html__( 'eCheck', 'woocommerce' );
418
419	return $item;
420	}
421
422	add_filter( 'woocommerce_payment_methods_list_item', 'wc_get_account_saved_payment_methods_list_item_echeck', 10, 2 );
423