├── .gitignore ├── assets ├── dominant_colour_admin.css └── dominant_colour_admin.js ├── composer.json ├── README.md ├── readme.txt ├── composer.lock ├── dominant-color.php └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | vendor 2 | -------------------------------------------------------------------------------- /assets/dominant_colour_admin.css: -------------------------------------------------------------------------------- 1 | .dominant-colour-square { 2 | width: 30px; 3 | height: 30px; 4 | display: inline-block; 5 | box-sizing: border-box; 6 | } 7 | 8 | .dominant-colour-square:hover { 9 | border: 2px solid #ff6c6c; 10 | } 11 | 12 | .dominant-colour-square.selected { 13 | border: 2px solid red; 14 | } -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "lgladdy/dominant-color-wordpress", 3 | "description": "A WordPress plugin to grab the most dominant colour in an attachment", 4 | "type": "library", 5 | "require": { 6 | "ksubileau/color-thief-php": "^2" 7 | }, 8 | "license": "Apache 2.0", 9 | "authors": [ 10 | { 11 | "name": "Liam Gladdy", 12 | "email": "liam@gladdy.co.uk" 13 | } 14 | ], 15 | "minimum-stability": "stable" 16 | } 17 | -------------------------------------------------------------------------------- /assets/dominant_colour_admin.js: -------------------------------------------------------------------------------- 1 | function attachDominantColor() { 2 | jQuery('.trigger-rebuild').on('click', function() { 3 | jQuery(this).html('Building Color Palette...'); 4 | storage = jQuery('input[name*="dominant-override"]'); 5 | storage.val('trigger-rebuild'); 6 | storage.change(); 7 | }); 8 | jQuery('.dominant-colour-square').on('click', function() { 9 | //Unselect all others, and select us. 10 | el = jQuery(this); 11 | storage = jQuery('input[name*="dominant-override"]'); 12 | storage.val(el.data('col')); 13 | storage.change(); 14 | jQuery(el.parent().find('.selected')).removeClass('selected'); 15 | jQuery(el).addClass('selected'); 16 | }); 17 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Dominant Color 2 | A WordPress plugin to automatically save the dominant color and a color palette for an attachment image into post_meta. 3 | 4 | Uses [ksubileau/color-thief-php](https://github.com/ksubileau/color-thief-php) as it's core, and shares that project's requirements: 5 | 6 | - PHP >= 7.2 7 | - Fileinfo extension 8 | - One or more PHP extensions for image processing: 9 | - GD >= 2.0 10 | - Imagick >= 2.0 (but >= 3.0 for CMYK images) 11 | - Gmagick >= 1.0 12 | 13 | ### Usage 14 | 15 | The dominant color and color palette is automatically saved on upload and edit to post meta. 16 | 17 | The dominant color can be overridden in the media gallery with any color from the palette in the media gallery. 18 | 19 | You need to then use our function get_color_data() to retrieve the "dominant_color_hex" or "dominant_color_rgb" meta key. hex returns a string, including the #, rgb returns an array with key 0 as red, 1 as green, and 2 as blue. 20 | 21 | You can also use the meta keys "color_palette_rgb" and "color_palette_hex" to get an array of 8 colors that feature prominently in the image. 22 | 23 | ### Apologies 24 | 25 | My fellow brits: This was originally called "Dominant Colour", but given that the world we code in uses color, it makes more sense. -------------------------------------------------------------------------------- /readme.txt: -------------------------------------------------------------------------------- 1 | === Dominant Color === 2 | Contributors: lgladdy 3 | Tags: color, colour, image, dominant, dominance, automatic 4 | Requires at least: 5.4 5 | Requires PHP: 7.2 6 | Tested up to: 5.9.1 7 | Stable tag: 2.1.0 8 | License: Apache 2.0 9 | Text Domain: dominant-color 10 | License URI: http://www.apache.org/licenses/LICENSE-2.0 11 | 12 | A WordPress plugin to automatically save the dominant color and a color palette for an attachment image into post_meta. 13 | 14 | Requires: 15 | PHP >= 7.2 16 | Fileinfo extension 17 | One or more PHP extensions for image processing: 18 | - GD >= 2.0 19 | - Imagick >= 2.0 (but >= 3.0 for CMYK images) 20 | - Gmagick >= 1.0 21 | 22 | == Description == 23 | A WordPress plugin to automatically save the dominant color and a color palette for an attachment image into post_meta. 24 | 25 | == Installation == 26 | The dominant color and color palette is automatically saved on upload and edit to post meta. 27 | 28 | You need to then use get_post_meta to retrieve the "dominant_color_hex" or "dominant_color_rgb" meta key. hex returns a string, including the #, rgb returns an array with key 0 as red, 1 as green, and 2 as blue. 29 | 30 | Alternatively, you can use the meta keys "color_palette_rgb" and "color_palette_hex" to get an array of 8 colors that feature prominently in the image. 31 | 32 | == Screenshots == 33 | 34 | 1. Shows the plugin in use on hellobrstl.com 35 | 2. Shows the plugin in use on hellobrstl.com 36 | 3. Shows the plugin in use on hellobrstl.com 37 | 38 | == Changelog == 39 | 40 | 2.2.0 41 | --- 42 | 43 | Modernise javascript for deprecated jQuery handlers 44 | Update to latest version of [PHP Color Thief](https://github.com/ksubileau/color-thief-php) 45 | 46 | 2.1.0 47 | --- 48 | 49 | Support translated languages (Submit your translation at translate.wordpress.org!) 50 | 51 | 2.0.1 52 | --- 53 | 54 | Fix a bug where loading our JS in the footer would cause a javascript error. 55 | 56 | 2.0 57 | --- 58 | 59 | Add a colour picker to the attachment edit screen to override the dominant color with a custom pick. 60 | The WordPress media gallery will now let you pick a dominant color override which will be returned in place of dominant_color_hex/rgb when set. 61 | It'll also let you generate a palette for legacy images uploaded before you installed the plugin. 62 | 63 | 1.0 64 | --- 65 | 66 | Initial Build -------------------------------------------------------------------------------- /composer.lock: -------------------------------------------------------------------------------- 1 | { 2 | "_readme": [ 3 | "This file locks the dependencies of your project to a known state", 4 | "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", 5 | "This file is @generated automatically" 6 | ], 7 | "content-hash": "07364ccd6e6190b8e5116222090f4168", 8 | "packages": [ 9 | { 10 | "name": "ksubileau/color-thief-php", 11 | "version": "v2.0.0", 12 | "source": { 13 | "type": "git", 14 | "url": "https://github.com/ksubileau/color-thief-php.git", 15 | "reference": "f905264d26c468f41989bb269546de6076aa7961" 16 | }, 17 | "dist": { 18 | "type": "zip", 19 | "url": "https://api.github.com/repos/ksubileau/color-thief-php/zipball/f905264d26c468f41989bb269546de6076aa7961", 20 | "reference": "f905264d26c468f41989bb269546de6076aa7961", 21 | "shasum": "" 22 | }, 23 | "require": { 24 | "ext-fileinfo": "*", 25 | "php": "^7.2|^8.0" 26 | }, 27 | "require-dev": { 28 | "friendsofphp/php-cs-fixer": "^3.4", 29 | "phpstan/phpstan": "^1.2.0", 30 | "phpstan/phpstan-phpunit": "^1.0.0", 31 | "phpunit/phpunit": "^8.5" 32 | }, 33 | "suggest": { 34 | "ext-gd": "to use the GD image adapter.", 35 | "ext-gmagick": "to use the Gmagick image adapter.", 36 | "ext-imagick": "to use the Imagick image adapter." 37 | }, 38 | "type": "library", 39 | "autoload": { 40 | "psr-4": { 41 | "ColorThief\\": "src/ColorThief" 42 | } 43 | }, 44 | "notification-url": "https://packagist.org/downloads/", 45 | "license": [ 46 | "MIT" 47 | ], 48 | "authors": [ 49 | { 50 | "name": "Kevin Subileau", 51 | "homepage": "http://www.kevinsubileau.fr" 52 | } 53 | ], 54 | "description": "Grabs the dominant color or a representative color palette from an image.", 55 | "homepage": "http://www.kevinsubileau.fr/projets/color-thief-php", 56 | "keywords": [ 57 | "color", 58 | "dominant", 59 | "palette", 60 | "php", 61 | "thief" 62 | ], 63 | "support": { 64 | "issues": "https://github.com/ksubileau/color-thief-php/issues", 65 | "source": "https://github.com/ksubileau/color-thief-php/tree/v2.0.0" 66 | }, 67 | "time": "2022-03-12T20:27:56+00:00" 68 | } 69 | ], 70 | "packages-dev": [], 71 | "aliases": [], 72 | "minimum-stability": "stable", 73 | "stability-flags": [], 74 | "prefer-stable": false, 75 | "prefer-lowest": false, 76 | "platform": [], 77 | "platform-dev": [], 78 | "plugin-api-version": "2.2.0" 79 | } 80 | -------------------------------------------------------------------------------- /dominant-color.php: -------------------------------------------------------------------------------- 1 | ID, 'color_palette_hex', true ); 68 | 69 | if ( $palette === false ) { 70 | $html = __( 'No Color Dominance Available.', 'dominant-color' ); 71 | $html .= '
'; 72 | $html .= __( 'Calculate Now?', 'dominant-color' ); 73 | $html .= ''; 74 | } else { 75 | $dominant_color = get_color_data( $post->ID, 'dominant_color_hex', true, false ); 76 | 77 | $palette = array_merge( (array) $dominant_color, $palette ); 78 | 79 | $currently_selected = get_color_data( $post->ID, 'dominant_color_hex', true ); 80 | 81 | $htmls = array(); 82 | foreach ( $palette as $pal ) { 83 | $html = '
'; 88 | 89 | $htmls[] = $html; 90 | } 91 | $html = '
' . implode( $htmls ) . '
'; 92 | } 93 | $html .= ''; 94 | 95 | $fields['dominant-override'] = array( 96 | 'value' => get_post_meta( $post->ID, 'dominant_override', true ), 97 | 'class' => 'dominant-override', 98 | 'input' => 'hidden', 99 | ); 100 | 101 | $fields['dominant-color'] = array( 102 | 'value' => '', 103 | 'input' => 'html', 104 | 'html' => $html, 105 | 'label' => __( 'Dominant Color', 'dominant-color' ), 106 | ); 107 | return $fields; 108 | } 109 | 110 | // Save dominant-override. 111 | add_filter( 'attachment_fields_to_save', 'save_dominant_override', 10, 2 ); 112 | function save_dominant_override( $post, $attachment ) { 113 | if ( isset( $attachment['dominant-override'] ) ) { 114 | if ( $attachment['dominant-override'] == 'trigger-rebuild' ) { 115 | update_attachment_color_dominance( $post['ID'] ); 116 | } else { 117 | update_post_meta( $post['ID'], 'dominant_override', $attachment['dominant-override'] ); 118 | } 119 | } 120 | return $post; 121 | } 122 | 123 | // Even we use this now. Probably needs a major refactor in a future version. 124 | function get_color_data( $attachment_id, $thing_to_get, $no_rebuild = false, $allow_override = true ) { 125 | 126 | // If thing_to_get is dominant_color_hex or dominant_color_rgb, we should check if an override is set first. 127 | if ( $allow_override && ( $thing_to_get == 'dominant_color_hex' || $thing_to_get == 'dominant_color_rgb' ) ) { 128 | $data = get_post_meta( $attachment_id, 'dominant_override', true ); 129 | $data = trim( $data ); 130 | if ( $data && ! empty( $data ) ) { 131 | if ( $thing_to_get == 'dominant_color_hex' ) { 132 | return $data; 133 | } else { 134 | return hex2rgb( $data ); 135 | } 136 | } 137 | } 138 | 139 | $data = get_post_meta( $attachment_id, $thing_to_get, true ); 140 | if ( ! $data ) { 141 | if ( $no_rebuild ) { 142 | return false; 143 | } 144 | update_attachment_color_dominance( $attachment_id ); 145 | return get_post_meta( $attachment_id, $thing_to_get, true ); 146 | } else { 147 | return $data; 148 | } 149 | } 150 | 151 | /* Helper functions */ 152 | function rgb2hex( $rgb ) { 153 | $hex = '#'; 154 | $hex .= str_pad( dechex( $rgb[0] ), 2, '0', STR_PAD_LEFT ); 155 | $hex .= str_pad( dechex( $rgb[1] ), 2, '0', STR_PAD_LEFT ); 156 | $hex .= str_pad( dechex( $rgb[2] ), 2, '0', STR_PAD_LEFT ); 157 | 158 | return $hex; // returns the hex value including the number sign (#) 159 | } 160 | 161 | function hex2rgb( $color ) { 162 | $color = str_replace( '#', '', $color ); 163 | if ( strlen( $color ) != 6 ) { 164 | return array( 0, 0, 0 ); } 165 | $rgb = array(); 166 | for ( $x = 0;$x < 3;$x++ ) { 167 | $rgb[ $x ] = hexdec( substr( $color, ( 2 * $x ), 2 ) ); 168 | } 169 | return $rgb; 170 | } 171 | 172 | add_action( 'plugins_loaded', 'dominant_color_load_textdomain' ); 173 | function dominant_color_load_textdomain() { 174 | load_plugin_textdomain( 'dominant-color', false, plugin_basename( dirname( __FILE__ ) ) . '/languages' ); 175 | } 176 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------