├── .gitignore ├── LICENSE ├── README.md ├── assets ├── css │ └── term-families.css └── js │ └── term-families.js ├── composer.json ├── includes ├── class-wp-term-family.php ├── class-wp-term-meta-ui.php └── functions.php ├── readme.txt └── wp-term-families.php /.gitignore: -------------------------------------------------------------------------------- 1 | /vendor/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | {description} 294 | Copyright (C) {year} {fullname} 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 | {signature of Ty Coon}, 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 | 341 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # WP Term Family 2 | 3 | Family for categories, tags, and other taxonomy terms 4 | 5 | WP Term Family allows users to assign a Family to any category, tag, or taxonomy term using a dropdown, providing customized functionality for taxonomy terms. 6 | 7 | # Installation 8 | 9 | * Download and install using the built in WordPress plugin installer. 10 | * Activate in the "Plugins" area of your admin by clicking the "Activate" link. 11 | * No further setup or configuration is necessary. 12 | 13 | # FAQ 14 | 15 | ### Does this plugin depend on any others? 16 | 17 | Not since WordPress 4.4. 18 | 19 | Install the [WP Term Meta](https://wordpress.org/plugins/wp-term-meta/ "Metadata, for taxonomy terms.") plugin if you're on an earlier version. 20 | 21 | ### Does this create new database tables? 22 | 23 | No. There are no new database tables with this plugin. 24 | 25 | ### Does this modify existing database tables? 26 | 27 | No. All of WordPress's core database tables remain untouched. 28 | 29 | ### Can I query for terms by their `Family`? 30 | 31 | Yes. Use a `meta_query` like: 32 | 33 | ``` 34 | $terms = get_terms( 'category', array( 35 | 'depth' => 1, 36 | 'number' => 100, 37 | 'parent' => 0, 38 | 'hide_empty' => false, 39 | 40 | // Query by family using the "wp-term-meta" plugin! 41 | 'meta_query' => array( array( 42 | 'key' => 'family', 43 | 'value' => 'private' 44 | ) ) 45 | ) ); 46 | ``` 47 | 48 | ### Where can I get support? 49 | 50 | The WordPress support forums: https://wordpress.org/support/plugin/wp-term-family/ 51 | 52 | ### Can I contribute? 53 | 54 | Yes, please! The number of users needing more robust taxonomy terms is growing fast. Having an easy-to-use UI and powerful set of functions is critical to managing complex WordPress installations. If this is your thing, please help us out! 55 | -------------------------------------------------------------------------------- /assets/css/term-families.css: -------------------------------------------------------------------------------- 1 | .column-family { 2 | width: 94px; 3 | } 4 | -------------------------------------------------------------------------------- /assets/js/term-families.js: -------------------------------------------------------------------------------- 1 | jQuery( document ).ready( function( $ ) { 2 | 'use strict'; 3 | 4 | $( '.editinline' ).on( 'click', function() { 5 | var tag_id = $( this ).parents( 'tr' ).attr( 'id' ), 6 | family = $( 'td.family span', '#' + tag_id ).data( 'family' ); 7 | 8 | if ( typeof( family ) !== 'undefined' ) { 9 | setTimeout( function() { 10 | $( 'select[name="term-family"]', '.inline-edit-row' ).val( family ); 11 | }, 100 ); 12 | } 13 | } ); 14 | } ); 15 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "stuttter/wp-term-families", 3 | "description": "Families for categories, tags, and other taxonomy terms", 4 | "homepage": "https://github.com/stuttter/wp-term-families", 5 | "type": "wordpress-plugin", 6 | "require": { 7 | "php": ">=5.6", 8 | "composer/installers": "^1.0" 9 | }, 10 | "license": "GPL-2.0-or-later", 11 | "authors": [ 12 | { 13 | "name": "John James Jacoby", 14 | "email": "johnjamesjacoby@me.com" 15 | } 16 | ] 17 | } 18 | 19 | -------------------------------------------------------------------------------- /includes/class-wp-term-family.php: -------------------------------------------------------------------------------- 1 | labels = array( 46 | 'singular' => esc_html__( 'Family', 'wp-term-families' ), 47 | 'plural' => esc_html__( 'Families', 'wp-term-families' ), 48 | 'description' => esc_html__( 'The family is used to group terms together using another taxonomy.', 'wp-term-families' ) 49 | ); 50 | 51 | // Call the parent and pass the file 52 | parent::__construct( $file ); 53 | } 54 | 55 | /** Assets ****************************************************************/ 56 | 57 | /** 58 | * Enqueue quick-edit JS 59 | * 60 | * @since 0.1.0 61 | */ 62 | public function enqueue_scripts() { 63 | 64 | // Quick-edit support 65 | wp_enqueue_script( 'wp-term-families', $this->url . 'assets/js/term-families.js', array( 'jquery' ), $this->db_version, true ); 66 | 67 | // Styles 68 | wp_enqueue_style( 'wp-term-families', $this->url . 'assets/css/term-families.css', array(), $this->db_version ); 69 | } 70 | 71 | /** 72 | * Add help tabs for `family` column 73 | * 74 | * @since 0.1.0 75 | */ 76 | public function help_tabs() { 77 | get_current_screen()->add_help_tab(array( 78 | 'id' => 'wp_term_families_help_tab', 79 | 'title' => __( 'Term Family', 'wp-term-family' ), 80 | 'content' => '

