Skip to content

Add attribute/attribute_term filtering to wc_get_products #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aines-ldr wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −0
Open

Add attribute/attribute_term filtering to wc_get_products #65

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions includes/Integrations/WooCommerce.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ public static function get_tools() {
'category' => [ 'type' => 'string', 'description' => 'Category slug to filter by' ],
'search' => [ 'type' => 'string', 'description' => 'Search term' ],
'type' => [ 'type' => 'string', 'description' => 'Product type (simple, variable, grouped, external)' ],
'attribute' => [ 'type' => 'string', 'description' => 'Global attribute taxonomy slug to filter by, e.g. pa_color (returned by wc_get_product_attributes)' ],
'attribute_term' => [ 'type' => 'string', 'description' => 'Term slug or term_id within the attribute to filter by, e.g. black-color (returned by wc_get_attribute_terms). Requires attribute to also be set.' ],
],
],
],
Expand Down Expand Up @@ -505,6 +507,22 @@ public static function execute_tool( $name, $args ) {
if ( ! empty( $args['type'] ) ) {
$query_args['type'] = sanitize_text_field( $args['type'] );
}

if ( ! empty( $args['attribute'] ) && ! empty( $args['attribute_term'] ) ) {
$taxonomy = sanitize_text_field( $args['attribute'] );
$term_value = sanitize_text_field( $args['attribute_term'] );
if ( ! taxonomy_exists( $taxonomy ) ) {
throw new \Exception( 'Unknown attribute taxonomy: ' . $taxonomy );
}
$query_args['tax_query'] = [
[
'taxonomy' => $taxonomy,
'field' => is_numeric( $term_value ) ? 'term_id' : 'slug',
'terms' => is_numeric( $term_value ) ? intval( $term_value ) : $term_value,
],
];
}

$products = wc_get_products( $query_args );
return array_map( [ __CLASS__, 'format_product_summary' ], $products );

Expand Down