WC_Widget_Brand_Thumbnails{}WC 1.0

Brand Thumbnails Widget

Show brand images as thumbnails

Important: For internal use only by the Automattic\WooCommerce\Internal\Brands package.

Хуки из класса

Использование

$WC_Widget_Brand_Thumbnails = new WC_Widget_Brand_Thumbnails();
// use class methods

Методы

  1. public __construct()
  2. public form( $instance )
  3. public update( $new_instance, $old_instance )
  4. public widget( $args, $instance )

Заметки

  • Пакет: WooCommerce\Widgets

Код WC_Widget_Brand_Thumbnails{} WC 9.4.2

<?php
class WC_Widget_Brand_Thumbnails extends WP_Widget {

	/**
	 * Widget CSS class.
	 *
	 * @var string
	 */
	public $woo_widget_cssclass;

	/**
	 * Widget description.
	 *
	 * @var string
	 */
	public $woo_widget_description;

	/**
	 * Widget id base.
	 *
	 * @var string
	 */
	public $woo_widget_idbase;

	/**
	 * Widget name.
	 *
	 * @var string
	 */
	public $woo_widget_name;

	/** Constructor */
	public function __construct() {

		/* Widget variable settings. */
		$this->woo_widget_name        = __( 'WooCommerce Brand Thumbnails', 'woocommerce' );
		$this->woo_widget_description = __( 'Show a grid of brand thumbnails.', 'woocommerce' );
		$this->woo_widget_idbase      = 'wc_brands_brand_thumbnails';
		$this->woo_widget_cssclass    = 'widget_brand_thumbnails';

		/* Widget settings. */
		$widget_ops = array(
			'classname'   => $this->woo_widget_cssclass,
			'description' => $this->woo_widget_description,
		);

		/* Create the widget. */
		parent::__construct( $this->woo_widget_idbase, $this->woo_widget_name, $widget_ops );
	}

	/**
	 * Echoes the widget content.
	 *
	 * @see WP_Widget
	 *
	 * @param array $args     Display arguments including 'before_title', 'after_title',
	 *                        'before_widget', and 'after_widget'.
	 * @param array $instance The settings for the particular instance of the widget.
	 */
	public function widget( $args, $instance ) {
		$instance = wp_parse_args(
			$instance,
			array(
				'title'      => '',
				'columns'    => 1,
				'exclude'    => '',
				'orderby'    => 'name',
				'hide_empty' => 0,
				'number'     => '',
			)
		);

		$exclude = array_map( 'intval', explode( ',', $instance['exclude'] ) );
		$order   = 'name' === $instance['orderby'] ? 'asc' : 'desc';

		$brands = get_terms(
			array(
				'taxonomy'   => 'product_brand',
				'hide_empty' => $instance['hide_empty'],
				'orderby'    => $instance['orderby'],
				'exclude'    => $exclude,
				'number'     => $instance['number'],
				'order'      => $order,
			)
		);

		if ( ! $brands ) {
			return;
		}

		/**
		 * Filter the widget's title.
		 *
		 * @since 9.4.0
		 *
		 * @param string $title Widget title
		 * @param array $instance The settings for the particular instance of the widget.
		 * @param string $woo_widget_idbase The widget's id base.
		 */
		$title = apply_filters( 'widget_title', $instance['title'], $instance, $this->woo_widget_idbase );

		echo $args['before_widget']; // phpcs:ignore WordPress.Security.EscapeOutput
		if ( '' !== $title ) {
			echo $args['before_title'] . $title . $args['after_title']; // phpcs:ignore WordPress.Security.EscapeOutput
		}

		wc_get_template(
			'widgets/brand-thumbnails.php',
			array(
				'brands'        => $brands,
				'columns'       => (int) $instance['columns'],
				'fluid_columns' => ! empty( $instance['fluid_columns'] ) ? true : false,
			),
			'woocommerce',
			WC()->plugin_path() . '/templates/brands/'
		);

		echo $args['after_widget']; // phpcs:ignore WordPress.Security.EscapeOutput
	}

