forked from WebberZone/better-search
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
174 lines (116 loc) · 8.53 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
=== Better Search ===
Tags: search, Better Search, related search, relevant search, search results, contextual search, heatmap, popular searches, top searches, relevance
Contributors: webberzone, Ajay
Donate link: https://ajaydsouza.com/donate/
Stable tag: trunk
Requires at least: 4.5
Tested up to: 5.1
License: GPLv2 or later
Better Search replaces the default WordPress search with a better search engine that gives contextual results sorted by relevance
== Description ==
[Better Search](https://webberzone.com/plugins/better-search/) replaces the default WordPress search engine with a more powerful search engine that gives search results relevant to the title and content of the post. This means that visitors to your blog will find what they are looking for quicker than if you didn't have **Better Search** installed.
Better Search can search through not just posts, but also pages and other custom post types. Let your visitors find what they are looking for.
The plugin is packed with options to allow you to easily customise the output. You can also fine tune the results by assigning a greater weight to either the title or the content. The default mode is a seamless integration with your WordPress theme. And, for power users, Better Search supports templates for that extra something.
And for even more advanced users, Better Search is packed with filters and actions that allow you to easily extend the plugin's feature set.
Additionally, the plugin also tracks the searches and you to display a "search heatmap" of the most popular searches. Support for WordPress widgets will allow you to easily add this heatmap to your theme's sidebar or footer.
= Features =
* **Automatic**: Once activated, Better Search will automatically replace your default WordPress search with more relevant search results
* **Seamless integration**: Search results are perfectly integrated into your theme without the need for custom search templates
* **Relevance**: Search results are automatically sorted by relevance. You can also turn off relevancy based searching, in which case, results are sorted by date
* **Control the results**: Fine tune the results by changing the weighting of post title and post content. Turn on BOOLEAN search to override the default NATURAL LANGUAGE search of mySQL
* **Popular searches**: Find out what visitors are searching for on your blog. Display a list of popular search terms (daily and overall) on your blog in the form of a heatmap. Widget support for easy integration in your theme as well as a shortcode [[bsearch_heatmap]]
* **Customisation**: Support for a template file for perfect integration into your blog template. Alternatively, just input your own CSS styles in the *Custom Styles* tab in the Settings Page. Check the FAQ for more information
* **Supports cache plugins**: Works with caching plugins like WP-Super-Cache and W3 Total Cache
* **Profanity filter**: Customise the list of stop words that will automatically be filtered out of search queries
* **Translation ready**: Better Search is translation ready
= Contribute =
Better Search is also available on [Github](https://github.com/WebberZone/better-search)
So, if you've got some cool feature that you'd like to implement into the plugin or a bug you've been able to fix, consider forking the project and sending me a pull request.
== Screenshots ==
1. Options in WP-Admin - General options
2. Options in WP-Admin - Search results options
3. Options in WP-Admin - Heatmap options
4. Options in WP-Admin - Custom styles
5. Options in WP-Admin - Tools
6. Better Search widget
== Installation ==
= WordPress install =
1. Navigate to Plugins within your WordPress Admin Area
2. Click "Add new" and in the search box enter "Better Search"
3. Find the plugin in the list (usually the first result) and click "Install Now"
= Manual install =
1. Download the plugin
2. Extract the contents of better-search.zip to wp-content/plugins/ folder. You should get a folder called better-search.
3. Activate the Plugin in WP-Admin.
4. Goto **Settings > Better Search** to configure
5. Goto **Appearance > Widgets** to add the Popular Searches sidebar widgets to your theme
6. Optionally visit the **Custom Styles** tab to add any custom CSS styles. These are added to `wp_head` on the pages where the posts are displayed
== Frequently Asked Questions ==
If your question isn't listed there, please create a new post in the [WordPress.org support forum](https://wordpress.org/support/plugin/better-search). I monitor the forums regularly. If you're looking for more advanced _paid_ support, please see [details here](https://webberzone.com/support/).
= Can I customize the output? =
Better Search has a huge set of options that help you customise the output or fine tune the results without leaving the comfort of your WordPress site. Goto **Settings > Better Search** to configure.
The plugin also supports the use of template files within your theme. You can create a file called `better-search-template.php` in your theme's directory and the plugin will use it to display the results.
= My search words are getting filtered or *How does the profanity filter work* =
Better Search includes a very cool profanity filter using the script from [Banbuilder](https://banbuilder.com/). You can customise which list of words you want to filter out from the Better Search settings page. Find the setting called "Filter these words:". The plugin will automatically strip out both partial and complete references of these words.
You can turn the filter off by emptying the list.
Know of a better profanity filter? Suggest one in the [forums](https://wordpress.org/support/plugin/better-search).
== Changelog ==
= 2.2.2 =
* Bug fixes:
* Phrase searches and searches with double quotes should now work properly
* Specified one instance of a missing table prefix to avoid conflicts
= 2.2.1 =
* Bug fixes:
* Fixed "Fatal error: Can't use function return value in write context"
* Specified table prefix to avoid conflicts
* Fixed code in Tools page for dropping index
= 2.2.0 =
* Features:
* New option to exclude password protected posts from the results
* New option to exclude post/page or custom post type IDs from the results
* Enhancements:
* Admin interface now uses the Settings API - Please double check your settings. You can delete the old settings using the Tools sub-menu
* New shortcode `bsearch_form` to display the Better Search custom search form
* Use `template_include` instead of `template_redirect`
* Seamless mode now uses Better Search queries directly instead of passing post IDs
* Deprecated:
* $bsearch_url, bsearch_default_options(), bsearch_read_options(), bsearch_clause_prepare()
= 2.1.1 =
* Bug fixes:
* Sanitisation doesn't strip out + and -
* Highlight works properly when using quotations, plus or minus
= 2.1.0 =
* Features:
* Cache enable/disable option + Clear cache button. Replaces "Delete transients"
* Search form widget. Find it under Appearances > Widgets or in the Customizer
* Heatmap search widget: Display the popular searches heatmap using `[bsearch_heatmap]`
* Enhancements:
* Query filters now work for the LIKE search as well
* New filter to override the censor character (currently a space) e.g. usage at https://gist.github.com/ajaydsouza/f23f35704431485c6922
* Banned terms will now filter the main search query and will no longer display the search term even in seamless mode
* Bug fixes:
* Highlighting now works when the search term has double or single quotes
= 2.0.1 =
* Bug fixes:
* Bug where highlighting search terms broke HTML in links
= 2.0.0 =
* Features:
* Network Activate and Deactivate the plugin on WordPress Multisite
* Option to highlight search results. If missing, add: <code>.bsearch_highlight { background:#ffc; }</code> under Custom Styles
* Fully filterable search query
* Recreate Index button in the settings page
* Delete transients button in the settings page
* Enhancements:
* Better Search will now try BOOLEAN MODE and non-FULLTEXT modes in case FULLTEXT search doesn't return any results
* Deprecated always dynamic heatmap option that bypassed cache
* Reorganised admin interface
* Seamless mode is now the default mode
* Better Search uses transients to catch results when not using seamless mode
* Search form uses `class` instead of `id`
* Bug fixes:
* Seamless mode would overwrite all queries, even those outside the loop
* WordPress widget settings
For previous changelog entries, please refer to the separate changelog.txt file
== Upgrade Notice ==
= 2.2.2 =
Bug fix release. For details on the update check the changelog and release post on https://webberzone.com