Skip to content

Add checkout data and user orders REST APIs #3034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
syedgalib wants to merge 2 commits into
base: development
Choose a base branch
from
Open

Add checkout data and user orders REST APIs #3034

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf989eb
feat: add user checkout and orders APIs
syedgalib Sep 22, 2026
de7bdb4
style: fix order controller PHPCS
syedgalib Sep 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion includes/repositories/order-repository.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ function( $order ) {
$order->total_amount = directorist_order_total_amount( $order );

return apply_filters( 'directorist_order_data', $order );
}, $query->order_by_desc( 'd_order.id' )->pagination( $dto->get_page(), $dto->get_per_page() )
}, $query->order_by_desc( 'd_order.id' )->pagination( $dto->get_page(), $dto->get_per_page(), 1, 100 )
);

return $orders;
Expand Down
32 changes: 32 additions & 0 deletions includes/rest-api/Version1/class-checkout-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ public function register_routes() {
$this->namespace,
'/' . $this->rest_base,
[
[
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'get_checkout_data' ],
'permission_callback' => '__return_true',
],
[
'methods' => WP_REST_Server::CREATABLE,
'callback' => [ $this, 'checkout' ],
Expand Down Expand Up @@ -65,6 +70,33 @@ public function register_routes() {
);
}

/**
* Get the checkout provider and page URL.
*
* @param WP_REST_Request $request Request object.
* @return \WP_REST_Response
*/
public function get_checkout_data( WP_REST_Request $request ) {
$checkout_page_id = (int) get_directorist_option( 'checkout_page', 0 );
$data = [
'type' => 'directorist',
'url' => $checkout_page_id ? get_permalink( $checkout_page_id ) : '',
];

/**
* Filters the checkout provider data returned by the REST API.
*
* Extensions can replace the provider type and URL when they own the
* checkout flow.
*
* @param array $data Checkout provider data.
* @param WP_REST_Request $request Request object.
*/
$data = apply_filters( 'directorist_rest_checkout_data', $data, $request );

return rest_ensure_response( $data );
}

public function checkout( WP_REST_Request $request ) {
try {
$checkout_type = $request->get_param( 'checkout_type' );
Expand Down
214 changes: 201 additions & 13 deletions includes/rest-api/Version1/class-order-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,32 @@ public function register_routes() {
'permission_callback' => [ $this, 'auth_permissions_check' ],
'args' => $this->index_args(),
],
[
'methods' => WP_REST_Server::CREATABLE,
'callback' => [ $this, 'user_store' ],
'permission_callback' => [ $this, 'auth_permissions_check' ],
'args' => $this->user_store_args(),
],
]
);

register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P<id>[\d]+)',
[
[
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'user_show' ],
'permission_callback' => [ $this, 'auth_permissions_check' ],
'args' => [
'id' => [
'description' => __( 'The order ID.', 'directorist' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'required' => true,
],
],
],
]
);

Expand Down Expand Up @@ -153,13 +179,108 @@ public function admin_index( WP_REST_Request $request ) {
}

public function index( WP_REST_Request $request ) {
$page = (int) $request->get_param( "page" );
$per_page = (int) $request->get_param( "perPage" );
$search = (string) $request->get_param( "search" );
$pre_response = apply_filters( 'directorist_rest_pre_get_user_orders', null, $request );

if ( null !== $pre_response ) {
return is_wp_error( $pre_response ) ? $pre_response : rest_ensure_response( $pre_response );
}

$page = max( 1, (int) $request->get_param( 'page' ) );
$per_page = $request->get_param( 'per_page' );
$per_page = max( 1, min( 100, null !== $per_page ? (int) $per_page : (int) $request->get_param( 'perPage' ) ) );
$search = (string) $request->get_param( 'search' );
$dto = ( new OrderRead )->set_page( $page )->set_per_page( $per_page )->set_search( $search );
$repository = directorist_order_repository();
$orders = $repository->get_by_user_id( get_current_user_id(), $dto );
$response = rest_ensure_response( $this->prepare_user_order_data( $orders['items'], $request ) );

$response->header( 'X-WP-Total', (int) $orders['total'] );
$response->header( 'X-WP-TotalPages', (int) ceil( $orders['total'] / $per_page ) );

return rest_ensure_response( $repository->get_by_user_id( get_current_user_id(), $dto ) );
return $response;
}

