├── LICENSE.txt ├── custom-list-table-db-example.php └── readme.txt /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /custom-list-table-db-example.php: -------------------------------------------------------------------------------- 1 | prefix . 'cte'; // do not forget about tables prefix 60 | 61 | // sql to create your table 62 | // NOTICE that: 63 | // 1. each field MUST be in separate line 64 | // 2. There must be two spaces between PRIMARY KEY and its name 65 | // Like this: PRIMARY KEY[space][space](id) 66 | // otherwise dbDelta will not work 67 | $sql = "CREATE TABLE " . $table_name . " ( 68 | id int(11) NOT NULL AUTO_INCREMENT, 69 | name tinytext NOT NULL, 70 | email VARCHAR(100) NOT NULL, 71 | age int(11) NULL, 72 | PRIMARY KEY (id) 73 | );"; 74 | 75 | // we do not execute sql directly 76 | // we are calling dbDelta which cant migrate database 77 | require_once(ABSPATH . 'wp-admin/includes/upgrade.php'); 78 | dbDelta($sql); 79 | 80 | // save current database version for later use (on upgrade) 81 | add_option('cltd_example_db_version', $cltd_example_db_version); 82 | 83 | /** 84 | * [OPTIONAL] Example of updating to 1.1 version 85 | * 86 | * If you develop new version of plugin 87 | * just increment $cltd_example_db_version variable 88 | * and add following block of code 89 | * 90 | * must be repeated for each new version 91 | * in version 1.1 we change email field 92 | * to contain 200 chars rather 100 in version 1.0 93 | * and again we are not executing sql 94 | * we are using dbDelta to migrate table changes 95 | */ 96 | $installed_ver = get_option('cltd_example_db_version'); 97 | if ($installed_ver != $cltd_example_db_version) { 98 | $sql = "CREATE TABLE " . $table_name . " ( 99 | id int(11) NOT NULL AUTO_INCREMENT, 100 | name tinytext NOT NULL, 101 | email VARCHAR(200) NOT NULL, 102 | age int(11) NULL, 103 | PRIMARY KEY (id) 104 | );"; 105 | 106 | require_once(ABSPATH . 'wp-admin/includes/upgrade.php'); 107 | dbDelta($sql); 108 | 109 | // notice that we are updating option, rather than adding it 110 | update_option('cltd_example_db_version', $cltd_example_db_version); 111 | } 112 | } 113 | 114 | register_activation_hook(__FILE__, 'cltd_example_install'); 115 | 116 | /** 117 | * register_activation_hook implementation 118 | * 119 | * [OPTIONAL] 120 | * additional implementation of register_activation_hook 121 | * to insert some dummy data 122 | */ 123 | function cltd_example_install_data() 124 | { 125 | global $wpdb; 126 | 127 | $table_name = $wpdb->prefix . 'cte'; // do not forget about tables prefix 128 | 129 | $wpdb->insert($table_name, array( 130 | 'name' => 'Alex', 131 | 'email' => 'alex@example.com', 132 | 'age' => 25 133 | )); 134 | $wpdb->insert($table_name, array( 135 | 'name' => 'Maria', 136 | 'email' => 'maria@example.com', 137 | 'age' => 22 138 | )); 139 | } 140 | 141 | register_activation_hook(__FILE__, 'cltd_example_install_data'); 142 | 143 | /** 144 | * Trick to update plugin database, see docs 145 | */ 146 | function cltd_example_update_db_check() 147 | { 148 | global $cltd_example_db_version; 149 | if (get_site_option('cltd_example_db_version') != $cltd_example_db_version) { 150 | cltd_example_install(); 151 | } 152 | } 153 | 154 | add_action('plugins_loaded', 'cltd_example_update_db_check'); 155 | 156 | /** 157 | * PART 2. Defining Custom Table List 158 | * ============================================================================ 159 | * 160 | * In this part you are going to define custom table list class, 161 | * that will display your database records in nice looking table 162 | * 163 | * http://codex.wordpress.org/Class_Reference/WP_List_Table 164 | * http://wordpress.org/extend/plugins/custom-list-table-example/ 165 | */ 166 | 167 | if (!class_exists('WP_List_Table')) { 168 | require_once(ABSPATH . 'wp-admin/includes/class-wp-list-table.php'); 169 | } 170 | 171 | /** 172 | * Custom_Table_Example_List_Table class that will display our custom table 173 | * records in nice table 174 | */ 175 | class Custom_Table_Example_List_Table extends WP_List_Table 176 | { 177 | /** 178 | * [REQUIRED] You must declare constructor and give some basic params 179 | */ 180 | function __construct() 181 | { 182 | global $status, $page; 183 | 184 | parent::__construct(array( 185 | 'singular' => 'person', 186 | 'plural' => 'persons', 187 | )); 188 | } 189 | 190 | /** 191 | * [REQUIRED] this is a default column renderer 192 | * 193 | * @param $item - row (key, value array) 194 | * @param $column_name - string (key) 195 | * @return HTML 196 | */ 197 | function column_default($item, $column_name) 198 | { 199 | return $item[$column_name]; 200 | } 201 | 202 | /** 203 | * [OPTIONAL] this is example, how to render specific column 204 | * 205 | * method name must be like this: "column_[column_name]" 206 | * 207 | * @param $item - row (key, value array) 208 | * @return HTML 209 | */ 210 | function column_age($item) 211 | { 212 | return '' . $item['age'] . ''; 213 | } 214 | 215 | /** 216 | * [OPTIONAL] this is example, how to render column with actions, 217 | * when you hover row "Edit | Delete" links showed 218 | * 219 | * @param $item - row (key, value array) 220 | * @return HTML 221 | */ 222 | function column_name($item) 223 | { 224 | // links going to /admin.php?page=[your_plugin_page][&other_params] 225 | // notice how we used $_REQUEST['page'], so action will be done on curren page 226 | // also notice how we use $this->_args['singular'] so in this example it will 227 | // be something like &person=2 228 | $actions = array( 229 | 'edit' => sprintf('%s', $item['id'], __('Edit', 'cltd_example')), 230 | 'delete' => sprintf('%s', $_REQUEST['page'], $item['id'], __('Delete', 'cltd_example')), 231 | ); 232 | 233 | return sprintf('%s %s', 234 | $item['name'], 235 | $this->row_actions($actions) 236 | ); 237 | } 238 | 239 | /** 240 | * [REQUIRED] this is how checkbox column renders 241 | * 242 | * @param $item - row (key, value array) 243 | * @return HTML 244 | */ 245 | function column_cb($item) 246 | { 247 | return sprintf( 248 | '', 249 | $item['id'] 250 | ); 251 | } 252 | 253 | /** 254 | * [REQUIRED] This method return columns to display in table 255 | * you can skip columns that you do not want to show 256 | * like content, or description 257 | * 258 | * @return array 259 | */ 260 | function get_columns() 261 | { 262 | $columns = array( 263 | 'cb' => '', //Render a checkbox instead of text 264 | 'name' => __('Name', 'cltd_example'), 265 | 'email' => __('E-Mail', 'cltd_example'), 266 | 'age' => __('Age', 'cltd_example'), 267 | ); 268 | return $columns; 269 | } 270 | 271 | /** 272 | * [OPTIONAL] This method return columns that may be used to sort table 273 | * all strings in array - is column names 274 | * notice that true on name column means that its default sort 275 | * 276 | * @return array 277 | */ 278 | function get_sortable_columns() 279 | { 280 | $sortable_columns = array( 281 | 'name' => array('name', true), 282 | 'email' => array('email', false), 283 | 'age' => array('age', false), 284 | ); 285 | return $sortable_columns; 286 | } 287 | 288 | /** 289 | * [OPTIONAL] Return array of bult actions if has any 290 | * 291 | * @return array 292 | */ 293 | function get_bulk_actions() 294 | { 295 | $actions = array( 296 | 'delete' => 'Delete' 297 | ); 298 | return $actions; 299 | } 300 | 301 | /** 302 | * [OPTIONAL] This method processes bulk actions 303 | * it can be outside of class 304 | * it can not use wp_redirect coz there is output already 305 | * in this example we are processing delete action 306 | * message about successful deletion will be shown on page in next part 307 | */ 308 | function process_bulk_action() 309 | { 310 | global $wpdb; 311 | $table_name = $wpdb->prefix . 'cte'; // do not forget about tables prefix 312 | 313 | if ('delete' === $this->current_action()) { 314 | $ids = isset($_REQUEST['id']) ? $_REQUEST['id'] : array(); 315 | if (is_array($ids)) $ids = implode(',', $ids); 316 | 317 | if (!empty($ids)) { 318 | $wpdb->query("DELETE FROM $table_name WHERE id IN($ids)"); 319 | } 320 | } 321 | } 322 | 323 | /** 324 | * [REQUIRED] This is the most important method 325 | * 326 | * It will get rows from database and prepare them to be showed in table 327 | */ 328 | function prepare_items() 329 | { 330 | global $wpdb; 331 | $table_name = $wpdb->prefix . 'cte'; // do not forget about tables prefix 332 | 333 | $per_page = 5; // constant, how much records will be shown per page 334 | 335 | $columns = $this->get_columns(); 336 | $hidden = array(); 337 | $sortable = $this->get_sortable_columns(); 338 | 339 | // here we configure table headers, defined in our methods 340 | $this->_column_headers = array($columns, $hidden, $sortable); 341 | 342 | // [OPTIONAL] process bulk action if any 343 | $this->process_bulk_action(); 344 | 345 | // will be used in pagination settings 346 | $total_items = $wpdb->get_var("SELECT COUNT(id) FROM $table_name"); 347 | 348 | // prepare query params, as usual current page, order by and order direction 349 | $paged = isset($_REQUEST['paged']) ? max(0, intval($_REQUEST['paged'] - 1) * $per_page) : 0; 350 | $orderby = (isset($_REQUEST['orderby']) && in_array($_REQUEST['orderby'], array_keys($this->get_sortable_columns()))) ? $_REQUEST['orderby'] : 'name'; 351 | $order = (isset($_REQUEST['order']) && in_array($_REQUEST['order'], array('asc', 'desc'))) ? $_REQUEST['order'] : 'asc'; 352 | 353 | // [REQUIRED] define $items array 354 | // notice that last argument is ARRAY_A, so we will retrieve array 355 | $this->items = $wpdb->get_results($wpdb->prepare("SELECT * FROM $table_name ORDER BY $orderby $order LIMIT %d OFFSET %d", $per_page, $paged), ARRAY_A); 356 | 357 | // [REQUIRED] configure pagination 358 | $this->set_pagination_args(array( 359 | 'total_items' => $total_items, // total items defined above 360 | 'per_page' => $per_page, // per page constant defined at top of method 361 | 'total_pages' => ceil($total_items / $per_page) // calculate pages count 362 | )); 363 | } 364 | } 365 | 366 | /** 367 | * PART 3. Admin page 368 | * ============================================================================ 369 | * 370 | * In this part you are going to add admin page for custom table 371 | * 372 | * http://codex.wordpress.org/Administration_Menus 373 | */ 374 | 375 | /** 376 | * admin_menu hook implementation, will add pages to list persons and to add new one 377 | */ 378 | function cltd_example_admin_menu() 379 | { 380 | add_menu_page(__('Persons', 'cltd_example'), __('Persons', 'cltd_example'), 'activate_plugins', 'persons', 'cltd_example_persons_page_handler'); 381 | add_submenu_page('persons', __('Persons', 'cltd_example'), __('Persons', 'cltd_example'), 'activate_plugins', 'persons', 'cltd_example_persons_page_handler'); 382 | // add new will be described in next part 383 | add_submenu_page('persons', __('Add new', 'cltd_example'), __('Add new', 'cltd_example'), 'activate_plugins', 'persons_form', 'cltd_example_persons_form_page_handler'); 384 | } 385 | 386 | add_action('admin_menu', 'cltd_example_admin_menu'); 387 | 388 | /** 389 | * List page handler 390 | * 391 | * This function renders our custom table 392 | * Notice how we display message about successfull deletion 393 | * Actualy this is very easy, and you can add as many features 394 | * as you want. 395 | * 396 | * Look into /wp-admin/includes/class-wp-*-list-table.php for examples 397 | */ 398 | function cltd_example_persons_page_handler() 399 | { 400 | global $wpdb; 401 | 402 | $table = new Custom_Table_Example_List_Table(); 403 | $table->prepare_items(); 404 | 405 | $message = ''; 406 | if ('delete' === $table->current_action()) { 407 | $message = '

