ProductFilterStockStatus.php
<?php
namespace Automattic\WooCommerce\Blocks\BlockTypes;
use Automattic\WooCommerce\Blocks\InteractivityComponents\Dropdown;
use Automattic\WooCommerce\Blocks\InteractivityComponents\CheckboxList;
use Automattic\WooCommerce\Blocks\Utils\ProductCollectionUtils;
use Automattic\WooCommerce\Blocks\QueryFilters;
use Automattic\WooCommerce\Blocks\Package;
/**
* Product Filter: Stock Status Block.
*/
final class ProductFilterStockStatus extends AbstractBlock {
/**
* Block name.
*
* @var string
*/
protected $block_name = 'product-filter-stock-status';
const STOCK_STATUS_QUERY_VAR = 'filter_stock_status';
/**
* Initialize this block type.
*
* - Hook into WP lifecycle.
* - Register the block with WordPress.
*/
protected function initialize() {
parent::initialize();
add_filter( 'collection_filter_query_param_keys', array( $this, 'get_filter_query_param_keys' ), 10, 2 );
add_filter( 'collection_active_filters_data', array( $this, 'register_active_filters_data' ), 10, 2 );
}
/**
* Register the query param keys.
*
* @param array $filter_param_keys The active filters data.
* @param array $url_param_keys The query param parsed from the URL.
*
* @return array Active filters param keys.
*/
public function get_filter_query_param_keys( $filter_param_keys, $url_param_keys ) {
$stock_param_keys = array_filter(
$url_param_keys,
function( $param ) {
return self::STOCK_STATUS_QUERY_VAR === $param;
}
);
return array_merge(
$filter_param_keys,
$stock_param_keys
);
}
/**
* Register the active filters data.
*
* @param array $data The active filters data.
* @param array $params The query param parsed from the URL.
* @return array Active filters data.
*/
public function register_active_filters_data( $data, $params ) {
$stock_status_options = wc_get_product_stock_status_options();
if ( empty( $params[ self::STOCK_STATUS_QUERY_VAR ] ) ) {
return $data;
}
$active_stock_statuses = array_filter(
explode( ',', $params[ self::STOCK_STATUS_QUERY_VAR ] )
);
if ( empty( $active_stock_statuses ) ) {
return $data;
}
$action_namespace = $this->get_full_block_name();
$active_stock_statuses = array_map(
function( $status ) use ( $stock_status_options, $action_namespace ) {
return array(
'title' => $stock_status_options[ $status ],
'attributes' => array(
'data-wc-on--click' => "$action_namespace::actions.removeFilter",
'data-wc-context' => "$action_namespace::" . wp_json_encode( array( 'value' => $status ) ),
),
);
},
$active_stock_statuses
);
$data['stock'] = array(
'type' => __( 'Stock Status', 'woocommerce' ),
'items' => $active_stock_statuses,
);
return $data;
}
/**
* Extra data passed through from server to client for block.
*
* @param array $stock_statuses Any stock statuses that currently are available from the block.
* Note, this will be empty in the editor context when the block is
* not in the post content on editor load.
*/
protected function enqueue_data( array $stock_statuses = [] ) {
parent::enqueue_data( $stock_statuses );
$this->asset_data_registry->add( 'stockStatusOptions', wc_get_product_stock_status_options() );
$this->asset_data_registry->add( 'hideOutOfStockItems', 'yes' === get_option( 'woocommerce_hide_out_of_stock_items' ) );
}
/**
* Include and render the block.
*
* @param array $attributes Block attributes. Default empty array.
* @param string $content Block content. Default empty string.
* @param WP_Block $block Block instance.
* @return string Rendered block type output.
*/
protected function render( $attributes, $content, $block ) {
// don't render if its admin, or ajax in progress.
if ( is_admin() || wp_doing_ajax() ) {
return '';
}
$stock_status_counts = $this->get_stock_status_counts( $block );
$wrapper_attributes = get_block_wrapper_attributes(
array(
'data-has-filter' => empty( $stock_status_counts ) ? 'no' : 'yes',
)
);
return sprintf(
'<div %1$s>%2$s</div>',
$wrapper_attributes,
$this->get_stock_filter_html( $stock_status_counts, $attributes ),
);
}
/**
* Stock filter HTML
*
* @param array $stock_counts An array of stock counts.
* @param array $attributes Block attributes. Default empty array.
* @return string Rendered block type output.
*/
private function get_stock_filter_html( $stock_counts, $attributes ) {
if ( empty( $stock_counts ) ) {
return '';
}
$display_style = $attributes['displayStyle'] ?? 'list';
$show_counts = $attributes['showCounts'] ?? false;
$select_type = $attributes['selectType'] ?? 'single';
$stock_statuses = wc_get_product_stock_status_options();
$placeholder_text = 'single' === $select_type ? __( 'Select stock status', 'woocommerce' ) : __( 'Select stock statuses', 'woocommerce' );
// check the url params to select initial item on page load.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Nonce verification is not required here.
$query = isset( $_GET[ self::STOCK_STATUS_QUERY_VAR ] ) ? sanitize_text_field( wp_unslash( $_GET[ self::STOCK_STATUS_QUERY_VAR ] ) ) : '';
$selected_stock_statuses = explode( ',', $query );
$list_items = array_values(
array_map(
function( $item ) use ( $stock_statuses, $show_counts, $selected_stock_statuses ) {
$label = $show_counts ? $stock_statuses[ $item['status'] ] . ' (' . $item['count'] . ')' : $stock_statuses[ $item['status'] ];
return array(
'label' => $label,
'value' => $item['status'],
'checked' => in_array( $item['status'], $selected_stock_statuses, true ),
);
},
$stock_counts
)
);
$selected_items = array_values(
array_filter(
$list_items,
function( $item ) use ( $selected_stock_statuses ) {
return in_array( $item['value'], $selected_stock_statuses, true );
}
)
);
$data_directive = wp_json_encode( array( 'namespace' => $this->get_full_block_name() ) );
ob_start();
?>
<div data-wc-interactive='<?php echo esc_attr( $data_directive ); ?>'>
<?php if ( 'list' === $display_style ) { ?>
<?php
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- CheckboxList::render() escapes output.
echo CheckboxList::render(
array(
'items' => $list_items,
'on_change' => "{$this->get_full_block_name()}::actions.onCheckboxChange",
)
);
?>
<?php } ?>
<?php if ( 'dropdown' === $display_style ) : ?>
<?php
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Dropdown::render() escapes output.
echo Dropdown::render(
array(
'items' => $list_items,
'action' => "{$this->get_full_block_name()}::actions.onDropdownChange",
'selected_items' => $selected_items,
'select_type' => $select_type,
'placeholder' => $placeholder_text,
)
);
?>
<?php endif; ?>
</div>
<?php
return ob_get_clean();
}
/**
* Retrieve the stock status filter data for current block.
*
* @param WP_Block $block Block instance.
*/
private function get_stock_status_counts( $block ) {
$filters = Package::container()->get( QueryFilters::class );
$query_vars = ProductCollectionUtils::get_query_vars( $block, 1 );
unset( $query_vars['filter_stock_status'] );
if ( ! empty( $query_vars['meta_query'] ) ) {
// phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
$query_vars['meta_query'] = ProductCollectionUtils::remove_query_array( $query_vars['meta_query'], 'key', '_stock_status' );
}
$counts = $filters->get_stock_status_counts( $query_vars );
$data = array();
foreach ( $counts as $key => $value ) {
$data[] = array(
'status' => $key,
'count' => $value,
);
}
return array_filter(
$data,
function( $stock_count ) {
return $stock_count['count'] > 0;
}
);
}
}