	/**
	 * Update widget instance.
	 *
	 * @param array $new_instance The new settings for the particular instance of the widget.
	 * @param array $old_instance The old settings for the particular instance of the widget.
	 *
	 * @see WP_Widget->update
	 */
	public function update( $new_instance, $old_instance ) {
		$instance['title']         = wp_strip_all_tags( stripslashes( $new_instance['title'] ) );
		$instance['columns']       = wp_strip_all_tags( stripslashes( $new_instance['columns'] ) );
		$instance['fluid_columns'] = ! empty( $new_instance['fluid_columns'] ) ? true : false;
		$instance['orderby']       = wp_strip_all_tags( stripslashes( $new_instance['orderby'] ) );
		$instance['exclude']       = wp_strip_all_tags( stripslashes( $new_instance['exclude'] ) );
		$instance['hide_empty']    = wp_strip_all_tags( stripslashes( (string) $new_instance['hide_empty'] ) );
		$instance['number']        = wp_strip_all_tags( stripslashes( $new_instance['number'] ) );

		if ( ! $instance['columns'] ) {
			$instance['columns'] = 1;
		}

		if ( ! $instance['orderby'] ) {
			$instance['orderby'] = 'name';
		}

		if ( ! $instance['exclude'] ) {
			$instance['exclude'] = '';
		}

		if ( ! $instance['hide_empty'] ) {
			$instance['hide_empty'] = 0;
		}

		if ( ! $instance['number'] ) {
			$instance['number'] = '';
		}

		return $instance;
	}

	/**
	 * Outputs the settings update form.
	 *
	 * @param array $instance Current settings.
	 */
	public function form( $instance ) {
		if ( ! isset( $instance['hide_empty'] ) ) {
			$instance['hide_empty'] = 0;
		}

		if ( ! isset( $instance['orderby'] ) ) {
			$instance['orderby'] = 'name';
		}

		if ( empty( $instance['fluid_columns'] ) ) {
			$instance['fluid_columns'] = false;
		}

		?>
			<p>
				<label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php esc_html_e( 'Title:', 'woocommerce' ); ?></label>
				<input type="text" class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" value="<?php echo isset( $instance['title'] ) ? esc_attr( $instance['title'] ) : ''; ?>" />
			</p>

			<p>
				<label for="<?php echo esc_attr( $this->get_field_id( 'columns' ) ); ?>"><?php esc_html_e( 'Columns:', 'woocommerce' ); ?></label>
				<input type="text" class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'columns' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'columns' ) ); ?>" value="<?php echo isset( $instance['columns'] ) ? esc_attr( $instance['columns'] ) : '1'; ?>" />
			</p>

			<p>
				<label for="<?php echo esc_attr( $this->get_field_id( 'fluid_columns' ) ); ?>"><?php esc_html_e( 'Fluid columns:', 'woocommerce' ); ?></label>
				<input type="checkbox" <?php checked( $instance['fluid_columns'] ); ?> id="<?php echo esc_attr( $this->get_field_id( 'fluid_columns' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'fluid_columns' ) ); ?>" />
			</p>

			<p>
				<label for="<?php echo esc_attr( $this->get_field_id( 'number' ) ); ?>"><?php esc_html_e( 'Number:', 'woocommerce' ); ?></label>
				<input type="text" class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'number' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'number' ) ); ?>" value="<?php if ( isset ( $instance['number'] ) ) { echo esc_attr( $instance['number'] ); } // phpcs:ignore ?>" placeholder="<?php esc_attr_e( 'All', 'woocommerce' ); ?>" />
			</p>

			<p>
				<label for="<?php echo esc_attr( $this->get_field_id( 'exclude' ) ); ?>"><?php esc_html_e( 'Exclude:', 'woocommerce' ); ?></label>
				<input type="text" class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'exclude' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'exclude' ) ); ?>" value="<?php if ( isset ( $instance['exclude'] ) ) { echo esc_attr( $instance['exclude'] ); } // phpcs:ignore ?>" placeholder="<?php esc_attr_e( 'None', 'woocommerce' ); ?>" />
			</p>

			<p>
				<label for="<?php echo esc_attr( $this->get_field_id( 'hide_empty' ) ); ?>"><?php esc_html_e( 'Hide empty brands:', 'woocommerce' ); ?></label>
				<select id="<?php echo esc_attr( $this->get_field_id( 'hide_empty' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'hide_empty' ) ); ?>">
					<option value="1" <?php selected( $instance['hide_empty'], 1 ); ?>><?php esc_html_e( 'Yes', 'woocommerce' ); ?></option>
					<option value="0" <?php selected( $instance['hide_empty'], 0 ); ?>><?php esc_html_e( 'No', 'woocommerce' ); ?></option>
				</select>
			</p>

			<p>
				<label for="<?php echo esc_attr( $this->get_field_id( 'orderby' ) ); ?>"><?php esc_html_e( 'Order by:', 'woocommerce' ); ?></label>
				<select id="<?php echo esc_attr( $this->get_field_id( 'orderby' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'orderby' ) ); ?>">
					<option value="name" <?php selected( $instance['orderby'], 'name' ); ?>><?php esc_html_e( 'Name', 'woocommerce' ); ?></option>
					<option value="count" <?php selected( $instance['orderby'], 'count' ); ?>><?php esc_html_e( 'Count', 'woocommerce' ); ?></option>
				</select>
			</p>
		<?php
	}
}