' . sprintf(__('Items deleted: %d', 'cltd_example'), count($_REQUEST['id'])) . '

'; 408 | } 409 | ?> 410 |
411 | 412 |

413 |

415 |

416 | 417 | 418 |
419 | 420 | display() ?> 421 |
422 | 423 |
424 | prefix . 'cte'; // do not forget about tables prefix 448 | 449 | $message = ''; 450 | $notice = ''; 451 | 452 | // this is default $item which will be used for new records 453 | $default = array( 454 | 'id' => 0, 455 | 'name' => '', 456 | 'email' => '', 457 | 'age' => null, 458 | ); 459 | 460 | // here we are verifying does this request is post back and have correct nonce 461 | if ( isset($_REQUEST['nonce']) && wp_verify_nonce($_REQUEST['nonce'], basename(__FILE__))) { 462 | // combine our default item with request params 463 | $item = shortcode_atts($default, $_REQUEST); 464 | // validate data, and if all ok save item to database 465 | // if id is zero insert otherwise update 466 | $item_valid = cltd_example_validate_person($item); 467 | if ($item_valid === true) { 468 | if ($item['id'] == 0) { 469 | $result = $wpdb->insert($table_name, $item); 470 | $item['id'] = $wpdb->insert_id; 471 | if ($result) { 472 | $message = __('Item was successfully saved', 'cltd_example'); 473 | } else { 474 | $notice = __('There was an error while saving item', 'cltd_example'); 475 | } 476 | } else { 477 | $result = $wpdb->update($table_name, $item, array('id' => $item['id'])); 478 | if ($result) { 479 | $message = __('Item was successfully updated', 'cltd_example'); 480 | } else { 481 | $notice = __('There was an error while updating item', 'cltd_example'); 482 | } 483 | } 484 | } else { 485 | // if $item_valid not true it contains error message(s) 486 | $notice = $item_valid; 487 | } 488 | } 489 | else { 490 | // if this is not post back we load item to edit or give new one to create 491 | $item = $default; 492 | if (isset($_REQUEST['id'])) { 493 | $item = $wpdb->get_row($wpdb->prepare("SELECT * FROM $table_name WHERE id = %d", $_REQUEST['id']), ARRAY_A); 494 | if (!$item) { 495 | $item = $default; 496 | $notice = __('Item not found', 'cltd_example'); 497 | } 498 | } 499 | } 500 | 501 | // here we adding our custom meta box 502 | add_meta_box('persons_form_meta_box', 'Person data', 'cltd_example_persons_form_meta_box_handler', 'person', 'normal', 'default'); 503 | 504 | ?> 505 |
506 |

