feat: add query parameter support

Author: HardeepAsrani

README.md

@@ -14,13 +14,15 @@ This plugin extends the YOURLS API by adding a `list` action with advanced capab
 - Sorting by keyword, URL, title, timestamp, IP address, or clicks.
 - Pagination using offset and limit (per page).
 - Custom selection of fields to be returned in the API response.
+- Searching by keyword.
 - Total count of links to assist with pagination.
 
 ## Features
 
 - **Sorting**: Sort results by any valid field (`keyword`, `url`, `title`, `timestamp`, `ip`, `clicks`).
 - **Pagination**: Use the `offset` and `perpage` parameters to paginate results.
 - **Field Selection**: Select specific fields to return (e.g., `keyword`, `url`, `clicks`). By default, all fields are returned.
+- **Search**: Search for links by keyword.
 - **Total Count**: Returns the total number of links in the database, useful for pagination.
 
 ## Installation
@@ -52,6 +54,7 @@ http://<your-yourls-site>/yourls-api.php
 - `sortorder`: Sort order, either `ASC` (ascending) or `DESC` (descending). Default is `DESC`.
 - `offset`: Number of links to skip (used for pagination). Default is `0`.
 - `perpage`: Number of links to return per page. Default is `50`.
+- `query`: Search query to filter results by keyword.
 - `fields[]`: An array of fields to return (e.g., `fields[]=keyword&fields[]=url`). Default is all fields (`*`).
 
 ### Example Request
@@ -92,6 +95,7 @@ This example retrieves the first 10 results, sorted by clicks in ascending order
 | `sortorder`| string | Sort order, `ASC` for ascending, `DESC` for descending.                      | `DESC`        |
 | `offset`   | int    | Offset for pagination, number of links to skip.                             | `0`           |
 | `perpage`  | int    | Number of links to return per page.                                          | `50`          |
+| `query`    | string | Search query to filter results by keyword.                                  |               |
 | `fields[]` | array  | Fields to return in the response. Use array format: `fields[]=keyword`.      | `*` (all)     |
 
 ## License

plugin.php

@@ -26,6 +26,7 @@ function ti_list_function() {
 	$offset     = isset( $_REQUEST['offset'] ) && is_numeric( $_REQUEST['offset'] ) ? (int)$_REQUEST['offset'] : 0;
 	$perpage    = isset( $_REQUEST['perpage'] ) && is_numeric( $_REQUEST['perpage'] ) ? (int)$_REQUEST['perpage'] : 50;
 	$fields     = isset( $_REQUEST['fields'] ) && is_array( $_REQUEST['fields'] ) ? $_REQUEST['fields'] : [ '*' ];
+	$query      = isset( $_REQUEST['query'] ) ? $_REQUEST['query'] : '';
 
 	// Validate fields to ensure the query won't break if an invalid field is requested.
 	$valid_fields    = [ 'keyword', 'url', 'title', 'timestamp', 'ip', 'clicks' ];
@@ -34,7 +35,8 @@ function ti_list_function() {
 
 	// Get total number of links.
 	$total   = yourls_get_db()->fetchValue( "SELECT COUNT(*) FROM `$table`" );
-	$query   = "SELECT $selected_fields FROM `$table` ORDER BY `$sort_by` $sort_order LIMIT $offset, $perpage";
+	$where   = $query ? "WHERE `keyword` LIKE '%$query%'" : ''; // If you have millions of links, this query can be slow. You can replace LIKE with = if you want exact match.
+	$query   = "SELECT $selected_fields FROM `$table` $where ORDER BY `$sort_by` $sort_order LIMIT $offset, $perpage";
 	$results = yourls_get_db()->fetchObjects( $query );
 
 	// Return the response with results and total count.