' . __( 'Set term family to group terms by another taxonomy.', 'wp-term-family' ) . '

', 81 | ) ); 82 | } 83 | 84 | /** 85 | * Return family options for use in a dropdown 86 | * 87 | * @since 0.1.0 88 | */ 89 | protected function get_term_family_options( $term = '' ) { 90 | 91 | // Start an output buffer 92 | ob_start(); 93 | 94 | // Get the meta value 95 | $value = isset( $term->term_id ) 96 | ? $this->get_meta( $term->term_id ) 97 | : ''; 98 | 99 | $taxonomy = isset( $term->taxonomy ) 100 | ? $term->taxonomy 101 | : $GLOBALS['taxnow']; 102 | 103 | // Get term taxonomy families 104 | $options = wp_get_term_families( $taxonomy ); 105 | 106 | // Loop through families and make them into option tags 107 | foreach ( $options as $option ) : ?> 108 | 109 | 112 | 113 | 128 | 129 | 132 | 133 | 143 | 144 | 147 | 148 | family ) ) { 169 | return $this->no_value; 170 | } 171 | 172 | // Look for family 173 | if ( ! empty( $meta ) ) { 174 | $family = get_term( $meta, $tax->family ); 175 | } 176 | 177 | // Value? 178 | $retval = isset( $family ) 179 | ? $family->name 180 | : $this->no_value; 181 | 182 | // ID? 183 | $id = isset( $family ) 184 | ? $family->term_id 185 | : 0; 186 | 187 | // Return 188 | return '' . esc_html( $retval ) . ''; 189 | } 190 | } 191 | endif; 192 | -------------------------------------------------------------------------------- /includes/class-wp-term-meta-ui.php: -------------------------------------------------------------------------------- 1 | '', 57 | 'plural' => '', 58 | 'descrption' => '' 59 | ); 60 | 61 | /** 62 | * @var string File for plugin 63 | */ 64 | public $file = ''; 65 | 66 | /** 67 | * @var string URL to plugin 68 | */ 69 | public $url = ''; 70 | 71 | /** 72 | * @var string Path to plugin 73 | */ 74 | public $path = ''; 75 | 76 | /** 77 | * @var string Basename for plugin 78 | */ 79 | public $basename = ''; 80 | 81 | /** 82 | * @var array Which taxonomies are being targeted? 83 | */ 84 | public $taxonomies = array(); 85 | 86 | /** 87 | * @var bool Whether to use fancy UI 88 | */ 89 | public $fancy = false; 90 | 91 | /** 92 | * @var bool Whether to show a column 93 | */ 94 | public $has_column = true; 95 | 96 | /** 97 | * @var bool Whether to show fields 98 | */ 99 | public $has_fields = true; 100 | 101 | /** 102 | * Hook into queries, admin screens, and more! 103 | * 104 | * @since 2.0.0 105 | */ 106 | public function __construct( $file = '' ) { 107 | 108 | // Setup plugin 109 | $this->file = $file; 110 | $this->url = plugin_dir_url( $this->file ); 111 | $this->path = plugin_dir_path( $this->file ); 112 | $this->basename = plugin_basename( $this->file ); 113 | 114 | // Initialize late, after taxonomies are likely registered 115 | add_action( 'init', array( $this, 'initialize' ), 999 ); 116 | } 117 | 118 | /** 119 | * Initialize on `init` action so taxonomies are registered 120 | * 121 | * @since 2.0.0 122 | */ 123 | public function initialize() { 124 | 125 | // Get the targeted taxonomies 126 | $this->taxonomies = $this->get_taxonomies(); 127 | 128 | // A simple filter to allow for UI variations 129 | $this->fancy = apply_filters( "wp_fancy_term_{$this->meta_key}", true ); 130 | 131 | // Bail if no targeted taxonomies 132 | if ( empty( $this->taxonomies ) ) { 133 | return; 134 | } 135 | 136 | // Register Meta 137 | $this->register_meta(); 138 | 139 | // Add Hooks 140 | $this->add_hooks(); 141 | } 142 | 143 | /** 144 | * Add the hooks, on the `init` action 145 | * 146 | * @since 2.0.0 147 | */ 148 | public function add_hooks() { 149 | 150 | // Queries 151 | add_action( 'create_term', array( $this, 'save_meta' ), 10, 3 ); 152 | add_action( 'edit_term', array( $this, 'save_meta' ), 10, 3 ); 153 | 154 | // ajax actions 155 | add_action( "wp_ajax_{$this->meta_key}_terms", array( $this, 'ajax_update' ) ); 156 | 157 | // Term meta orderby 158 | add_filter( 'terms_clauses', array( $this, 'terms_clauses' ), 10, 3 ); 159 | add_filter( 'get_terms_orderby', array( $this, 'get_terms_orderby' ), 10, 3 ); 160 | 161 | // Always hook these in, for ajax actions 162 | foreach ( $this->taxonomies as $value ) { 163 | 164 | // Has column? 165 | if ( true === $this->has_column ) { 166 | add_filter( "manage_edit-{$value}_columns", array( $this, 'add_column_header' ) ); 167 | add_filter( "manage_{$value}_custom_column", array( $this, 'add_column_value' ), 10, 3 ); 168 | add_filter( "manage_edit-{$value}_sortable_columns", array( $this, 'sortable_columns' ) ); 169 | } 170 | 171 | // Has fields? 172 | if ( true === $this->has_fields ) { 173 | add_action( "{$value}_add_form_fields", array( $this, 'add_form_field' ) ); 174 | add_action( "{$value}_edit_form_fields", array( $this, 'edit_form_field' ) ); 175 | } 176 | } 177 | 178 | // Only blog admin screens 179 | if ( is_blog_admin() || doing_action( 'wp_ajax_inline_save_tax' ) ) { 180 | add_action( 'admin_init', array( $this, 'admin_init' ) ); 181 | add_action( 'load-edit-tags.php', array( $this, 'edit_tags' ) ); 182 | } 183 | } 184 | 185 | /** 186 | * Register term meta, key, and callbacks 187 | * 188 | * @since 2.0.0 189 | */ 190 | public function register_meta() { 191 | register_meta( 'term', $this->meta_key, array( 192 | 'auth_callback' => array( $this, 'auth_callback' ), 193 | 'sanitize_callback' => array( $this, 'sanitize_callback' ) 194 | ) ); 195 | } 196 | 197 | /** 198 | * Stub method for sanitizing meta data 199 | * 200 | * @since 2.0.0 201 | * 202 | * @param mixed $data 203 | * @return mixed 204 | */ 205 | public function sanitize_callback( $data = '' ) { 206 | return $data; 207 | } 208 | 209 | /** 210 | * Stub method for authorizing the saving of meta data 211 | * 212 | * @since 2.0.0 213 | * 214 | * @param bool $allowed 215 | * @param string $meta_key 216 | * @param int $post_id 217 | * @param int $user_id 218 | * @param string $cap 219 | * @param array $caps 220 | * 221 | * @return boolean 222 | */ 223 | public function auth_callback( $allowed = false, $meta_key = '', $post_id = 0, $user_id = 0, $cap = '', $caps = array() ) { 224 | 225 | // Bail if incorrect meta key 226 | if ( $meta_key !== $this->meta_key ) { 227 | return $allowed; 228 | } 229 | 230 | return $allowed; 231 | } 232 | 233 | /** 234 | * Administration area hooks 235 | * 236 | * @since 2.0.0 237 | */ 238 | public function admin_init() { 239 | 240 | // Check for DB update 241 | $this->maybe_upgrade_database(); 242 | } 243 | 244 | /** 245 | * Administration area hooks 246 | * 247 | * @since 2.0.0 248 | */ 249 | public function edit_tags() { 250 | 251 | // Enqueue javascript 252 | add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ) ); 253 | add_action( 'admin_head', array( $this, 'help_tabs' ) ); 254 | add_action( 'admin_head', array( $this, 'admin_head' ) ); 255 | 256 | // Quick edit 257 | add_action( 'quick_edit_custom_box', array( $this, 'quick_edit_meta' ), 10, 3 ); 258 | } 259 | 260 | /** Get Terms *************************************************************/ 261 | 262 | /** 263 | * Filter `get_terms_orderby` and tweak for meta_query orderby's 264 | * 265 | * @since 2.0.0 266 | * 267 | * @param string $orderby 268 | * @param array $query_vars 269 | * @param array $taxonomies 270 | */ 271 | public function get_terms_orderby( $orderby = '', $query_vars = array(), $taxonomies = array() ) { 272 | 273 | // Bail if not a target taxonomy 274 | if ( ! $this->is_taxonomy( $taxonomies ) ) { 275 | return $orderby; 276 | } 277 | 278 | // Ordering by meta key 279 | if ( ! empty( $_REQUEST['orderby'] ) && ( $this->meta_key === $_REQUEST['orderby'] ) ) { 280 | $orderby = 'meta_value'; 281 | } 282 | 283 | return $orderby; 284 | } 285 | 286 | /** 287 | * Filter get_terms() and maybe add `meta_query` 288 | * 289 | * @since 2.0.0 290 | * 291 | * @param array $clauses 292 | * @param array $taxonomies 293 | * @param array $args 294 | */ 295 | public function terms_clauses( $clauses = array(), $taxonomies = array(), $args = array() ) { 296 | global $wpdb; 297 | 298 | // Bail if not a target taxonomy 299 | if ( ! $this->is_taxonomy( $taxonomies ) ) { 300 | return $clauses; 301 | } 302 | 303 | // Default allowed keys & primary key 304 | $allowed_keys = array( $this->meta_key ); 305 | 306 | // Set allowed keys 307 | $allowed_keys[] = 'meta_value'; 308 | $allowed_keys[] = 'meta_value_num'; 309 | 310 | // Tweak orderby 311 | $orderby = isset( $args[ 'orderby' ] ) 312 | ? $args[ 'orderby' ] 313 | : ''; 314 | 315 | // Bail if no orderby or allowed_keys 316 | if ( ! in_array( $orderby, $allowed_keys, true ) ) { 317 | return $clauses; 318 | } 319 | 320 | // Join term meta data 321 | $clauses['join'] .= " INNER JOIN {$wpdb->termmeta} AS tm ON t.term_id = tm.term_id"; 322 | 323 | // Maybe order by term meta 324 | switch ( $args[ 'orderby' ] ) { 325 | case $this->meta_key : 326 | case 'meta_value' : 327 | if ( ! empty( $this->key_type ) ) { 328 | $clauses['orderby'] = "ORDER BY CAST(tm.meta_value AS tm)"; 329 | } else { 330 | $clauses['orderby'] = "ORDER BY tm.meta_value"; 331 | } 332 | $clauses['fields'] .= ', tm.*'; 333 | $clauses['where'] .= " AND tm.meta_key = '{$this->meta_key}'"; 334 | break; 335 | case 'meta_value_num': 336 | $clauses['orderby'] = "ORDER BY tm.meta_value+0"; 337 | $clauses['fields'] .= ', tm.*'; 338 | $clauses['where'] .= " AND tm.meta_key = '{$this->meta_key}'"; 339 | break; 340 | } 341 | 342 | // Return maybe modified clauses 343 | return $clauses; 344 | } 345 | 346 | /** Assets ****************************************************************/ 347 | 348 | /** 349 | * Enqueue quick-edit JS 350 | * 351 | * @since 2.0.0 352 | */ 353 | public function enqueue_scripts() { } 354 | 355 | /** 356 | * Add help tabs for this metadata 357 | * 358 | * @since 2.0.0 359 | */ 360 | public function help_tabs() { } 361 | 362 | /** 363 | * Add help tabs for this metadata 364 | * 365 | * @since 2.0.0 366 | */ 367 | public function admin_head() { } 368 | 369 | /** 370 | * Quick edit ajax updating 371 | * 372 | * @since 2.0.0 373 | */ 374 | public function ajax_update() {} 375 | 376 | /** 377 | * Return the taxonomies used by this plugin 378 | * 379 | * @since 2.0.0 380 | * 381 | * @param array $args 382 | * @return array 383 | */ 384 | private function get_taxonomies( $args = array() ) { 385 | 386 | // The filter key/tag 387 | $tag = "wp_term_{$this->meta_key}_get_taxonomies"; 388 | 389 | /** 390 | * Allow filtering of affected taxonomies 391 | * 392 | * @since 2.0.0 393 | */ 394 | $defaults = apply_filters( $tag, array( 395 | 'show_ui' => true 396 | ) ); 397 | 398 | // Parse arguments 399 | $r = wp_parse_args( $args, $defaults ); 400 | 401 | // Get & return the taxonomies 402 | return get_taxonomies( $r ); 403 | } 404 | 405 | /** Columns ***************************************************************/ 406 | 407 | /** 408 | * Add the "meta_key" column to taxonomy terms list-tables 409 | * 410 | * @since 2.0.0 411 | * 412 | * @param array $columns 413 | * 414 | * @return array 415 | */ 416 | public function add_column_header( $columns = array() ) { 417 | $columns[ $this->meta_key ] = $this->labels['singular']; 418 | 419 | return $columns; 420 | } 421 | 422 | /** 423 | * Output the value for the custom column 424 | * 425 | * @since 2.0.0 426 | * 427 | * @param string $empty 428 | * @param string $custom_column 429 | * @param int $term_id 430 | * 431 | * @return mixed 432 | */ 433 | public function add_column_value( $empty = '', $custom_column = '', $term_id = 0 ) { 434 | 435 | // Bail if no taxonomy passed or not on the `meta_key` column 436 | if ( empty( $_REQUEST['taxonomy'] ) || ( $this->meta_key !== $custom_column ) || ! empty( $empty ) ) { 437 | return $empty; 438 | } 439 | 440 | // Get the metadata 441 | $meta = $this->get_meta( $term_id ); 442 | $retval = $this->no_value; 443 | 444 | // Output HTML element if not empty 445 | if ( ! empty( $meta ) ) { 446 | $retval = $this->format_output( $meta ); 447 | } 448 | 449 | echo $retval; 450 | } 451 | 452 | /** 453 | * Allow sorting by this `meta_key` 454 | * 455 | * @since 2.0.0 456 | * 457 | * @param array $columns 458 | * 459 | * @return array 460 | */ 461 | public function sortable_columns( $columns = array() ) { 462 | $columns[ $this->meta_key ] = $this->meta_key; 463 | return $columns; 464 | } 465 | 466 | /** 467 | * Add `meta_key` to term when updating 468 | * 469 | * @since 2.0.0 470 | * 471 | * @param int $term_id 472 | * @param int $tt_id 473 | * @param string $taxonomy 474 | */ 475 | public function save_meta( $term_id = 0, $tt_id = 0, $taxonomy = '' ) { 476 | 477 | // Bail if not a target taxonomy 478 | if ( ! $this->is_taxonomy( $taxonomy ) ) { 479 | return; 480 | } 481 | 482 | // Get the term being posted 483 | $term_key = 'term-' . $this->meta_key; 484 | 485 | // Bail if not updating meta_key 486 | $meta = ! empty( $_POST[ $term_key ] ) 487 | ? $_POST[ $term_key ] 488 | : ''; 489 | 490 | $this->set_meta( $term_id, $taxonomy, $meta ); 491 | } 492 | 493 | /** 494 | * Set `meta_key` of a specific term 495 | * 496 | * @since 2.0.0 497 | * 498 | * @param int $term_id 499 | * @param string $taxonomy 500 | * @param string $meta 501 | * @param bool $clean_cache 502 | */ 503 | public function set_meta( $term_id = 0, $taxonomy = '', $meta = '', $clean_cache = false ) { 504 | 505 | // No meta_key, so delete 506 | if ( empty( $meta ) ) { 507 | delete_term_meta( $term_id, $this->meta_key ); 508 | 509 | // Update meta_key value 510 | } else { 511 | update_term_meta( $term_id, $this->meta_key, $meta ); 512 | } 513 | 514 | // Maybe clean the term cache 515 | if ( true === $clean_cache ) { 516 | clean_term_cache( $term_id, $taxonomy ); 517 | } 518 | } 519 | 520 | /** 521 | * Return the `meta_key` of a term 522 | * 523 | * @since 2.0.0 524 | * 525 | * @param int $term_id 526 | */ 527 | public function get_meta( $term_id = 0 ) { 528 | return get_term_meta( $term_id, $this->meta_key, true ); 529 | } 530 | 531 | /** Markup ****************************************************************/ 532 | 533 | /** 534 | * Output the form field for this metadata when adding a new term 535 | * 536 | * @since 2.0.0 537 | */ 538 | public function add_form_field() { 539 | ?> 540 | 541 |
542 | 545 | 546 | form_field(); ?> 547 | 548 | labels['description'] ) ) : ?> 549 | 550 |