/**
* Create an order for the current user.
*
* @param WP_REST_Request $request Request object.
* @return WP_Error|\WP_REST_Response
*/
public function user_store( WP_REST_Request $request ) {
$pre_response = apply_filters( 'directorist_rest_pre_create_user_order', null, $request );

if ( null !== $pre_response ) {
return is_wp_error( $pre_response ) ? $pre_response : rest_ensure_response( $pre_response );
}

$listing_id = (int) $request->get_param( 'listing_id' );

if ( $listing_id && ( ! directorist_is_listing_post_type( $listing_id ) || (int) get_post_field( 'post_author', $listing_id ) !== get_current_user_id() ) ) {
return new WP_Error( 'rest_invalid_listing', __( 'The listing was not found.', 'directorist' ), [ 'status' => 404 ] );
}

$amount = max( 0, round( (float) $request->get_param( 'amount' ), 2 ) );
$currency = sanitize_text_field( (string) $request->get_param( 'currency' ) );
$dto = ( new OrderDTO )
->set_user_id( get_current_user_id() )
->set_amount( $amount )
->set_sub_total( $amount )
->set_currency( $currency ? $currency : atbdp_get_payment_currency() )
->set_status( OrderStatus::PENDING );

if ( $listing_id ) {
$dto->set_listing_id( $listing_id );
}

$plan_id = (int) $request->get_param( 'plan_id' );

if ( $plan_id ) {
$dto->set_ref( (string) $plan_id )->set_ref_type( 'pricing_plan' );
}

if ( $request->get_param( 'featured' ) ) {
$dto->set_is_featured_listing( 1 );
}

$dto = apply_filters( 'directorist_rest_user_order_dto', $dto, $request );
$repository = directorist_order_repository();
$order_id = $repository->create( $dto );

if ( ! $order_id ) {
return new WP_Error( 'rest_order_create_failed', __( 'Unable to create the order.', 'directorist' ), [ 'status' => 500 ] );
}

$order = $repository->single( $order_id );
$response = rest_ensure_response( $this->prepare_user_order_data( $order, $request ) );

$response->set_status( 201 );
$response->header( 'Location', rest_url( '/' . $this->namespace . '/' . $this->rest_base . '/' . $order_id ) );

do_action( 'directorist_rest_user_order_created', $order_id, $request, $dto );

return $response;
}

/**
* Get an order belonging to the current user.
*
* @param WP_REST_Request $request Request object.
* @return WP_Error|\WP_REST_Response
*/
public function user_show( WP_REST_Request $request ) {
$pre_response = apply_filters( 'directorist_rest_pre_get_user_order', null, $request );

if ( null !== $pre_response ) {
return is_wp_error( $pre_response ) ? $pre_response : rest_ensure_response( $pre_response );
}

$order = directorist_order_repository()->single( $request->get_param( 'id' ) );

if ( ! $order || (int) $order->user_id !== get_current_user_id() ) {
return new WP_Error( 'rest_not_found', __( 'The order was not found.', 'directorist' ), [ 'status' => 404 ] );
}

return rest_ensure_response( $this->prepare_user_order_data( $order, $request ) );
}

public function store( WP_REST_Request $request ) {
Expand All @@ -168,8 +289,8 @@ public function store( WP_REST_Request $request ) {
->set_listing_id( $request->get_param( "listing_id" ) )
->set_amount( $request->get_param( "amount" ) )
->set_currency( $request->get_param( "currency" ) )
->set_status( $request->get_param( "status" ) ) ;
->set_status( $request->get_param( "status" ) );

$id = directorist_order_repository()->create( $dto );

status_header( 201 );
Expand Down Expand Up @@ -201,7 +322,7 @@ public function show( WP_REST_Request $request ) {

public function update( WP_REST_Request $request ) {
$dto = ( new OrderDTO )->set_id( $request->get_param( 'id' ) )
->set_user_id( $request->get_param( 'user_id' ) )
->set_user_id( $request->get_param( 'user_id' ) )
->set_listing_id( $request->get_param( 'listing_id' ) )
->set_status( $request->get_param( 'status' ) );

Expand Down Expand Up @@ -234,13 +355,15 @@ public function update_status( WP_REST_Request $request ) {

$dto = $repository->to_dto( $old_item );

$dto->set_status($request->get_param("status"));
$dto->set_status( $request->get_param( "status" ) );

$repository->update( $dto );

return rest_ensure_response( [
'message' => esc_html__("Status updated successfully", 'directorist')
] );
return rest_ensure_response(
[
'message' => esc_html__( "Status updated successfully", 'directorist' )
]
);
}

public function cancel( WP_REST_Request $request ) {
Expand Down Expand Up @@ -301,19 +424,84 @@ protected function index_args(): array {
'default' => 1,
'required' => false,
],
'perPage' => [
'perPage' => [
'description' => __( 'The number of items per page.', 'directorist' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'default' => 10,
'required' => false,
],
'search' => [
'per_page' => [
'description' => __( 'The number of items per page.', 'directorist' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'minimum' => 1,
'maximum' => 100,
'required' => false,
],
'search' => [
'description' => __( 'The search query.', 'directorist' ),
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
'required' => false,
],
];
}

/**
* Get arguments for user order creation.
*
* @return array
*/
protected function user_store_args(): array {
return [
'listing_id' => [
'description' => __( 'The listing ID.', 'directorist' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'required' => false,
],
'plan_id' => [
'description' => __( 'The pricing plan ID.', 'directorist' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'required' => false,
],
'amount' => [
'description' => __( 'The order amount.', 'directorist' ),
'type' => 'number',
'minimum' => 0,
'default' => 0,
'required' => false,
],
'currency' => [
'description' => __( 'The order currency.', 'directorist' ),
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
'required' => false,
],
'featured' => [
'description' => __( 'Whether the order is for a featured listing.', 'directorist' ),
'type' => 'boolean',
'default' => false,
'required' => false,
],
];
}

/**
* Wrap user order data with its provider type.
*
* @param mixed $data Order data.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function prepare_user_order_data( $data, WP_REST_Request $request ): array {
$response_data = [
'order_type' => 'directorist',
'data' => $data,
];

return apply_filters( 'directorist_rest_user_order_response_data', $response_data, $request );
}
}
Loading