Automattic\WooCommerce\Blocks\BlockTypes
ProductFilterStatus{} │ WC 1.0
Product Filter: Status Block.
Хуков нет.
Использование
$ProductFilterStatus = new ProductFilterStatus(); // use class methods
Методы
- protected enqueue_data( array $stock_statuses = array() )
- protected get_block_type_script( $key = null )
- public get_filter_query_param_keys( $filter_param_keys, $url_param_keys )
- private get_stock_status_counts( $block )
- protected initialize()
- public prepare_selected_filters( $items, $params )
- protected render( $attributes, $content, $block )
Код ProductFilterStatus{} ProductFilterStatus{} WC 9.8.5
final class ProductFilterStatus extends AbstractBlock {
/**
* Block name.
*
* @var string
*/
protected $block_name = 'product-filter-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( 'woocommerce_blocks_product_filters_param_keys', array( $this, 'get_filter_query_param_keys' ), 10, 2 );
add_filter( 'woocommerce_blocks_product_filters_selected_items', array( $this, 'prepare_selected_filters' ), 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
);
}
/**
* Prepare the active filter items.
*
* @param array $items The active filter items.
* @param array $params The query param parsed from the URL.
* @return array Active filters items.
*/
public function prepare_selected_filters( $items, $params ) {
$status_options = array_merge(
wc_get_product_stock_status_options(),
// On sale and Featured status are declared here.
array()
);
if ( empty( $params[ self::STOCK_STATUS_QUERY_VAR ] ) ) {
return $items;
}
$active_statuses = array_filter(
explode( ',', $params[ self::STOCK_STATUS_QUERY_VAR ] )
);
if ( empty( $active_statuses ) ) {
return $items;
}
$action_namespace = $this->get_full_block_name();
foreach ( $active_statuses as $status ) {
$items[] = array(
'type' => 'status',
'value' => $status,
// translators: %s: status.
'label' => sprintf( __( 'Status: %s', 'woocommerce' ), $status_options[ $status ] ),
);
}
return $items;
}
/**
* 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 = array() ) {
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 '';
}
wp_enqueue_script_module( $this->get_full_block_name() );
$stock_status_data = $this->get_stock_status_counts( $block );
$stock_statuses = wc_get_product_stock_status_options();
$filter_params = $block->context['filterParams'] ?? array();
$query = $filter_params[ self::STOCK_STATUS_QUERY_VAR ] ?? '';
$selected_stock_statuses = array_filter( explode( ',', $query ) );
$filter_options = array_map(
function ( $item ) use ( $stock_statuses, $selected_stock_statuses, $attributes ) {
$label = $stock_statuses[ $item['status'] ] . ( $attributes['showCounts'] ? ' (' . $item['count'] . ')' : '' );
return array(
'label' => $label,
'ariaLabel' => $label,
'value' => $item['status'],
'selected' => in_array( $item['status'], $selected_stock_statuses, true ),
'type' => 'status',
'data' => $item,
);
},
$stock_status_data
);
$filter_context = array(
'items' => array_values( $filter_options ),
'parent' => $this->get_full_block_name(),
);
$wrapper_attributes = array(
'data-wp-interactive' => $this->get_full_block_name(),
'data-wp-context' => wp_json_encode(
array(
'hasFilterOptions' => ! empty( $filter_options ),
/* translators: {{label}} is the status filter item label. */
'activeLabelTemplate' => __( 'Status: {{label}}', 'woocommerce' ),
),
JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP
),
'data-wp-bind--hidden' => '!context.hasFilterOptions',
);
if ( empty( $filter_options ) ) {
$wrapper_attributes['hidden'] = true;
}
return sprintf(
'<div %1$s>%2$s</div>',
get_block_wrapper_attributes(
$wrapper_attributes
),
array_reduce(
$block->parsed_block['innerBlocks'],
function ( $carry, $parsed_block ) use ( $filter_context ) {
$carry .= ( new \WP_Block( $parsed_block, array( 'filterData' => $filter_context ) ) )->render();
return $carry;
},
''
)
);
}
/**
* Retrieve the 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 ( isset( $query_vars['taxonomy'] ) && false !== strpos( $query_vars['taxonomy'], 'pa_' ) ) {
unset(
$query_vars['taxonomy'],
$query_vars['term']
);
}
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;
}
);
}
/**
* Disable the block type script, this uses script modules.
*
* @param string|null $key The key.
*
* @return null
*/
protected function get_block_type_script( $key = null ) {
return null;
}
}