image-widget.php
237 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Migration from Jetpack's Image Widget to WordPress' Core Image Widget. |
| 4 | * |
| 5 | * @since 4.9 |
| 6 | * |
| 7 | * @package automattic/jetpack |
| 8 | */ |
| 9 | |
| 10 | /** |
| 11 | * Migrates all active instances of Jetpack's image widget to Core's media image widget. |
| 12 | */ |
| 13 | function jetpack_migrate_image_widget() { |
| 14 | // Only trigger the migration from wp-admin. |
| 15 | if ( ! is_admin() ) { |
| 16 | return; |
| 17 | } |
| 18 | |
| 19 | // Only migrate if the new widget is available and we haven't yet migrated. |
| 20 | if ( ! class_exists( 'WP_Widget_Media_Image' ) || Jetpack_Options::get_option( 'image_widget_migration' ) ) { |
| 21 | return; |
| 22 | } |
| 23 | |
| 24 | $default_data = array( |
| 25 | 'attachment_id' => 0, |
| 26 | 'url' => '', |
| 27 | 'title' => '', |
| 28 | 'size' => 'custom', |
| 29 | 'width' => 0, |
| 30 | 'height' => 0, |
| 31 | 'align' => 'none', |
| 32 | 'caption' => '', |
| 33 | 'alt' => '', |
| 34 | 'link_type' => '', |
| 35 | 'link_url' => '', |
| 36 | 'image_classes' => '', |
| 37 | 'link_classes' => '', |
| 38 | 'link_rel' => '', |
| 39 | 'image_title' => '', |
| 40 | 'link_target_blank' => false, |
| 41 | 'conditions' => null, |
| 42 | ); |
| 43 | |
| 44 | $old_widgets = get_option( 'widget_image', array() ); |
| 45 | $media_image = get_option( 'widget_media_image', array() ); |
| 46 | $sidebars_widgets = wp_get_sidebars_widgets(); |
| 47 | |
| 48 | // Persist old and current widgets in backup table. |
| 49 | jetpack_store_migration_data( 'widget_image', maybe_serialize( $old_widgets ) ); |
| 50 | if ( jetpack_get_migration_data( 'widget_image' ) !== $old_widgets ) { |
| 51 | return false; |
| 52 | } |
| 53 | |
| 54 | jetpack_store_migration_data( 'sidebars_widgets', maybe_serialize( $sidebars_widgets ) ); |
| 55 | if ( jetpack_get_migration_data( 'sidebars_widgets' ) !== $sidebars_widgets ) { |
| 56 | return false; |
| 57 | } |
| 58 | |
| 59 | // Array to store legacy widget ids in to unregister on success. |
| 60 | $widgets_to_unregister = array(); |
| 61 | |
| 62 | foreach ( $old_widgets as $id => $widget ) { |
| 63 | if ( is_string( $id ) ) { |
| 64 | continue; |
| 65 | } |
| 66 | |
| 67 | // Can be caused by instanciating but not populating a widget in the Customizer. |
| 68 | if ( empty( $widget ) ) { |
| 69 | continue; |
| 70 | } |
| 71 | |
| 72 | // Ensure widget has no keys other than those expected. |
| 73 | // Not all widgets have conditions, so lets add it in. |
| 74 | $widget_copy = array_merge( array( 'conditions' => null ), $widget ); |
| 75 | $non_allowed_keys = array_diff_key( |
| 76 | $widget_copy, |
| 77 | array( |
| 78 | 'title' => '', |
| 79 | 'img_url' => '', |
| 80 | 'alt_text' => '', |
| 81 | 'img_title' => '', |
| 82 | 'caption' => '', |
| 83 | 'align' => '', |
| 84 | 'img_width' => '', |
| 85 | 'img_height' => '', |
| 86 | 'link' => '', |
| 87 | 'link_target_blank' => '', |
| 88 | 'conditions' => '', |
| 89 | ) |
| 90 | ); |
| 91 | |
| 92 | if ( $non_allowed_keys !== array() ) { |
| 93 | // skipping the widget in question. |
| 94 | continue; |
| 95 | } |
| 96 | |
| 97 | $media_image[ $id ] = array_merge( |
| 98 | $default_data, |
| 99 | $widget, |
| 100 | array( |
| 101 | 'alt' => $widget['alt_text'], |
| 102 | 'height' => $widget['img_height'], |
| 103 | 'image_classes' => ! empty( $widget['align'] ) ? 'align' . $widget['align'] : '', |
| 104 | 'image_title' => $widget['img_title'], |
| 105 | 'link_url' => $widget['link'], |
| 106 | 'url' => $widget['img_url'], |
| 107 | 'width' => $widget['img_width'], |
| 108 | ) |
| 109 | ); |
| 110 | |
| 111 | // Unsetting old widget fields. |
| 112 | $media_image[ $id ] = array_diff_key( |
| 113 | $media_image[ $id ], |
| 114 | array( |
| 115 | 'align' => false, |
| 116 | 'alt_text' => false, |
| 117 | 'img_height' => false, |
| 118 | 'img_title' => false, |
| 119 | 'img_url' => false, |
| 120 | 'img_width' => false, |
| 121 | 'link' => false, |
| 122 | ) |
| 123 | ); |
| 124 | |
| 125 | // Check if the image is in the media library. |
| 126 | $image_basename = basename( $widget['img_url'] ); |
| 127 | |
| 128 | if ( empty( $image_basename ) ) { |
| 129 | continue; |
| 130 | } |
| 131 | |
| 132 | $attachment_ids = get_posts( |
| 133 | array( |
| 134 | 'fields' => 'ids', |
| 135 | 'meta_query' => array( |
| 136 | array( |
| 137 | 'value' => basename( $image_basename ), |
| 138 | 'compare' => 'LIKE', |
| 139 | 'key' => '_wp_attachment_metadata', |
| 140 | ), |
| 141 | ), |
| 142 | 'post_status' => 'inherit', |
| 143 | 'post_type' => 'attachment', |
| 144 | 'suppress_filters' => false, |
| 145 | ) |
| 146 | ); |
| 147 | |
| 148 | foreach ( $attachment_ids as $attachment_id ) { |
| 149 | $image_meta = wp_get_attachment_metadata( $attachment_id ); |
| 150 | |
| 151 | // Is it a full size image? |
| 152 | $image_path_pieces = explode( '/', $image_meta['file'] ); |
| 153 | if ( array_pop( $image_path_pieces ) === $image_basename ) { |
| 154 | $media_image[ $id ]['attachment_id'] = $attachment_id; |
| 155 | |
| 156 | // Set correct size if dimensions fit. |
| 157 | if ( |
| 158 | $media_image[ $id ]['width'] == $image_meta['width'] || // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual |
| 159 | $media_image[ $id ]['height'] == $image_meta['height'] // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual |
| 160 | ) { |
| 161 | $media_image[ $id ]['size'] = 'full'; |
| 162 | } |
| 163 | break; |
| 164 | } |
| 165 | |
| 166 | // Is it a down-sized image? |
| 167 | foreach ( $image_meta['sizes'] as $size => $image ) { |
| 168 | if ( false !== array_search( $image_basename, $image, true ) ) { |
| 169 | $media_image[ $id ]['attachment_id'] = $attachment_id; |
| 170 | |
| 171 | // Set correct size if dimensions fit. |
| 172 | if ( |
| 173 | $media_image[ $id ]['width'] == $image['width'] || // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual |
| 174 | $media_image[ $id ]['height'] == $image['height'] // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual |
| 175 | ) { |
| 176 | $media_image[ $id ]['size'] = $size; |
| 177 | } |
| 178 | break 2; |
| 179 | } |
| 180 | } |
| 181 | } |
| 182 | |
| 183 | if ( ! empty( $widget['link'] ) ) { |
| 184 | $media_image[ $id ]['link_type'] = $widget['link'] === $widget['img_url'] ? 'file' : 'custom'; |
| 185 | } |
| 186 | |
| 187 | foreach ( $sidebars_widgets as $sidebar => $widgets ) { |
| 188 | $key = is_array( $widgets ) ? array_search( "image-{$id}", $widgets, true ) : false; |
| 189 | |
| 190 | if ( false !== $key ) { |
| 191 | $sidebars_widgets[ $sidebar ][ $key ] = "media_image-{$id}"; |
| 192 | } |
| 193 | } |
| 194 | |
| 195 | $widgets_to_unregister[] = $id; |
| 196 | } |
| 197 | |
| 198 | if ( update_option( 'widget_media_image', $media_image ) ) { |
| 199 | delete_option( 'widget_image' ); |
| 200 | |
| 201 | // Now un-register old widgets and register new. |
| 202 | foreach ( $widgets_to_unregister as $id ) { |
| 203 | wp_unregister_sidebar_widget( "image-{$id}" ); |
| 204 | |
| 205 | // register new widget. |
| 206 | $media_image_widget = new WP_Widget_Media_Image(); |
| 207 | $media_image_widget->_set( $id ); |
| 208 | $media_image_widget->_register_one( $id ); |
| 209 | } |
| 210 | |
| 211 | wp_set_sidebars_widgets( $sidebars_widgets ); |
| 212 | |
| 213 | // We need to refresh on widgets page for changes to take effect. |
| 214 | add_action( 'current_screen', 'jetpack_refresh_on_widget_page' ); |
| 215 | } else { |
| 216 | $widget_media_image = get_option( 'widget_media_image' ); |
| 217 | if ( is_array( $widget_media_image ) ) { |
| 218 | delete_option( 'widget_image' ); |
| 219 | } |
| 220 | } |
| 221 | |
| 222 | Jetpack_Options::update_option( 'image_widget_migration', true ); |
| 223 | } |
| 224 | add_action( 'widgets_init', 'jetpack_migrate_image_widget' ); |
| 225 | |
| 226 | /** |
| 227 | * Refresh the widgets page to save changes |
| 228 | * |
| 229 | * @param WP_Screen $current Current WP_Screen object. |
| 230 | */ |
| 231 | function jetpack_refresh_on_widget_page( $current ) { |
| 232 | if ( 'widgets' === $current->base ) { |
| 233 | wp_safe_redirect( admin_url( 'widgets.php' ) ); |
| 234 | exit; |
| 235 | } |
| 236 | } |
| 237 |