keith/WP_Content_Filter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📄 docs: Update readme

Browse Source
This commit is contained in:
Keith Solomon
2025-02-10 08:38:46 -06:00
parent 5e16527411
commit 7df13f7dbd
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -4,19 +4,26 @@
The Content Filter Plugin adds filtering capabilities for any registered post type by any taxonomies attched to it. This plugin provides a shortcode to display a filter form and dynamically updates the resource results based on the selected filters.
## Installation
1. Download the plugin files and place them in the `wp-content/plugins/resource-filter` directory.
1. Clone this repo or download the plugin files and place them in the `wp-content/plugins/resource-filter` directory.
2. Activate the plugin through the 'Plugins' menu in WordPress.
## Usage
1. Add the `[resource_filter]` shortcode to any post or page where you want to display the resource filter form.
2. The filter form will allow users to search and filter resources by type and subject.
2. For the secondary search form, add the `[resource_filter type="homepage"]` shortcode to any post or page where you want to display the secondary search form.
3. The filter form will allow users to search and filter resources by type, subject and text searching.
## Template Override
To override the default form and results templates, create a `resource-filter` directory in your theme and copy the `filter-form.php` and `resource-results.php` files from the plugin `templates` directory to your theme directory. The plugin will use the template files in your theme directory instead of the default template files.
To override the default form and results templates, copy the contents of the plugin `templates` directory to the `resource-filter` directory in your theme. The plugin will use the template files in your theme directory instead of the default plugin versions.
### Template Files
- `filter-form.php` - Main form template
- `filter-homepage.php` - Secondary form template for the homepage or other uses
- `filter-summary.php` - Templae for the summary of the number of resources and applied filters
- `resource-results.php` - Template for the search results
## Changelog
### 1.2.0 - 2025-02-05
- Name change to reflect ability to filter more than 'resources'
- Name change to reflect future ability to filter any content, not just `resources`
- Add secondary search template
### 1.1.0 - 2025-02-05