✨feature: Live filtering for type and subjuect fields
This commit is contained in:
28
README.md
28
README.md
@@ -1,9 +1,11 @@
|
||||
# Content Filter Plugin
|
||||
|
||||
## Brief Description
|
||||
|
||||
The Content Filter Plugin is a WordPress plugin designed to enhance content discoverability by allowing users to filter resources based on custom taxonomies such as resource type and subject. It provides a user-friendly interface for filtering and sorting resources, making it easier for visitors to find the content they need.
|
||||
|
||||
## Features
|
||||
|
||||
- **Customizable Filter Form**: Allows filtering by resource type, subject, and search terms.
|
||||
- **AJAX-Powered Filtering**: Provides a seamless user experience with instant filtering without page reloads.
|
||||
- **Responsive Design**: Ensures the filter form and results look great on all devices.
|
||||
@@ -12,23 +14,29 @@ The Content Filter Plugin is a WordPress plugin designed to enhance content disc
|
||||
- **Summary Display**: Shows the number of resources and applied filters dynamically.
|
||||
|
||||
## Installation
|
||||
|
||||
1. Clone this repo or download the plugin files and place them in the `wp-content/plugins/resource-filter` directory.
|
||||
2. Log in to your WordPress admin dashboard.
|
||||
3. Navigate to **Plugins** > **Installed Plugins**.
|
||||
4. Activate the **Content Filter** plugin.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the plugin, add the `[resource_filter]` shortcode to any page or post where you want the filter form to appear. The plugin supports two types of forms:
|
||||
|
||||
- **Default Form**: Use `[resource_filter]` for the full filter form with search, resource type, and subject filters.
|
||||
- **Homepage/Secondary Form**: Use `[resource_filter type="homepage"]` for a simplified form suitable for the homepage.
|
||||
|
||||
### Example
|
||||
|
||||
Add one of the following shortcodes to your page or post content where you want the filter form to appear:
|
||||
|
||||
`[resource_filter]` or `[resource_filter type="homepage"]`
|
||||
|
||||
## Configuration
|
||||
|
||||
The plugin is designed to work out of the box with minimal configuration. However, you can customize the following:
|
||||
|
||||
- **Templates**: Override the default templates and styles by placing your custom versions in your theme's `resource-filter` directory. You will need to add `"./resource-filter/**/*.{php,vue,js,cjs}",` to the `content` object in your `tailwind-config.js` file to compile the custom styles.
|
||||
- **Template Files**:
|
||||
- `filter-form.php` - Main form template
|
||||
@@ -40,6 +48,7 @@ The plugin is designed to work out of the box with minimal configuration. Howeve
|
||||
- **Taxonomies**: Ensure your WordPress site has the `resource_type` and `resource_subject` taxonomies set up for the `resource` post type.
|
||||
|
||||
## Roadmap
|
||||
|
||||
- ~~Repo updates~~
|
||||
- ~~Admin configuration page~~
|
||||
- ~~tag close functionality~~
|
||||
@@ -47,40 +56,59 @@ The plugin is designed to work out of the box with minimal configuration. Howeve
|
||||
- ~~pagination~~
|
||||
|
||||
## Changelog
|
||||
|
||||
### 1.5.3 - 2025-02-28
|
||||
|
||||
- Live filtering for type and subject
|
||||
|
||||
### 1.5.2 - 2025-02-13
|
||||
|
||||
- Bugfix for repo update feature
|
||||
|
||||
### 1.5.1 - 2025-02-13
|
||||
|
||||
- Fixed bug in filter removal functionality
|
||||
|
||||
### 1.5.0 - 2025-02-13
|
||||
|
||||
- Added repo update feature
|
||||
|
||||
### 1.4.0 - 2025-02-13
|
||||
|
||||
- Added admin configuration page
|
||||
|
||||
### 1.3.0 - 2025-02-12
|
||||
|
||||
- Feature-complete for initial release
|
||||
- Add pagination
|
||||
- Add general reset button
|
||||
- Add tag close functionality
|
||||
|
||||
### 1.2.0 - 2025-02-05
|
||||
|
||||
- Name change to reflect future ability to filter any content, not just `resources`
|
||||
- Add secondary search template
|
||||
|
||||
### 1.1.0 - 2025-02-05
|
||||
|
||||
- Fully templated for use in any theme
|
||||
- Added result sorting
|
||||
|
||||
### 1.0.0 - 2025-02-04
|
||||
|
||||
- Initial release
|
||||
|
||||
## License
|
||||
|
||||
This plugin is licensed under the GNU General Public License v2 or later. See the [LICENSE](LICENSE) file for more details.
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
- **Author**: Keith Solomon
|
||||
- **Contributors**: Open to contributions from the community.
|
||||
|
||||
## Contribution Guidelines
|
||||
|
||||
We welcome contributions! If you'd like to contribute to the Content Filter Plugin, please follow these steps:
|
||||
|
||||
1. Fork the repository.
|
||||
|
||||
Reference in New Issue
Block a user