wc-brands-functions.php — WooCommerce 10.4.2

woocommerce / includes / wc-brands-functions.php

woocommerce / includes Last commit date

wc-brands-functions.php

142 lines

1	<?php
2	/**
3	* Brands Helper Functions
4	*
5	* Important: For internal use only by the Automattic\WooCommerce\Internal\Brands package.
6	*
7	* @package WooCommerce
8	* @version 9.4.0
9	*/
10
11	declare( strict_types = 1);
12
13	/**
14	* Helper function :: wc_get_brand_thumbnail_url function.
15	*
16	* @param int $brand_id Brand ID.
17	* @param string $size Thumbnail image size.
18	* @return string
19	*/
20	function wc_get_brand_thumbnail_url( $brand_id, $size = 'full' ) {
21	$thumbnail_id = get_term_meta( $brand_id, 'thumbnail_id', true );
22
23	if ( $thumbnail_id ) {
24	$thumb_src = wp_get_attachment_image_src( $thumbnail_id, $size );
25	}
26
27	return ! empty( $thumb_src ) ? current( $thumb_src ) : '';
28	}
29
30	/**
31	* Helper function :: wc_get_brand_thumbnail_image function.
32	*
33	* @since 9.4.0
34	*
35	* @param object $brand Brand term.
36	* @param string $size Thumbnail image size.
37	* @return string
38	*/
39	function wc_get_brand_thumbnail_image( $brand, $size = '' ) {
40	$thumbnail_id = get_term_meta( $brand->term_id, 'thumbnail_id', true );
41
42	if ( '' === $size \|\| 'brand-thumb' === $size ) {
43	/**
44	* Filter the brand's thumbnail size.
45	*
46	* @since 9.4.0
47	*
48	* @param string $size Brand's thumbnail size.
49	*/
50	$size = apply_filters( 'woocommerce_brand_thumbnail_size', 'shop_catalog' );
51	}
52
53	if ( $thumbnail_id ) {
54	$image_src = wp_get_attachment_image_src( $thumbnail_id, $size );
55	$image_src = $image_src[0];
56	$dimensions = wc_get_image_size( $size );
57	$image_srcset = function_exists( 'wp_get_attachment_image_srcset' ) ? wp_get_attachment_image_srcset( $thumbnail_id, $size ) : false;
58	$image_sizes = function_exists( 'wp_get_attachment_image_sizes' ) ? wp_get_attachment_image_sizes( $thumbnail_id, $size ) : false;
59	} else {
60	$image_src = wc_placeholder_img_src();
61	$dimensions = wc_get_image_size( $size );
62	$image_srcset = false;
63	$image_sizes = false;
64	}
65
66	// Add responsive image markup if available.
67	if ( $image_srcset && $image_sizes ) {
68	$image = '<img src="' . esc_url( $image_src ) . '" alt="' . esc_attr( $brand->name ) . '" class="brand-thumbnail" width="' . esc_attr( $dimensions['width'] ) . '" height="' . esc_attr( $dimensions['height'] ) . '" srcset="' . esc_attr( $image_srcset ) . '" sizes="' . esc_attr( $image_sizes ) . '" />';
69	} else {
70	$image = '<img src="' . esc_url( $image_src ) . '" alt="' . esc_attr( $brand->name ) . '" class="brand-thumbnail" width="' . esc_attr( $dimensions['width'] ) . '" height="' . esc_attr( $dimensions['height'] ) . '" />';
71	}
72
73	return $image;
74	}
75
76	/**
77	* Retrieves product's brands.
78	*
79	* @param int $post_id Post ID (default: 0).
80	* @param string $sep Seperator (default: ').
81	* @param string $before Before item (default: '').
82	* @param string $after After item (default: '').
83	* @return array List of terms
84	*/
85	function wc_get_brands( $post_id = 0, $sep = ', ', $before = '', $after = '' ) {
86	global $post;
87
88	if ( ! $post_id ) {
89	$post_id = $post->ID;
90	}
91
92	return get_the_term_list( $post_id, 'product_brand', $before, $sep, $after );
93	}
94
95	/**
96	* Polyfills for backwards compatibility with the WooCommerce Brands plugin.
97	*/
98
99	if ( ! function_exists( 'get_brand_thumbnail_url' ) ) {
100
101	/**
102	* Polyfill for get_brand_thumbnail_image.
103	*
104	* @param int $brand_id Brand ID.
105	* @param string $size Thumbnail image size.
106	* @return string
107	*/
108	function get_brand_thumbnail_url( $brand_id, $size = 'full' ) {
109	return wc_get_brand_thumbnail_url( $brand_id, $size );
110	}
111	}
112
113	if ( ! function_exists( 'get_brand_thumbnail_image' ) ) {
114
115	/**
116	* Polyfill for get_brand_thumbnail_image.
117	*
118	* @param object $brand Brand term.
119	* @param string $size Thumbnail image size.
120	* @return string
121	*/
122	function get_brand_thumbnail_image( $brand, $size = '' ) {
123	return wc_get_brand_thumbnail_image( $brand, $size );
124	}
125	}
126
127	if ( ! function_exists( 'get_brands' ) ) {
128
129	/**
130	* Polyfill for get_brands.
131	*
132	* @param int $post_id Post ID (default: 0).
133	* @param string $sep Seperator (default: ').
134	* @param string $before Before item (default: '').
135	* @param string $after After item (default: '').
136	* @return array List of terms
137	*/
138	function get_brands( $post_id = 0, $sep = ', ', $before = '', $after = '' ) {
139	return wc_get_brands( $post_id, $sep, $before, $after );
140	}
141	}
142