Automattic\WooCommerce\Admin\API

Notes::prepare_objects_query() │ protected │ WC 1.0

Prepare objects query.

Method of the class: Notes{}

Return

Array.

Usage

// protected - for code of main (parent) or child class
$result = $this->prepare_objects_query( $request );

$request(WP_REST_Request) (required)

Full details about the request.

Notes::prepare_objects_query() Notes::prepare objects query code ^{WC 9.7.1}

protected function prepare_objects_query( $request ) {
	$args               = array();
	$args['order']      = $request['order'];
	$args['orderby']    = $request['orderby'];
	$args['per_page']   = $request['per_page'];
	$args['page']       = $request['page'];
	$args['type']       = isset( $request['type'] ) ? $request['type'] : array();
	$args['status']     = isset( $request['status'] ) ? $request['status'] : array();
	$args['source']     = isset( $request['source'] ) ? $request['source'] : array();
	$args['is_deleted'] = 0;

	if ( isset( $request['is_read'] ) ) {
		$args['is_read'] = filter_var( $request['is_read'], FILTER_VALIDATE_BOOLEAN );
	}

	if ( 'date' === $args['orderby'] ) {
		$args['orderby'] = 'date_created';
	}

	/**
	 * Filter the query arguments for a request.
	 *
	 * Enables adding extra arguments or setting defaults for a post
	 * collection request.
	 *
	 * @param array           $args    Key value array of query var to query value.
	 * @param WP_REST_Request $request The request used.
	 * @since 3.9.0
	 */
	$args = apply_filters( 'woocommerce_rest_notes_object_query', $args, $request );

	return $args;
}