| 1 |
# About Custom Tables # |
| 2 |
|
| 3 |
Custom Tables (CT) is a WordPress developers toolkit to handle custom database table workflow similar to WordPress CPT. |
| 4 |
|
| 5 |
Check [](./example.phpexample.php](./example.php](./example.php) file included on this project to see a few examples to get it working. |
| 6 |
|
| 7 |
CT has been developed as internal library for [](https://gamipress.comGamiPress](https://gamipress.com](https://gamipress.com) plugin in order to bring to GamiPress's logs and user earnings tables the same features as WordPress post types (admin UI, cached query, rest API endpoints, etc). |
| 8 |
|
| 9 |
Important: CT public API is in development phase, this means current version is unstable and much of the current features will change. To use this library on live project be sure you know you are doing! |
| 10 |
|
| 11 |
Contributions are really appreciated! Looking for help to standarize functions and hooks as well as for documentation. |
| 12 |
|
| 13 |
## Features (work in progress) ## |
| 14 |
|
| 15 |
Custom table registration: |
| 16 |
|
| 17 |
- [x] Custom table registration (like registering a WordPress post type) |
| 18 |
- [x] Automatic table creation if not exists |
| 19 |
- [x] Easy field definition |
| 20 |
- [x] Schema parser |
| 21 |
- [x] Automatic schema updater (yay!) |
| 22 |
- [x] Database parameters (collate, engine, etc) |
| 23 |
- [x] Ability to show or hide from admin UI (disable UI for a desired table) |
| 24 |
- [x] Custom Capabilities (with support for administrators) |
| 25 |
- [x] Meta data functionality |
| 26 |
- [x] Query class to handled cached queries (like WP_Query but for custom tables) |
| 27 |
- [x] Rest API support (custom table and meta data) |
| 28 |
|
| 29 |
List view (with features similar to WP tables): |
| 30 |
|
| 31 |
- [x] Pagination |
| 32 |
- [x] Search |
| 33 |
- [x] Sortable Columns |
| 34 |
- [x] Bulk actions |
| 35 |
- [x] User screen settings |
| 36 |
- [x] List view views |
| 37 |
- [ ] Trash functionality? |
| 38 |
- [ ] Revisions functionality? |
| 39 |
- [x] Delete Permanently action |
| 40 |
|
| 41 |
Edit View (similar to WP edit screen): |
| 42 |
|
| 43 |
- [x] Meta boxes |
| 44 |
- [x] Screen options |
| 45 |
- [x] Show hide Meta boxes |
| 46 |
- [x] Allow user to toggle view columns |
| 47 |
- [x] Allow define edit view columns (to force to 1 column) |
| 48 |
- [x] Delete Permanently action |
| 49 |
|
| 50 |
Other features |
| 51 |
|
| 52 |
- [x] CMB2 support |
| 53 |
- [ ] Documentation (help wanted!) |
| 54 |
- [x] Add WP Lib Loader to always load the newest version (http://jtsternberg.github.io/wp-lib-loader/) |
| 55 |
|
| 56 |
## Plugins ## |
| 57 |
|
| 58 |
- [](https://github.com/rubengc/ct-ajax-list-tableAjax List Table](https://github.com/rubengc/ct-ajax-list-table](https://github.com/rubengc/ct-ajax-list-table): Utility to render a Custom Tables (CT) List Table with ajax searching and pagination. |
| 59 |
- [](https://github.com/rubengc/ct-rest-api-docsRest API Docs](https://github.com/rubengc/ct-rest-api-docs](https://github.com/rubengc/ct-rest-api-docs): Rest API docs generator for Custom Tables (CT). |
| 60 |
|
| 61 |
## Changelog ## |
| 62 |
|
| 63 |
**1.0.7** |
| 64 |
|
| 65 |
* **Bug Fixes** |
| 66 |
* Fixed PHP notices caused by add_submenu_page() function when passing null as first parameter. |
| 67 |
|
| 68 |
**1.0.6** |
| 69 |
|
| 70 |
**Improvements** |
| 71 |
* Added more nonce checks to prevent CSRF attacks. |
| 72 |
|
| 73 |
**1.0.5** |
| 74 |
|
| 75 |
**Improvements** |
| 76 |
* Added more nonce checks to prevent CSRF attacks. |
| 77 |
|
| 78 |
**1.0.4** |
| 79 |
|
| 80 |
**Improvements** |
| 81 |
* Reduced the number of "Show tables" queries. |
| 82 |
|
| 83 |
**1.0.3** |
| 84 |
|
| 85 |
**Improvements** |
| 86 |
- Added support for CMB2 fields data removal if field has "multiple" set to "true". |
| 87 |
|
| 88 |
**1.0.2** |
| 89 |
|
| 90 |
**Bug Fixes** |
| 91 |
- Make use of the min() function when defining length of the table keys (thanks to @mholubowski). |
| 92 |
|
| 93 |
**1.0.1** |
| 94 |
|
| 95 |
**Improvements** |
| 96 |
- Prevent to add index length for DATETIME fields (thanks to @mholubowski, fixes #9). |
| 97 |
- Quote all fields and indexes during database creation. |
| 98 |
|
| 99 |
**1.0.0** |
| 100 |
Initial release. |
