WC_REST_Taxes_V1_Controller::get_items() │ public │ WC 1.0

Get all taxes.

Method of the class: WC_REST_Taxes_V1_Controller{}

Return

WP_Error|WP_REST_Response.

Usage

$WC_REST_Taxes_V1_Controller = new WC_REST_Taxes_V1_Controller();
$WC_REST_Taxes_V1_Controller->get_items( $request );

$request(WP_REST_Request) (required)

Full details about the request.

WC_REST_Taxes_V1_Controller::get_items() WC REST Taxes V1 Controller::get items code ^{WC 9.7.1}

public function get_items( $request ) {
	global $wpdb;

	$prepared_args           = array();
	$prepared_args['order']  = $request['order'];
	$prepared_args['number'] = $request['per_page'];
	if ( ! empty( $request['offset'] ) ) {
		$prepared_args['offset'] = $request['offset'];
	} else {
		$prepared_args['offset'] = ( $request['page'] - 1 ) * $prepared_args['number'];
	}
	$orderby_possibles        = array(
		'id'       => 'tax_rate_id',
		'order'    => 'tax_rate_order',
		'priority' => 'tax_rate_priority',
	);
	$prepared_args['orderby'] = $orderby_possibles[ $request['orderby'] ];
	$prepared_args['class']   = $request['class'];

	/**
	 * Filter arguments, before passing to $wpdb->get_results(), when querying taxes via the REST API.
	 *
	 * @param array           $prepared_args Array of arguments for $wpdb->get_results().
	 * @param WP_REST_Request $request       The current request.
	 */
	$prepared_args = apply_filters( 'woocommerce_rest_tax_query', $prepared_args, $request );

	$orderby = sanitize_key( $prepared_args['orderby'] ) . ' ' . sanitize_key( $prepared_args['order'] );
	$query   = "
		SELECT *
		FROM {$wpdb->prefix}woocommerce_tax_rates
		%s
		ORDER BY {$orderby}
		LIMIT %%d, %%d
	";

	$wpdb_prepare_args = array(
		$prepared_args['offset'],
		$prepared_args['number'],
	);

	// Filter by tax class.
	if ( empty( $prepared_args['class'] ) ) {
		$query = sprintf( $query, '' );
	} else {
		$class = 'standard' !== $prepared_args['class'] ? sanitize_title( $prepared_args['class'] ) : '';
		array_unshift( $wpdb_prepare_args, $class );
		$query = sprintf( $query, 'WHERE tax_rate_class = %s' );
	}

	// Query taxes.
	// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared
	$results = $wpdb->get_results(
		$wpdb->prepare(
			$query,
			$wpdb_prepare_args
		)
	);
	// phpcs:enable WordPress.DB.PreparedSQL.NotPrepared

	$taxes = array();
	foreach ( $results as $tax ) {
		$data    = $this->prepare_item_for_response( $tax, $request );
		$taxes[] = $this->prepare_response_for_collection( $data );
	}

	$response = rest_ensure_response( $taxes );

	$per_page = (int) $prepared_args['number'];
	$page     = ceil( ( ( (int) $prepared_args['offset'] ) / $per_page ) + 1 );

	// Unset LIMIT args.
	array_splice( $wpdb_prepare_args, -2 );

	// Count query.
	$query = str_replace(
		array(
			'SELECT *',
			'LIMIT %d, %d',
		),
		array(
			'SELECT COUNT(*)',
			'',
		),
		$query
	);

	// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared
	$total_taxes = (int) $wpdb->get_var( empty( $wpdb_prepare_args ) ? $query : $wpdb->prepare( $query, $wpdb_prepare_args ) );
	// phpcs:enable WordPress.DB.PreparedSQL.NotPrepared

	// Calculate totals.
	$response->header( 'X-WP-Total', $total_taxes );
	$max_pages = ceil( $total_taxes / $per_page );
	$response->header( 'X-WP-TotalPages', (int) $max_pages );

	$base = add_query_arg( $request->get_query_params(), rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ) );
	if ( $page > 1 ) {
		$prev_page = $page - 1;
		if ( $prev_page > $max_pages ) {
			$prev_page = $max_pages;
		}
		$prev_link = add_query_arg( 'page', $prev_page, $base );
		$response->link_header( 'prev', $prev_link );
	}
	if ( $max_pages > $page ) {
		$next_page = $page + 1;
		$next_link = add_query_arg( 'page', $next_page, $base );
		$response->link_header( 'next', $next_link );
	}

	return $response;
}