Package io.github.evisentin.wordpress.rest.client.domain.api

Interface SearchAPIs

All Known Implementing Classes:
SearchApiClientModule
public interface SearchAPIs
Defines operations for searching resources through the WordPress REST API.

This interface provides access to the WordPress search endpoint, allowing clients to search across supported resource types such as posts, terms, and post formats.

Search results can be refined using pagination and filtering criteria provided by WpSearchQuery.

Implementations are expected to communicate with the /wp-json/wp/v2/search endpoint or compatible APIs.

  • Method Details

    • search

      WpPagedResponse<WpSearchResult> search(WpPaginationQuery paginationQuery, WpSearchQuery query)
      Performs a search using the supplied pagination and filtering criteria.

      The query supports filtering by search term, resource type, included or excluded identifiers, and subtype.

      Parameters:
      paginationQuery - the pagination settings, including page number and page size; must not be null
      query - additional search criteria; may be null when only pagination is required
      Returns:
      a paginated response containing matching WpSearchResult items