551 | labels['description'] ); ?> 552 |

553 | 554 | 555 | 556 |
557 | 558 | 570 | 571 | 572 | 573 | 576 | 577 | 578 | form_field( $term ); ?> 579 | 580 | labels['description'] ) ) : ?> 581 | 582 |

583 | labels['description'] ); ?> 584 |

585 | 586 | 587 | 588 | 589 | 590 | 591 | meta_key !== $column_name ) || ( 'edit-tags' !== $screen ) || ! $this->is_taxonomy( $name ) ) { 605 | return false; 606 | } ?> 607 | 608 |
609 |
610 | 618 |
619 |
620 | 621 | term_id ) 635 | ? $this->get_meta( $term->term_id ) 636 | : ''; ?> 637 | 638 | 639 | 640 | 652 | 653 | 654 | 655 | db_version_key ); 671 | 672 | // Needs 673 | if ( $db_version < $this->db_version ) { 674 | $this->upgrade_database( $db_version ); 675 | } 676 | } 677 | 678 | /** 679 | * Upgrade the database as needed, based on version comparisons 680 | * 681 | * @since 2.0.0 682 | */ 683 | private function upgrade_database() { 684 | update_option( $this->db_version_key, $this->db_version ); 685 | } 686 | 687 | /** Helpers ***************************************************************/ 688 | 689 | /** 690 | * Compare some taxonomies against the ones for this term meta. 691 | * 692 | * @since 3.0.0 693 | * 694 | * @param array $taxonomies 695 | */ 696 | private function is_taxonomy( $taxonomies = array() ) { 697 | 698 | // Bail early if empty 699 | if ( empty( $taxonomies ) ) { 700 | return false; 701 | } 702 | 703 | // Always make sure this is an array 704 | $taxonomies = (array) $taxonomies; 705 | 706 | // Check the intersect 707 | $intersect = array_intersect( $taxonomies, $this->taxonomies ); 708 | 709 | // Return 710 | return (bool) ! empty( $intersect ); 711 | } 712 | } 713 | endif; 714 | -------------------------------------------------------------------------------- /includes/functions.php: -------------------------------------------------------------------------------- 1 | has_family = true; 45 | $GLOBALS['wp_taxonomies'][ $taxonomy ]->family = $family; 46 | } 47 | 48 | /** 49 | * Return all of the registered term families 50 | * 51 | * @since 0.1.0 52 | * 53 | * @return array 54 | */ 55 | function wp_get_term_families( $taxonomy = null ) { 56 | 57 | // Default return value (ugh) 58 | $retval = array( (object) array( 59 | 'term_id' => 0, 60 | 'name' => esc_html__( 'None', 'wp-term-families' ) 61 | ) ); 62 | 63 | // Get the taxonomy 64 | $tax = get_taxonomy( $taxonomy ); 65 | 66 | // Bail if taxonomy has no family 67 | if ( empty( $tax->family ) ) { 68 | return $retval; 69 | } 70 | 71 | // Return terms 72 | if ( taxonomy_exists( $tax->family ) ) { 73 | 74 | // Get family terms 75 | $family_terms = get_terms( $tax->family, array( 76 | 'hide_empty' => false, 77 | 'get' => 'all' 78 | ) ); 79 | 80 | // Set return value 81 | if ( ! empty( $family_terms ) ) { 82 | 83 | // Set return value 84 | $retval = $family_terms; 85 | 86 | // Add "None" value 87 | array_unshift( $retval, (object) array( 88 | 'term_id' => 0, 89 | 'name' => esc_html__( 'None', 'wp-term-families' ) 90 | ) ); 91 | } 92 | } 93 | 94 | return $retval; 95 | } 96 | -------------------------------------------------------------------------------- /readme.txt: -------------------------------------------------------------------------------- 1 | === WP Term Family === 2 | Contributors: johnjamesjacoby, stuttter 3 | Tags: taxonomy, term, meta, metadata, family, privacy 4 | Requires PHP: 5.6.20 5 | Requires at least: 4.4 6 | Tested up to: 5.2 7 | Stable tag: 2.0.0 8 | License: GPLv2 or later 9 | License URI: http://www.gnu.org/licenses/gpl-2.0.html 10 | Donate link: https://ko-fi.com/jjj 11 | 12 | == Description == 13 | 14 | Family for categories, tags, and other taxonomy terms 15 | 16 | WP Term Family allows users to assign a Family to any category, tag, or taxonomy term using a dropdown, providing customized functionality for taxonomy terms. 17 | 18 | = Dependencies = 19 | 20 | Not since WordPress 4.4. 21 | 22 | Install the [WP Term Meta](https://wordpress.org/plugins/wp-term-meta/ "Metadata, for taxonomy terms.") plugin if you're on an earlier version. 23 | 24 | = Also checkout = 25 | 26 | * [WP Chosen](https://wordpress.org/plugins/wp-chosen/ "Make long, unwieldy select boxes much more user-friendly.") 27 | * [WP Pretty Filters](https://wordpress.org/plugins/wp-pretty-filters/ "Makes post filters better match what's already in Media & Attachments.") 28 | * [WP Event Calendar](https://wordpress.org/plugins/wp-event-calendar/ "The best way to manage events in WordPress.") 29 | * [WP Media Categories](https://wordpress.org/plugins/wp-media-categories/ "Add categories to media & attachments.") 30 | * [WP Term Order](https://wordpress.org/plugins/wp-term-order/ "Sort taxonomy terms, your way.") 31 | * [WP Term Authors](https://wordpress.org/plugins/wp-term-authors/ "Authors for categories, tags, and other taxonomy terms.") 32 | * [WP Term Locks](https://wordpress.org/plugins/wp-term-locks/ "Pretty locks for categories, tags, and other taxonomy terms.") 33 | * [WP Term Icons](https://wordpress.org/plugins/wp-term-icons/ "Pretty icons for categories, tags, and other taxonomy terms.") 34 | * [WP Term Visibility](https://wordpress.org/plugins/wp-term-visibility/ "Visibilities for categories, tags, and other taxonomy terms.") 35 | * [WP User Activity](https://wordpress.org/plugins/wp-user-activity/ "The best way to log activity in WordPress.") 36 | * [WP User Avatars](https://wordpress.org/plugins/wp-user-avatars/ "Allow users to upload avatars or choose them from your media library.") 37 | * [WP User Groups](https://wordpress.org/plugins/wp-user-groups/ "Group users together with taxonomies & terms.") 38 | * [WP User Profiles](https://wordpress.org/plugins/wp-user-profiles/ "A sophisticated way to edit users in WordPress.") 39 | 40 | == Screenshots == 41 | 42 | 1. Category Family 43 | 44 | == Installation == 45 | 46 | * Download and install using the built in WordPress plugin installer. 47 | * Activate in the "Plugins" area of your admin by clicking the "Activate" link. 48 | * No further setup or configuration is necessary. 49 | 50 | == Frequently Asked Questions == 51 | 52 | = Does this plugin depend on any others? = 53 | 54 | No. Not since WordPress 4.4. 55 | 56 | = Does this create new database tables? = 57 | 58 | No. There are no new database tables with this plugin. 59 | 60 | = Does this modify existing database tables? = 61 | 62 | No. All of WordPress's core database tables remain untouched. 63 | 64 | = How do I query for terms via their Family? = 65 | 66 | With WordPress's `get_terms()` function, the same as usual, but with an additional `meta_query` argument according the `WP_Meta_Query` specification: 67 | http://codex.wordpress.org/Class_Reference/WP_Meta_Query 68 | 69 | ` 70 | $terms = get_terms( 'category', array( 71 | 'depth' => 1, 72 | 'number' => 100, 73 | 'parent' => 0, 74 | 'hide_empty' => false, 75 | 76 | // Query by family using the "wp-term-meta" plugin! 77 | 'meta_query' => array( array( 78 | 'key' => 'family', 79 | 'value' => 'private' 80 | ) ) 81 | ) ); 82 | ` 83 | 84 | = Where can I get support? = 85 | 86 | The WordPress support forums: https://wordpress.org/support/plugin/wp-term-family/ 87 | 88 | = Where can I find documentation? = 89 | 90 | http://github.com/stuttter/wp-term-family/ 91 | 92 | == Changelog == 93 | 94 | = 2.0.0 = 95 | * Update base class 96 | 97 | = 0.2.0 = 98 | * Update base class 99 | 100 | = 0.1.1 = 101 | * Fix quick-edit UI 102 | 103 | = 0.1.0 = 104 | * Initial release 105 | -------------------------------------------------------------------------------- /wp-term-families.php: -------------------------------------------------------------------------------- 1 |