wc_products_array_orderby( array $products, string $orderby = 'date', string $order = 'desc' )
Sort an array of products by a value.
Description Description
Parameters Parameters
- $products
-
(Required) List of products to be ordered.
- $orderby
-
(Optional) order criteria.
Default value: 'date'
- $order
-
(Optional) Ascending or descending order.
Default value: 'desc'
Return Return
(array)
Source Source
File: includes/wc-product-functions.php
function wc_products_array_orderby( $products, $orderby = 'date', $order = 'desc' ) {
$orderby = strtolower( $orderby );
$order = strtolower( $order );
switch ( $orderby ) {
case 'title':
case 'id':
case 'date':
case 'modified':
case 'menu_order':
case 'price':
usort( $products, 'wc_products_array_orderby_' . $orderby );
break;
case 'none':
break;
default:
shuffle( $products );
break;
}
if ( 'desc' === $order ) {
$products = array_reverse( $products );
}
return $products;
}
Changelog Changelog
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |