| 1 |
=== Posts Table with Search & Sort === |
| 2 |
Contributors: andykeith, barn2media |
| 3 |
Donate link: https://barn2.co.uk |
| 4 |
Tags: posts, table, tables, shortcode, search, sort, wpml |
| 5 |
Requires at least: 3.0.1 |
| 6 |
Tested up to: 4.9.6 |
| 7 |
Stable tag: 1.1.3 |
| 8 |
License: GPLv2 or later |
| 9 |
License URI: http://www.gnu.org/licenses/gpl-2.0.html |
| 10 |
|
| 11 |
A simple plugin to display all your posts in a searchable and sortable table or list. |
| 12 |
|
| 13 |
== Description == |
| 14 |
|
| 15 |
Posts Table with Search & Sort provides an easy way to list all of your site's posts in a searchable and sortable data table. |
| 16 |
Simply add the shortcode `[posts_data_table]` to any page. |
| 17 |
|
| 18 |
It uses the [jQuery DataTables](http://datatables.net/) plugin to provide the searching and sorting features, as well as pagination and |
| 19 |
responsive layouts for smaller screens. |
| 20 |
|
| 21 |
> **[Posts Table Pro](https://barn2.co.uk/wordpress-plugins/posts-table-pro/) now available, with lots more features including:** |
| 22 |
> |
| 23 |
> * Support for for pages and custom post types (e.g. courses, products, staff, music, books, etc) |
| 24 |
> * Featured images |
| 25 |
> * Custom taxonomies, terms and posts tags |
| 26 |
> * Custom fields & support for Advanced Custom Fields |
| 27 |
> |
| 28 |
> **[WooCommerce Product Table](https://barn2.co.uk/wordpress-plugins/woocommerce-product-table/) now available - create tables of products from your WooCommerce store:** |
| 29 |
> |
| 30 |
> * Include Add to Cart buttons, quantity, price, reviews, stock level, categories, tags, weight, dimensions, and more! |
| 31 |
|
| 32 |
Translations currently provided for French, Spanish and German (more to follow). |
| 33 |
|
| 34 |
It's compatible with WPML which means that, if you're using this, posts will be shown for the current language only. |
| 35 |
|
| 36 |
There are a few options available with the shortcode: |
| 37 |
|
| 38 |
* `columns` - the columns you'd like to show in your table. This can be any of the following columns, given as a comma-separated list: |
| 39 |
id, title, content, category, tags, author, and date. Defaults to 'title,content,date,author,category' |
| 40 |
* `rows_per_page` - the number of posts to show on each page of results in the table. Set to 'false' to disable pagination. Defaults to 20 rows. |
| 41 |
* `category` - restrict the table to this category only. Use the category ID or 'slug' here, NOT the name of the category. You can find the slug from the |
| 42 |
Posts -> Categories menu in the WordPress admin. |
| 43 |
* `tag` - restrict the table to this tag only. Use the tag 'slug' or ID here. You can find the slug from the Posts -> Tags menu. |
| 44 |
* `author` - restrict the posts in the table to the specified author. Use can use author name (user_nicename), author ID or a comma-separated list of IDs. |
| 45 |
* `post_status` - display posts with this post status (draft, pending, publish, future, private or any). Defaults to 'publish'. |
| 46 |
* `sort_by` - the column to sort by. Defaults to 'date'. If the column you want to sort by isn't shown in the table, it will be added as a hidden column. |
| 47 |
This means, for example, that you can sort by date without actually showing the date column. |
| 48 |
* `sort_order` - whether to sort ascending ('asc') or descending ('desc'). If you order by date, it will default to 'desc' (newest posts first). |
| 49 |
* `search_on_click` - whether to enable automatic searching for categories and authors when clicking on links in the table. Default: true |
| 50 |
* `wrap` - whether the table content wraps onto more than one line. Set to 'false' to keep everything on one line or 'true' to allow the content to wrap. Default: true |
| 51 |
* `content_length` - the number of words of post content to show in the table (if you've included the 'content' column). Defaults to 15 words. |
| 52 |
* `scroll_offset` - advanced: the table scrolls back to the top each time you navigate forward or backwards through the list of posts. This |
| 53 |
value controls the 'offset' for the scroll. For example, if your site uses a sticky header you can adjust the scroll amount here to compensate. |
| 54 |
Enter a whole number (e.g. 50) or set to 'false' to disable scrolling to top. |
| 55 |
|
| 56 |
### Examples |
| 57 |
|
| 58 |
The following will list your posts in a table with 3 columns (title, content and date columns) showing the first 10 words of each post in the content column: |
| 59 |
|
| 60 |
`[posts_data_table columns='title,content,date' content_length="10"]` |
| 61 |
|
| 62 |
The following will list posts with 4 columns (ID, title, tags, and author columns), and will be sorted by date in ascending order (oldest posts first): |
| 63 |
|
| 64 |
`[posts_data_table columns='id,title,tags,author' sort_by="date" sort_order="asc"]` |
| 65 |
|
| 66 |
### Demo |
| 67 |
|
| 68 |
Please see [the demo](https://barn2.co.uk/posts-table/) for examples of the plugin in action. |
| 69 |
|
| 70 |
== Installation == |
| 71 |
|
| 72 |
1. Upload the plugin files to the `/wp-content/plugins/posts-data-table` directory, or install the plugin through the WordPress plugins screen directly. |
| 73 |
1. Activate the plugin through the 'Plugins' screen in WordPress |
| 74 |
1. Add the shortcode `[posts_data_table]` to any page |
| 75 |
|
| 76 |
== Frequently Asked Questions == |
| 77 |
|
| 78 |
= How do I display the posts table? = |
| 79 |
Simply add the shortcode `[posts_data_table]` to any page. |
| 80 |
|
| 81 |
= Does it show all posts or can I restrict it to a certain category? = |
| 82 |
By default it will list all of your posts, but you can use the 'category' option in the shortcode to restrict the table to that category only. |
| 83 |
|
| 84 |
= What are the shortcode options? = |
| 85 |
See the main [plugin description](https://wordpress.org/plugins/posts-data-table/) for the list of options. |
| 86 |
|
| 87 |
= Can I see a demo of the plugin? = |
| 88 |
Yes, please visit https://barn2.co.uk/posts-table/ to see the posts table in action. |
| 89 |
|
| 90 |
= Will the posts table work with my theme? = |
| 91 |
The plugin has been designed to work with different WordPress themes and will take the styling from your theme for the fonts etc. where possible. |
| 92 |
If any parts don't match your site as well as you would like, you can restyle it using CSS or [contact us](https://barn2.co.uk/contact-a-wordpress-designer/) |
| 93 |
about our customization service. |
| 94 |
|
| 95 |
= Does the posts table work with custom post types? = |
| 96 |
No, it only displays standard Posts at the moment. Our [Pro Version](https://barn2.co.uk/wordpress-plugins/posts-table-pro/) supports custom post types, as well |
| 97 |
as taxonomies, custom fields, and much more. |
| 98 |
|
| 99 |
= Can I change the width of the columns? = |
| 100 |
The column widths are calculated automatically by the plugin, based on the contents of each column. However you can override this for one (or more) columns |
| 101 |
by setting an exact width. You would need to add some code to your theme (or in a custom plugin) to do this. The filter to hook into is 'posts_data_table_column_default'. |
| 102 |
Here's an example setting the title column to 80px; |
| 103 |
|
| 104 |
` |
| 105 |
add_filter( 'posts_data_table_column_defaults', 'pdt_change_posts_table_defaults' ); |
| 106 |
|
| 107 |
function change_posts_table_defaults( $column_defaults ) { |
| 108 |
$column_defaults['title']['width'] = '80px'; |
| 109 |
return $column_defaults; |
| 110 |
} |
| 111 |
` |
| 112 |
|
| 113 |
Bear in mind that the plugin might still override your column width if there isn't enough room for the data it contains, or the rest of the columns in the table. |
| 114 |
|
| 115 |
= Does it work on mobiles/tablets? = |
| 116 |
Yes, the table will automatically adapt to fit different screen sizes. If your table has too many columns to fit on smaller screens then a '+' icon will |
| 117 |
appear alongside each post, allowing you to click to view the hidden columns. |
| 118 |
|
| 119 |
= When I click to the next page on my posts list, I can't see the top of the table = |
| 120 |
This is probably because you have a sticky header (your header sticks to the top of the screen when you scroll down). This means it's covering the |
| 121 |
top of your posts table. You can add a 'scroll offset' to push the table down to prevent this from happening. For example, if your sticky header |
| 122 |
is 50 pixels high then use `[posts_data_table scroll_offset="50"]` |
| 123 |
|
| 124 |
= How do I use the posts table with WPML? = |
| 125 |
If you have a multilingual site using WPML then the plugin will display your posts in the correct language automatically. |
| 126 |
|
| 127 |
= Can you customize the plugin for me? = |
| 128 |
We have developed this free plugin to be flexible and easy to configure so that it will be suitable for many different websites. If you would |
| 129 |
like us to modify the plugin to suit your exact requirements, please [contact us](https://barn2.co.uk/contact-a-wordpress-designer/) with the |
| 130 |
details and we'll be happy to provide a quote. |
| 131 |
|
| 132 |
== Screenshots == |
| 133 |
|
| 134 |
1. Posts sorted by date and with wrapping disabled. Categories are collapsed automatically to fit data on single line. |
| 135 |
2. Different column order and with wrapping enabled (default). |
| 136 |
3. Filtered by post author and sorted alphabetically by title (ascending). |
| 137 |
|
| 138 |
== Changelog == |
| 139 |
|
| 140 |
= 1.1.3 = |
| 141 |
21 May 2018 |
| 142 |
|
| 143 |
* Updated DataTables to 1.10.16. |
| 144 |
* Tested with WordPress 4.9.6. |
| 145 |
* Added 'posts_data_table_html_output' filter. |
| 146 |
|
| 147 |
= 1.1.2 = |
| 148 |
17 March 2018 |
| 149 |
|
| 150 |
* Added 'author' and 'post_status' shortcode options. |
| 151 |
* Added 'posts_data_table_query_args' and 'posts_data_table_row_data_format' filters. |
| 152 |
* Tested with WordPress 4.9.4 |
| 153 |
|
| 154 |
= 1.1.1 = |
| 155 |
19 January 2018 |
| 156 |
|
| 157 |
* Tested with WordPress 4.9.2 |
| 158 |
* Minor styling tweaks. |
| 159 |
|
| 160 |
= 1.1 = |
| 161 |
7 September 2017 |
| 162 |
|
| 163 |
* Added support for a new 'tags' column, to display the post tags in the table. |
| 164 |
* Added a new shortcode option 'tag' to allow posts to be restricted by tag. |
| 165 |
* Added a 'date_format' shortcode option to allow the date format to be set. See [PHP date formats](http://php.net/manual/en/function.date.php) for examples. |
| 166 |
* Category can now be specified by ID or slug, depending on whether a numeric or text value is specified. |
| 167 |
* Fix bug with sort_by option when column not present in table. |
| 168 |
* Code restructure and improvement. |
| 169 |
* Update DataTables library to 1.10.15. |
| 170 |
|
| 171 |
= 1.0.6 = |
| 172 |
* Added Greek translation (credit: Yofis Florentin) |
| 173 |
* Added additional language locales for French/German |
| 174 |
|
| 175 |
= 1.0.5 = |
| 176 |
* Upgrade to DataTables 1.10.12 |
| 177 |
* Allow column default (priorities, widths, etc) to be set per table. |
| 178 |
* Prevent conflict if both free and Pro version of plugin are activated. |
| 179 |
|
| 180 |
= 1.0.4 = |
| 181 |
Fix bug with localization of main javascript file. |
| 182 |
|
| 183 |
= 1.0.3 = |
| 184 |
Fix a bug with the search and replace of column data, which produced invalid post URLs in some instances. |
| 185 |
|
| 186 |
= 1.0.2 = |
| 187 |
Added 'category' option to allow table to show posts from a single category only. |
| 188 |
|
| 189 |
= 1.0.1 = |
| 190 |
* Changed default for 'wrap' so content will now wrap onto multiple lines by default. |
| 191 |
* Changed default conent length to 15 words. |
| 192 |
* Additional FAQs. |
| 193 |
|
| 194 |
= 1.0 = |
| 195 |
Initial release. |
| 196 |
|
| 197 |
|
| 198 |
|