507 |

509 |

510 | 511 | 512 |

513 | 514 | 515 |

516 | 517 | 518 |
519 | 520 | 521 | 522 | 523 |
524 |
525 |
526 | 527 | 528 | 529 |
530 |
531 |
532 |
533 |
534 | 546 | 547 | 548 | 549 | 550 | 553 | 557 | 558 | 559 | 562 | 566 | 567 | 568 | 571 | 575 | 576 | 577 |
551 | 552 | 554 | 556 |
560 | 561 | 563 | 565 |
569 | 570 | 572 | 574 |
578 | ', $messages); 601 | } 602 | 603 | /** 604 | * Do not forget about translating your plugin, use __('english string', 'your_uniq_plugin_name') to retrieve translated string 605 | * and _e('english string', 'your_uniq_plugin_name') to echo it 606 | * in this example plugin your_uniq_plugin_name == cltd_example 607 | * 608 | * to create translation file, use poedit FileNew catalog... 609 | * Fill name of project, add "." to path (ENSURE that it was added - must be in list) 610 | * and on last tab add "__" and "_e" 611 | * 612 | * Name your file like this: [my_plugin]-[ru_RU].po 613 | * 614 | * http://codex.wordpress.org/Writing_a_Plugin#Internationalizing_Your_Plugin 615 | * http://codex.wordpress.org/I18n_for_WordPress_Developers 616 | */ 617 | function cltd_example_languages() 618 | { 619 | load_plugin_textdomain('cltd_example', false, dirname(plugin_basename(__FILE__))); 620 | } 621 | 622 | add_action('init', 'cltd_example_languages'); 623 | -------------------------------------------------------------------------------- /readme.txt: -------------------------------------------------------------------------------- 1 | === Custom List Table With Database Example === 2 | Contributors: pmbaldha 3 | Tags: example, table, database, data, WP_List_Table, crud, admin, plugin, list table 4 | Donate link: https://github.com/pmbaldha/ 5 | Requires at least: 3.5 6 | Tested up to: 4.5.2 7 | Stable tag: trunk 8 | License: GPL2 9 | License URI: https://www.gnu.org/licenses/gpl-2.0.html 10 | 11 | A highly documented plugin that demonstrates how to create custom admin list-tables from database using WP_List_Table class. 12 | 13 | == Description == 14 | This plugin serves as a highly documented example of using WordPress's built-in WP_List_Table class with database CRUD (Create, Read, Update, Delete) operations for plugin development. This example serves to help clarify use of the WP_List_Table class with database for quickly and easily generating consistent, standardized, feature-rich list-tables for WordPress admin screens. 15 | 16 | There are several great reasons to display your data in a list table like these: 17 | 1.Stays true to the WordPress core UI 18 | 2.Requires zero custom CSS 19 | 3.Takes less time to create than custom interfaces 20 | 21 | For more information, please visit the WP_List_Tables page in the WordPress Codex. 22 | 23 | == Installation == 24 | Just Install and Activate It 25 | 26 | == Frequently Asked Questions == 27 | Is there any configuration require for this plugin? 28 | No 29 | 30 | Is all features of this plugin completely free? 31 | Yes 32 | 33 | Where can I get support? 34 | For support, please contact at pmbaldha@gmail.com 35 | 36 | Where can I report bug?= 37 | For reporting related bugs, please contact at pmbaldha@gmail.com. 38 | 39 | == Screenshots == 40 | 1. Person List Table 41 | 2. Add new person 42 | 3. Edit Person 43 | 44 | == Changelog == 45 | 0.1 46 | * Database CRUD Operations 47 | * Person Example 48 | 49 | == Upgrade Notice == 50 | No need to upgrade, you only need to install plugin. This is first version of plugin 51 | --------------------------------------------------------------------------------