customizeQuery( )


Registers a hook that is called after a route is resolved by the data binding router, but before the wix-data query is executed.

The customizeQuery hook is a data binding router hook that is triggered before the data query is executed for the pages in the specified router.

The customizeQuery() function is not a function that you call from your code. You define the function in a file named routers.js in the Code File's Backend section of the Velo Sidebar. The function is called as described above.

Use this hook to further refine or change the query that will determine what data is bound to your page's dataset. For example, you can filter the query to only return items that have a status field set to "active".

The function returns a WixDataQuery object. Typically the returned query is a modified version of the one the function received.

The customizeQuery() hook is triggered when using dynamic pages, but not when you code your own router.

Method Declaration
Copy
Method Parameters
requestWixRouterRequestRequired

The routing request.


routestringRequired

The resolved router URL pattern.


queryWixDataQueryRequired

The wix-data query.

Returns
Return Type:WixDataQuery
Was this helpful?
Yes
No