These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | /** |
||
3 | * Plugin Name: Dynamic Featured Image |
||
4 | * Plugin URI: http://wordpress.org/plugins/dynamic-featured-image/ |
||
5 | * Description: Dynamically adds multiple featured image or post thumbnail functionality to your posts, pages and custom post types. |
||
6 | * Version: 3.6.0 |
||
7 | * Author: Ankit Pokhrel |
||
8 | * Author URI: https://ankitpokhrel.com |
||
9 | * License: GPL2 or later |
||
10 | * License URI: http://www.gnu.org/licenses/gpl-2.0.html |
||
11 | * Text Domain: dynamic-featured-image |
||
12 | * Domain Path: /languages |
||
13 | * GitHub Plugin URI: https://github.com/ankitpokhrel/Dynamic-Featured-Image |
||
14 | * |
||
15 | * @package dynamic-featured-image |
||
16 | * |
||
17 | * Copyright (C) 2013 Ankit Pokhrel <[email protected], https://ankitpokhrel.com> |
||
18 | * |
||
19 | * This program is free software; you can redistribute it and/or modify |
||
20 | * it under the terms of the GNU General Public License as published by |
||
21 | * the Free Software Foundation; either version 3 of the License, or |
||
22 | * (at your option) any later version. |
||
23 | * |
||
24 | * This program is distributed in the hope that it will be useful, |
||
25 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
||
26 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||
27 | * GNU General Public License for more details. |
||
28 | * |
||
29 | * You should have received a copy of the GNU General Public License |
||
30 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
||
31 | */ |
||
32 | |||
33 | // Avoid direct calls to this file. |
||
34 | if ( ! defined( 'ABSPATH' ) ) { |
||
35 | header( 'Status: 403 Forbidden' ); |
||
36 | header( 'HTTP/1.1 403 Forbidden' ); |
||
37 | exit(); |
||
38 | } |
||
39 | |||
40 | /** |
||
41 | * Dynamic Featured Image plugin main class. |
||
42 | * |
||
43 | * @author Ankit Pokhrel <[email protected]> |
||
44 | * @version 3.0.1 |
||
45 | */ |
||
46 | class Dynamic_Featured_Image { |
||
47 | /** |
||
48 | * Current version of the plugin. |
||
49 | * |
||
50 | * @since 3.0.0 |
||
51 | */ |
||
52 | const VERSION = '3.6.0'; |
||
53 | |||
54 | /** |
||
55 | * Text domain. |
||
56 | * |
||
57 | * @since 3.6.0 |
||
58 | */ |
||
59 | const TEXT_DOMAIN = 'dynamic-featured-image'; |
||
60 | |||
61 | /** |
||
62 | * Documentation Link. |
||
63 | * |
||
64 | * @since 3.6.0 |
||
65 | */ |
||
66 | const WIKI_LINK = 'https://github.com/ankitpokhrel/Dynamic-Featured-Image/wiki/'; |
||
67 | |||
68 | /** |
||
69 | * Upgrade Link. |
||
70 | * |
||
71 | * @since 3.6.0 |
||
72 | */ |
||
73 | const UPGRADE_LINK = 'https://ankitpokhrel.com/explore/dynamic-featured-image-pro/'; |
||
74 | |||
75 | /** |
||
76 | * Image upload directory. |
||
77 | * |
||
78 | * @var $upload_dir string |
||
79 | */ |
||
80 | private $upload_dir; |
||
81 | |||
82 | /** |
||
83 | * Image upload URL. |
||
84 | * |
||
85 | * @var $upload_url string |
||
86 | */ |
||
87 | private $upload_url; |
||
88 | |||
89 | /** |
||
90 | * Database object. |
||
91 | * |
||
92 | * @var $db wpdb |
||
93 | */ |
||
94 | private $db; |
||
95 | |||
96 | /** |
||
97 | * Title for dfi metabox. |
||
98 | * |
||
99 | * @var $metabox_title string |
||
100 | */ |
||
101 | protected $metabox_title; |
||
102 | |||
103 | /** |
||
104 | * Users post type filter for dfi metabox. |
||
105 | * |
||
106 | * @var $user_filter array |
||
107 | */ |
||
108 | protected $user_filter; |
||
109 | |||
110 | /** |
||
111 | * Constructor. Hooks all interactions to initialize the class. |
||
112 | * |
||
113 | * @since 1.0.0 |
||
114 | * @access public |
||
115 | * @global object $wpdb |
||
116 | * |
||
117 | * @see add_action() |
||
118 | */ |
||
119 | public function __construct() { |
||
120 | // plugin update warning. |
||
121 | add_action( 'in_plugin_update_message-' . plugin_basename( __FILE__ ), array( $this, 'update_notice' ) ); |
||
122 | |||
123 | add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) ); |
||
124 | add_action( 'add_meta_boxes', array( $this, 'initialize_featured_box' ) ); |
||
125 | add_action( 'save_post', array( $this, 'save_meta' ) ); |
||
126 | add_action( 'plugins_loaded', array( $this, 'load_plugin_textdomain' ) ); |
||
127 | |||
128 | // handle ajax request. |
||
129 | add_action( 'wp_ajax_dfiMetaBox_callback', array( $this, 'ajax_callback' ) ); |
||
130 | |||
131 | // add action links. |
||
132 | add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), array( $this, 'dfi_action_links' ) ); |
||
133 | |||
134 | // media uploader custom fields. |
||
135 | add_filter( 'attachment_fields_to_edit', array( $this, 'media_attachment_custom_fields' ), 10, 2 ); |
||
136 | add_filter( 'attachment_fields_to_save', array( $this, 'media_attachment_custom_fields_save' ), 10, 2 ); |
||
137 | |||
138 | // get the site protocol. |
||
139 | $protocol = $this->get_protocol(); |
||
140 | |||
141 | $this->upload_dir = wp_upload_dir(); |
||
142 | $this->upload_url = preg_replace( '#^https?://#', '', $this->upload_dir['baseurl'] ); |
||
143 | |||
144 | // add protocol to the upload url. |
||
145 | $this->upload_url = $protocol . $this->upload_url; |
||
146 | |||
147 | // post type filter added by user. |
||
148 | $this->user_filter = array(); |
||
149 | |||
150 | global $wpdb; |
||
151 | $this->db = $wpdb; |
||
152 | } |
||
153 | |||
154 | /** |
||
155 | * Return site protocol. |
||
156 | * |
||
157 | * @since 3.5.1 |
||
158 | * @access public |
||
159 | * |
||
160 | * @return string |
||
161 | */ |
||
162 | private function get_protocol() { |
||
163 | return is_ssl() ? 'https://' : 'http://'; |
||
164 | } |
||
165 | |||
166 | /** |
||
167 | * Add required admin scripts. |
||
168 | * |
||
169 | * @since 1.0.0 |
||
170 | * @access public |
||
171 | * |
||
172 | * @see wp_enque_style() |
||
173 | * @see wp_register_script() |
||
174 | * @see wp_enqueue_script() |
||
175 | * |
||
176 | * @return void |
||
177 | */ |
||
178 | public function enqueue_admin_scripts() { |
||
179 | // enqueue styles. |
||
180 | wp_enqueue_style( 'style-dfi', plugins_url( '/css/style-dfi.css', __FILE__ ), array(), self::VERSION ); |
||
181 | |||
182 | // register script. |
||
183 | wp_register_script( 'scripts-dfi', plugins_url( '/js/script-dfi.js', __FILE__ ), array( 'jquery' ), self::VERSION ); |
||
184 | |||
185 | // localize the script with required data. |
||
186 | wp_localize_script( |
||
187 | 'scripts-dfi', |
||
188 | 'DFI_SPECIFIC', |
||
189 | array( |
||
190 | 'upload_url' => $this->upload_url, |
||
191 | 'metabox_title' => __( $this->metabox_title, self::TEXT_DOMAIN ), |
||
192 | 'mediaSelector_title' => __( 'Dynamic Featured Image - Media Selector', self::TEXT_DOMAIN ), |
||
193 | 'mediaSelector_buttonText' => __( 'Set Featured Image', self::TEXT_DOMAIN ), |
||
194 | 'ajax_nonce' => wp_create_nonce( plugin_basename( __FILE__ ) ), |
||
195 | ) |
||
196 | ); |
||
197 | |||
198 | // enqueue scripts. |
||
199 | wp_enqueue_script( 'scripts-dfi' ); |
||
200 | } |
||
201 | |||
202 | /** |
||
203 | * Add upgrade link. |
||
204 | * |
||
205 | * @access public |
||
206 | * @since 3.5.1 |
||
207 | * @action plugin_action_links |
||
208 | * |
||
209 | * @codeCoverageIgnore |
||
210 | * |
||
211 | * @param array $links Action links. |
||
212 | * |
||
213 | * @return array |
||
214 | */ |
||
215 | public function dfi_action_links( $links ) { |
||
216 | $upgrade_link = array( |
||
217 | '<a href="' . self::UPGRADE_LINK . '" target="_blank">Upgrade to Premium</a>' |
||
218 | ); |
||
219 | |||
220 | return array_merge( $links, $upgrade_link ); |
||
221 | } |
||
222 | |||
223 | /** |
||
224 | * Add featured meta boxes dynamically. |
||
225 | * |
||
226 | * @since 1.0.0 |
||
227 | * @access public |
||
228 | * @global object $post |
||
229 | * |
||
230 | * @see get_post_meta() |
||
231 | * @see get_post_types() |
||
232 | * @see add_meta_box() |
||
233 | * @see add_filter() |
||
234 | * |
||
235 | * @return void |
||
236 | */ |
||
237 | public function initialize_featured_box() { |
||
238 | global $post; |
||
239 | |||
240 | // make metabox title dynamic. |
||
241 | $this->metabox_title = apply_filters( 'dfi_set_metabox_title', __( 'Featured Image', self::TEXT_DOMAIN ) ); |
||
242 | |||
243 | $featured_data = get_post_meta( $post->ID, 'dfiFeatured', true ); |
||
244 | $total_featured = count( $featured_data ); |
||
245 | |||
246 | $default_filter = array( 'attachment', 'revision', 'nav_menu_item' ); |
||
247 | $this->user_filter = apply_filters( 'dfi_post_type_user_filter', $this->user_filter ); |
||
248 | |||
249 | $post_types = array_diff( get_post_types(), array_merge( $default_filter, $this->user_filter ) ); |
||
250 | $post_types = apply_filters( 'dfi_post_types', $post_types ); |
||
251 | |||
252 | if ( ! empty( $featured_data ) && $total_featured >= 1 ) { |
||
253 | $i = 2; |
||
254 | foreach ( $featured_data as $featured ) { |
||
255 | $this->dfi_add_meta_box( $post_types, $featured, $i++ ); |
||
256 | } |
||
257 | } else { |
||
258 | $this->dfi_add_meta_box( $post_types ); |
||
259 | } |
||
260 | } |
||
261 | |||
262 | /** |
||
263 | * Translates more than one digit number digit by digit. |
||
264 | * |
||
265 | * @param int $number Integer to be translated. |
||
266 | * |
||
267 | * @return string Translated number |
||
268 | */ |
||
269 | protected function get_number_translation( $number ) { |
||
270 | if ( $number <= 9 ) { |
||
271 | return __( $number, self::TEXT_DOMAIN ); |
||
272 | } else { |
||
273 | $pieces = str_split( $number, 1 ); |
||
274 | $buffer = ''; |
||
275 | foreach ( $pieces as $piece ) { |
||
276 | $buffer .= __( $piece, self::TEXT_DOMAIN ); |
||
277 | } |
||
278 | |||
279 | return $buffer; |
||
280 | } |
||
281 | } |
||
282 | |||
283 | /** |
||
284 | * Adds meta boxes. |
||
285 | * |
||
286 | * @param array $post_types Post types to show featured image box. |
||
287 | * @param object $featured Callback arguments. |
||
288 | * @param int $i Index of the featured image. |
||
289 | * |
||
290 | * @return void |
||
291 | */ |
||
292 | private function dfi_add_meta_box( $post_types, $featured = null, $i = null ) { |
||
293 | if ( ! is_null( $i ) ) { |
||
294 | foreach ( $post_types as $type ) { |
||
295 | add_meta_box( |
||
296 | 'dfiFeaturedMetaBox-' . $i, |
||
297 | __( $this->metabox_title, self::TEXT_DOMAIN ) . ' ' . $this->get_number_translation( $i ), |
||
298 | array( $this, 'featured_meta_box' ), |
||
299 | $type, |
||
300 | 'side', |
||
301 | 'low', |
||
302 | array( $featured, $i + 1 ) |
||
303 | ); |
||
304 | |||
305 | add_filter( "postbox_classes_{$type}_dfiFeaturedMetaBox-" . $i, array( $this, 'add_metabox_classes' ) ); |
||
306 | } |
||
307 | } else { |
||
308 | foreach ( $post_types as $type ) { |
||
309 | add_meta_box( |
||
310 | 'dfiFeaturedMetaBox', |
||
311 | __( $this->metabox_title, self::TEXT_DOMAIN ) . ' ' . __( 2, self::TEXT_DOMAIN ), |
||
312 | array( $this, 'featured_meta_box' ), |
||
313 | $type, |
||
314 | 'side', |
||
315 | 'low', |
||
316 | array( null, null ) |
||
317 | ); |
||
318 | |||
319 | add_filter( "postbox_classes_{$type}_dfiFeaturedMetaBox", array( $this, 'add_metabox_classes' ) ); |
||
320 | } |
||
321 | } |
||
322 | } |
||
323 | |||
324 | /** |
||
325 | * Separate thumb and full image url from given URL string. |
||
326 | * |
||
327 | * @since 3.3.1 |
||
328 | * |
||
329 | * @param string $url_string Url string. |
||
330 | * @param string $state Thumb or full. |
||
331 | * |
||
332 | * @return string|null |
||
333 | */ |
||
334 | private function separate( $url_string, $state = 'thumb' ) { |
||
335 | $image_piece = explode( ',', $url_string ); |
||
336 | |||
337 | if ( 'thumb' === $state ) { |
||
338 | return isset( $image_piece[0] ) ? $image_piece[0] : null; |
||
339 | } |
||
340 | |||
341 | return isset( $image_piece[1] ) ? $image_piece[1] : null; |
||
342 | } |
||
343 | |||
344 | /** |
||
345 | * Create a nonce field. |
||
346 | * |
||
347 | * @since 3.5.0 |
||
348 | * |
||
349 | * @see wp_nonce_field() |
||
350 | * @see plugin_basename() |
||
351 | * |
||
352 | * @codeCoverageIgnore |
||
353 | * |
||
354 | * @param string $key Nonce key. |
||
355 | * |
||
356 | * @return string |
||
357 | */ |
||
358 | protected function nonce_field( $key ) { |
||
359 | return wp_nonce_field( plugin_basename( __FILE__ ), $key, true, false ); |
||
360 | } |
||
361 | |||
362 | /** |
||
363 | * Featured meta box as seen in the admin. |
||
364 | * |
||
365 | * @since 1.0.0 |
||
366 | * @access public |
||
367 | * |
||
368 | * @param object $post Global post object. |
||
369 | * @param array $featured Array containing featured image count. |
||
370 | * |
||
371 | * @throws Exception Medium size image not found. |
||
372 | * @return void |
||
373 | */ |
||
374 | public function featured_meta_box( $post, $featured ) { |
||
375 | $featured_img = $featured['args'][0]; |
||
376 | $featured_id = is_null( $featured['args'][1] ) ? 2 : --$featured['args'][1]; |
||
377 | $featured_img_full = $featured_img; |
||
378 | $featured_img_trimmed = $featured_img; |
||
379 | |||
380 | if ( ! is_null( $featured_img ) ) { |
||
381 | $featured_img_trimmed = $this->separate( $featured_img ); |
||
382 | $featured_img_full = $this->separate( $featured_img, 'full' ); |
||
383 | } |
||
384 | |||
385 | $thumbnail = $this->get_image_thumb( $this->upload_url . $featured_img_full, 'medium' ); |
||
386 | if ( empty( $thumbnail ) ) { |
||
387 | // since medium sized thumbnail image is missing, |
||
388 | // let's set full image url as thumbnail. |
||
389 | $thumbnail = $featured_img_full; |
||
390 | } |
||
391 | |||
392 | // Add a nonce field. |
||
393 | echo $this->nonce_field( 'dfi_fimageplug-' . $featured_id ); // WPCS: XSS ok. |
||
394 | echo $this->get_featured_box( $featured_img_trimmed, $featured_img, $featured_id, $thumbnail, $post->ID ); // WPCS: XSS ok. |
||
395 | } |
||
396 | |||
397 | /** |
||
398 | * Returns featured box html content. |
||
399 | * |
||
400 | * @since 3.1.0 |
||
401 | * @access private |
||
402 | * |
||
403 | * @param string $featured_img_trimmed Medium sized image. |
||
404 | * @param string $featured_img Full sized image. |
||
405 | * @param string $featured_id Attachment Id. |
||
406 | * @param string $thumbnail Thumb sized image. |
||
407 | * @param int $post_id Post id. |
||
408 | * |
||
409 | * @return string Html content |
||
410 | */ |
||
411 | private function get_featured_box( $featured_img_trimmed, $featured_img, $featured_id, $thumbnail, $post_id ) { |
||
412 | $has_featured_image = ! empty( $featured_img_trimmed ) ? 'hasFeaturedImage' : ''; |
||
413 | $thumbnail = ! is_null( $thumbnail ) ? $thumbnail : ''; |
||
414 | $dfi_empty = is_null( $featured_img_trimmed ) ? 'dfiImgEmpty' : ''; |
||
415 | |||
416 | return "<a href='javascript:void(0)' class='dfiFeaturedImage {$has_featured_image}' title='" . __( 'Set Featured Image', self::TEXT_DOMAIN ) . "' data-post-id='" . $post_id . "'><span class='dashicons dashicons-camera'></span></a><br/> |
||
417 | <img src='" . $thumbnail . "' class='dfiImg {$dfi_empty}'/> |
||
418 | <div class='dfiLinks'> |
||
419 | <a href='javascript:void(0)' data-id='{$featured_id}' data-id-local='" . $this->get_number_translation( $featured_id + 1 ) . "' class='dfiAddNew dashicons dashicons-plus' title='" . __( 'Add New', self::TEXT_DOMAIN ) . "'></a> |
||
420 | <a href='javascript:void(0)' class='dfiRemove dashicons dashicons-minus' title='" . __( 'Remove', self::TEXT_DOMAIN ) . "'></a> |
||
421 | </div> |
||
422 | <div class='dfiClearFloat'></div> |
||
423 | <input type='hidden' name='dfiFeatured[]' value='{$featured_img}' class='dfiImageHolder' />"; |
||
424 | } |
||
425 | |||
426 | /** |
||
427 | * Load new featured meta box via ajax. |
||
428 | * |
||
429 | * @since 1.0.0 |
||
430 | * @access public |
||
431 | * |
||
432 | * @return void |
||
433 | */ |
||
434 | public function ajax_callback() { |
||
435 | check_ajax_referer( plugin_basename( __FILE__ ), 'security' ); |
||
436 | |||
437 | $featured_id = isset( $_POST['id'] ) ? intval( wp_unslash( $_POST['id'] ) ) : null; |
||
438 | |||
439 | if ( ! is_numeric( $featured_id ) ) { |
||
440 | return; |
||
441 | } |
||
442 | |||
443 | // @codingStandardsIgnoreStart |
||
444 | echo $this->nonce_field( 'dfi_fimageplug-' . $featured_id ); |
||
445 | ?> |
||
446 | <a href="javascript:void(0)" class="dfiFeaturedImage" |
||
447 | title="<?php echo __( 'Set Featured Image', self::TEXT_DOMAIN ) ?>"><span |
||
448 | class="dashicons dashicons-camera"></span></a><br/> |
||
449 | <img src="" class="dfiImg dfiImgEmpty"/> |
||
450 | <div class="dfiLinks"> |
||
451 | <a href="javascript:void(0)" data-id="<?php echo $featured_id ?>" |
||
452 | data-id-local="<?php echo $this->get_number_translation( $featured_id + 1 ) ?>" |
||
453 | class="dfiAddNew dashicons dashicons-plus" title="<?php echo __( 'Add New', self::TEXT_DOMAIN ) ?>"></a> |
||
454 | <a href="javascript:void(0)" class="dfiRemove dashicons dashicons-minus" |
||
455 | title="<?php echo __( 'Remove', self::TEXT_DOMAIN ) ?>"></a> |
||
456 | </div> |
||
457 | <div class="dfiClearFloat"></div> |
||
458 | <input type="hidden" name="dfiFeatured[]" value="" class="dfiImageHolder"/> |
||
459 | <?php |
||
460 | // @codingStandardsIgnoreEnd |
||
461 | wp_die( '' ); |
||
462 | } |
||
463 | |||
464 | /** |
||
465 | * Add custom class 'featured-meta-box' to meta box. |
||
466 | * |
||
467 | * @since 1.0.0 |
||
468 | * @access public |
||
469 | * |
||
470 | * @see add_metabox_classes |
||
471 | * |
||
472 | * @param array $classes Classes to add in the meta box. |
||
473 | * |
||
474 | * @return array |
||
475 | */ |
||
476 | public function add_metabox_classes( $classes ) { |
||
477 | array_push( $classes, 'featured-meta-box' ); |
||
478 | |||
479 | return $classes; |
||
480 | } |
||
481 | |||
482 | /** |
||
483 | * Add custom fields in media uploader. |
||
484 | * |
||
485 | * @since 3.4.0 |
||
486 | * |
||
487 | * @param array $form_fields Fields to include in media attachment form. |
||
488 | * @param array $post Post data. |
||
489 | * |
||
490 | * @return array |
||
491 | */ |
||
492 | public function media_attachment_custom_fields( $form_fields, $post ) { |
||
493 | $form_fields['dfi-link-to-image'] = array( |
||
494 | 'label' => __( 'Link to Image', self::TEXT_DOMAIN ), |
||
495 | 'input' => 'text', |
||
496 | 'value' => get_post_meta( $post->ID, '_dfi_link_to_image', true ), |
||
497 | ); |
||
498 | |||
499 | return $form_fields; |
||
500 | } |
||
501 | |||
502 | /** |
||
503 | * Save values of media uploader custom fields. |
||
504 | * |
||
505 | * @since 3.4.0 |
||
506 | * |
||
507 | * @param array $post Post data for database. |
||
508 | * @param array $attachment Attachment fields from $_POST form. |
||
509 | * |
||
510 | * @return array |
||
511 | */ |
||
512 | public function media_attachment_custom_fields_save( $post, $attachment ) { |
||
513 | if ( isset( $attachment['dfi-link-to-image'] ) ) { |
||
514 | update_post_meta( $post['ID'], '_dfi_link_to_image', $attachment['dfi-link-to-image'] ); |
||
515 | } |
||
516 | |||
517 | return $post; |
||
518 | } |
||
519 | |||
520 | /** |
||
521 | * Update featured images in the database. |
||
522 | * |
||
523 | * @since 1.0.0 |
||
524 | * @access public |
||
525 | * |
||
526 | * @see plugin_basename() |
||
527 | * @see update_post_meta() |
||
528 | * @see current_user_can() |
||
529 | * |
||
530 | * @param int $post_id Current post id. |
||
531 | * |
||
532 | * @return bool|null |
||
533 | */ |
||
534 | public function save_meta( $post_id ) { |
||
535 | // Check auto save. |
||
536 | if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) { |
||
537 | return false; |
||
538 | } |
||
539 | |||
540 | if ( ! $this->verify_nonces() ) { |
||
541 | return false; |
||
542 | } |
||
543 | |||
544 | // Check permission before saving data. |
||
545 | if ( current_user_can( 'edit_posts', $post_id ) && isset( $_POST['dfiFeatured'] ) ) { // WPCS: CSRF ok. |
||
546 | $featured_images = is_array( $_POST['dfiFeatured'] ) ? $_POST['dfiFeatured'] : array(); // WPCS: sanitization ok, CSRF ok. |
||
547 | |||
548 | update_post_meta( $post_id, 'dfiFeatured', $this->sanitize_array( $featured_images ) ); |
||
549 | } |
||
550 | } |
||
551 | |||
552 | /** |
||
553 | * Sanitize array. |
||
554 | * |
||
555 | * @since 3.6.0 |
||
556 | * @access protected |
||
557 | * |
||
558 | * @param array $input_array Input array. |
||
559 | * |
||
560 | * @return array |
||
561 | */ |
||
562 | protected function sanitize_array( $input_array ) { |
||
563 | $sanitized = array(); |
||
564 | |||
565 | foreach ( $input_array as $value ) { |
||
566 | $sanitized[] = sanitize_text_field( wp_unslash( $value ) ); |
||
567 | } |
||
568 | |||
569 | return $sanitized; |
||
570 | } |
||
571 | |||
572 | /** |
||
573 | * Verify metabox nonces. |
||
574 | * |
||
575 | * @access protected |
||
576 | * @see wp_verify_nonce() |
||
577 | * |
||
578 | * @return bool |
||
579 | */ |
||
580 | protected function verify_nonces() { |
||
0 ignored issues
–
show
|
|||
581 | $keys = preg_grep( '/dfi_fimageplug-\d+$/', array_keys( $_POST ) ); // WPCS: CSRF ok. |
||
582 | |||
583 | if ( empty( $keys ) ) { |
||
584 | return false; |
||
585 | } |
||
586 | |||
587 | foreach ( $keys as $key ) { |
||
588 | // Verify nonce. |
||
589 | if ( ! isset( $_POST[ $key ] ) || |
||
590 | ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST[ $key ] ) ), plugin_basename( __FILE__ ) ) |
||
591 | ) { |
||
592 | return false; |
||
593 | } |
||
594 | } |
||
595 | |||
596 | return true; |
||
597 | } |
||
598 | |||
599 | /** |
||
600 | * Add update notice. Displayed in plugin update page. |
||
601 | * |
||
602 | * @since 2.0.0 |
||
603 | * @access public |
||
604 | * |
||
605 | * @return void |
||
606 | */ |
||
607 | public function update_notice() { |
||
608 | $info = __( 'ATTENTION! Please read the <a href="' . self::WIKI_LINK . '" target="_blank">DOCUMENTATION</a> properly before update.', |
||
609 | self::TEXT_DOMAIN ); |
||
610 | |||
611 | echo '<span style="color: red; padding: 7px 0; display: block">' . strip_tags( $info, '<a><b><i><span>' ) . '</span>'; // WPCS: XSS ok. |
||
612 | } |
||
613 | |||
614 | /** |
||
615 | * Execute query. |
||
616 | * |
||
617 | * @param string $query Query to execute. |
||
618 | * |
||
619 | * @return null|string |
||
620 | */ |
||
621 | private function execute_query( $query ) { |
||
622 | return $this->db->get_var( $query ); |
||
623 | } |
||
624 | |||
625 | /** |
||
626 | * Get attachment id of the image by image url. |
||
627 | * |
||
628 | * @since 3.1.7 |
||
629 | * @access protected |
||
630 | * @global object $wpdb |
||
631 | * |
||
632 | * @param string $image_url URL of an image. |
||
633 | * |
||
634 | * @return string |
||
635 | */ |
||
636 | protected function get_attachment_id( $image_url ) { |
||
637 | return $this->execute_query( $this->db->prepare( 'SELECT ID FROM ' . $this->db->posts . ' WHERE guid = %s', $image_url ) ); |
||
638 | } |
||
639 | |||
640 | /** |
||
641 | * Get image url of the image by attachment id. |
||
642 | * |
||
643 | * @since 2.0.0 |
||
644 | * @access public |
||
645 | * |
||
646 | * @see wp_get_attachment_image_src() |
||
647 | * |
||
648 | * @param int $attachment_id attachment id of an image. |
||
649 | * @param string $size size of the image to fetch (thumbnail, medium, full). |
||
650 | * |
||
651 | * @return string |
||
652 | */ |
||
653 | public function get_image_url( $attachment_id, $size = 'full' ) { |
||
654 | $image_thumb = wp_get_attachment_image_src( $attachment_id, $size ); |
||
655 | |||
656 | return empty( $image_thumb ) ? null : $image_thumb[0]; |
||
657 | } |
||
658 | |||
659 | /** |
||
660 | * Get image thumbnail url of specific size by image url. |
||
661 | * |
||
662 | * @since 2.0.0 |
||
663 | * @access public |
||
664 | * |
||
665 | * @see get_image_id() |
||
666 | * @see wp_get_attachment_image_src() |
||
667 | * |
||
668 | * @param string $image_url url of an image. |
||
669 | * @param string $size size of the image to fetch (thumbnail, medium, full). |
||
670 | * |
||
671 | * @return string |
||
672 | */ |
||
673 | public function get_image_thumb( $image_url, $size = 'thumbnail' ) { |
||
674 | $attachment_id = $this->get_image_id( $image_url ); |
||
675 | $image_thumb = wp_get_attachment_image_src( $attachment_id, $size ); |
||
676 | |||
677 | return empty( $image_thumb ) ? null : $image_thumb[0]; |
||
678 | } |
||
679 | |||
680 | /** |
||
681 | * Gets attachment id from given image url. |
||
682 | * |
||
683 | * @param string $image_url url of an image. |
||
684 | * |
||
685 | * @since 2.0.0 |
||
686 | * @access public |
||
687 | * |
||
688 | * @return int|null attachment id of an image |
||
689 | */ |
||
690 | public function get_image_id( $image_url ) { |
||
691 | $attachment_id = $this->get_attachment_id( $image_url ); |
||
692 | |||
693 | if ( is_null( $attachment_id ) ) { |
||
694 | // check if the image is edited image. |
||
695 | // and try to get the attachment id. |
||
696 | $image_url = str_replace( $this->upload_url . '/', '', $image_url ); |
||
697 | $row = $this->execute_query( $this->db->prepare( 'SELECT post_id FROM ' . $this->db->postmeta . ' WHERE meta_value = %s', $image_url ) ); |
||
698 | if ( ! is_null( $row ) ) { |
||
699 | $attachment_id = $row; |
||
700 | } |
||
701 | } |
||
702 | |||
703 | return $attachment_id; |
||
704 | } |
||
705 | |||
706 | /** |
||
707 | * Get image title. |
||
708 | * |
||
709 | * @since 2.0.0 |
||
710 | * @access public |
||
711 | * |
||
712 | * @param string $image_url URL of an image. |
||
713 | * |
||
714 | * @return string |
||
715 | */ |
||
716 | public function get_image_title( $image_url ) { |
||
717 | return $this->execute_query( $this->db->prepare( 'SELECT post_title FROM ' . $this->db->posts . ' WHERE guid = %s', $image_url ) ); |
||
718 | } |
||
719 | |||
720 | /** |
||
721 | * Get image title by id. |
||
722 | * |
||
723 | * @since 2.0.0 |
||
724 | * @access public |
||
725 | * |
||
726 | * @param int $attachment_id Attachment id of an image. |
||
727 | * |
||
728 | * @return string |
||
729 | */ |
||
730 | public function get_image_title_by_id( $attachment_id ) { |
||
731 | return $this->execute_query( $this->db->prepare( 'SELECT post_title FROM ' . $this->db->posts . ' WHERE ID = %d', $attachment_id ) ); |
||
732 | } |
||
733 | |||
734 | /** |
||
735 | * Get image caption. |
||
736 | * |
||
737 | * @since 2.0.0 |
||
738 | * @access public |
||
739 | * |
||
740 | * @param string $image_url URL of an image. |
||
741 | * |
||
742 | * @return string |
||
743 | */ |
||
744 | public function get_image_caption( $image_url ) { |
||
745 | return $this->execute_query( $this->db->prepare( 'SELECT post_excerpt FROM ' . $this->db->posts . ' WHERE guid = %s', $image_url ) ); |
||
746 | } |
||
747 | |||
748 | /** |
||
749 | * Get image caption by id. |
||
750 | * |
||
751 | * @since 2.0.0 |
||
752 | * @access public |
||
753 | * |
||
754 | * @param int $attachment_id Attachment id of an image. |
||
755 | * |
||
756 | * @return string |
||
757 | */ |
||
758 | public function get_image_caption_by_id( $attachment_id ) { |
||
759 | return $this->execute_query( $this->db->prepare( 'SELECT post_excerpt FROM ' . $this->db->posts . ' WHERE ID = %d', $attachment_id ) ); |
||
760 | } |
||
761 | |||
762 | /** |
||
763 | * Get image alternate text. |
||
764 | * |
||
765 | * @since 2.0.0 |
||
766 | * @access public |
||
767 | * |
||
768 | * @see get_post_meta() |
||
769 | * |
||
770 | * @param string $image_url URL of an image. |
||
771 | * |
||
772 | * @return string |
||
773 | */ |
||
774 | public function get_image_alt( $image_url ) { |
||
775 | $attachment = $this->db->get_col( $this->db->prepare( 'SELECT ID FROM ' . $this->db->posts . ' WHERE guid = %s', $image_url ) ); |
||
776 | |||
777 | $alt = null; |
||
778 | if ( ! empty( $attachment ) ) { |
||
779 | $alt = get_post_meta( $attachment[0], '_wp_attachment_image_alt' ); |
||
780 | } |
||
781 | |||
782 | return ( is_null( $alt ) || empty( $alt ) ) ? null : $alt[0]; |
||
783 | } |
||
784 | |||
785 | /** |
||
786 | * Get image alternate text by attachment id. |
||
787 | * |
||
788 | * @since 2.0.0 |
||
789 | * @access public |
||
790 | * |
||
791 | * @see get_post_meta() |
||
792 | * |
||
793 | * @param int $attachment_id Attachment id of an image. |
||
794 | * |
||
795 | * @return string |
||
796 | */ |
||
797 | public function get_image_alt_by_id( $attachment_id ) { |
||
798 | $alt = get_post_meta( $attachment_id, '_wp_attachment_image_alt' ); |
||
799 | |||
800 | return empty( $alt ) ? null : $alt[0]; |
||
801 | } |
||
802 | |||
803 | /** |
||
804 | * Get image description. |
||
805 | * |
||
806 | * @since 3.0.0 |
||
807 | * @access public |
||
808 | * |
||
809 | * @param string $image_url URL of an image. |
||
810 | * |
||
811 | * @return string |
||
812 | */ |
||
813 | public function get_image_description( $image_url ) { |
||
814 | return $this->execute_query( $this->db->prepare( 'SELECT post_content FROM ' . $this->db->posts . ' WHERE guid = %s', $image_url ) ); |
||
815 | } |
||
816 | |||
817 | /** |
||
818 | * Get image description by id. |
||
819 | * |
||
820 | * @since 3.0.0 |
||
821 | * @access public |
||
822 | * |
||
823 | * @param int $attachment_id attachment id of an image. |
||
824 | * |
||
825 | * @return string |
||
826 | */ |
||
827 | public function get_image_description_by_id( $attachment_id ) { |
||
828 | return $this->execute_query( $this->db->prepare( 'SELECT post_content FROM ' . $this->db->posts . ' WHERE ID = %d', $attachment_id ) ); |
||
829 | } |
||
830 | |||
831 | /** |
||
832 | * Get link to image. |
||
833 | * |
||
834 | * @since 3.4.0 |
||
835 | * @access public |
||
836 | * |
||
837 | * @param int $attachment_id Attachment id of an image. |
||
838 | * |
||
839 | * @return string|null |
||
840 | */ |
||
841 | public function get_link_to_image( $attachment_id ) { |
||
842 | return get_post_meta( $attachment_id, '_dfi_link_to_image', true ); |
||
843 | } |
||
844 | |||
845 | /** |
||
846 | * Get all attachment ids of the post. |
||
847 | * |
||
848 | * @since 2.0.0 |
||
849 | * @access public |
||
850 | * |
||
851 | * @see get_post_meta() |
||
852 | * |
||
853 | * @param int $post_id id of the current post. |
||
854 | * |
||
855 | * @return array |
||
856 | */ |
||
857 | public function get_post_attachment_ids( $post_id ) { |
||
858 | $dfi_images = get_post_meta( $post_id, 'dfiFeatured', true ); |
||
859 | $ret_val = array(); |
||
860 | |||
861 | if ( ! empty( $dfi_images ) && is_array( $dfi_images ) ) { |
||
862 | foreach ( $dfi_images as $dfi_image ) { |
||
863 | $dfi_image_full = $this->separate( $dfi_image, 'full' ); |
||
864 | $ret_val[] = (int) $this->get_image_id( $this->upload_url . $dfi_image_full ); |
||
865 | } |
||
866 | } |
||
867 | |||
868 | return $ret_val; |
||
869 | } |
||
870 | |||
871 | /** |
||
872 | * Get real post id. |
||
873 | * |
||
874 | * @since 3.6.0 |
||
875 | * @access protected |
||
876 | * |
||
877 | * @param int|null $post_id Post id. |
||
878 | * |
||
879 | * @return int|null |
||
880 | */ |
||
881 | protected function get_real_post_id( $post_id = null ) { |
||
882 | if ( ! is_null( $post_id ) && is_numeric( $post_id ) ) { |
||
883 | return $post_id; |
||
884 | } |
||
885 | |||
886 | global $post; |
||
887 | |||
888 | return $post->ID; |
||
889 | } |
||
890 | |||
891 | /** |
||
892 | * Fetches featured image data of nth position. |
||
893 | * |
||
894 | * @since 3.0.0 |
||
895 | * @access public |
||
896 | * |
||
897 | * @see get_featured_images() |
||
898 | * |
||
899 | * @param int $position Position of the featured image. |
||
900 | * @param int $post_id Current post id. |
||
901 | * |
||
902 | * @return array if found, null otherwise. |
||
903 | */ |
||
904 | public function get_nth_featured_image( $position, $post_id = null ) { |
||
905 | $post_id = $this->get_real_post_id( ( $post_id ) ); |
||
906 | |||
907 | $featured_images = $this->get_featured_images( $post_id ); |
||
908 | |||
909 | return isset( $featured_images[ $position - 2 ] ) ? $featured_images[ $position - 2 ] : null; |
||
910 | } |
||
911 | |||
912 | /** |
||
913 | * Check if the image is attached with the particular post. |
||
914 | * |
||
915 | * @since 2.0.0 |
||
916 | * @access public |
||
917 | * |
||
918 | * @see get_post_attachment_ids() |
||
919 | * |
||
920 | * @param int $attachment_id Attachment id of an image. |
||
921 | * @param int $post_id Current post id. |
||
922 | * |
||
923 | * @return bool |
||
924 | */ |
||
925 | public function is_attached( $attachment_id, $post_id ) { |
||
926 | if ( empty( $attachment_id ) ) { |
||
927 | return false; |
||
928 | } |
||
929 | |||
930 | $attachment_ids = $this->get_post_attachment_ids( $post_id ); |
||
931 | |||
932 | return in_array( $attachment_id, $attachment_ids, true ) ? true : false; |
||
933 | } |
||
934 | |||
935 | /** |
||
936 | * Retrieve featured images for specific post(s). |
||
937 | * |
||
938 | * @since 2.0.0 |
||
939 | * @access public |
||
940 | * |
||
941 | * @see get_post_meta() |
||
942 | * |
||
943 | * @param int $post_id id of the current post. |
||
944 | * |
||
945 | * @return array |
||
946 | */ |
||
947 | public function get_featured_images( $post_id = null ) { |
||
948 | $post_id = $this->get_real_post_id( $post_id ); |
||
949 | $dfi_images = get_post_meta( $post_id, 'dfiFeatured', true ); |
||
950 | $ret_images = array(); |
||
951 | |||
952 | if ( ! empty( $dfi_images ) && is_array( $dfi_images ) ) { |
||
953 | $dfi_images = array_filter( $dfi_images ); |
||
954 | |||
955 | $count = 0; |
||
956 | foreach ( $dfi_images as $dfi_image ) { |
||
957 | $dfi_image_trimmed = $this->separate( $dfi_image ); |
||
958 | $dfi_image_full = $this->separate( $dfi_image, 'full' ); |
||
959 | |||
960 | try { |
||
961 | $ret_images[ $count ]['thumb'] = $this->get_real_upload_path( $dfi_image_trimmed ); |
||
962 | $ret_images[ $count ]['full'] = $this->get_real_upload_path( $dfi_image_full ); |
||
963 | $ret_images[ $count ]['attachment_id'] = $this->get_image_id( $ret_images[ $count ]['full'] ); |
||
964 | } catch ( Exception $e ) { |
||
965 | /* Ignore the exception and continue with other featured images */ |
||
966 | } |
||
967 | |||
968 | $count ++; |
||
969 | } |
||
970 | } |
||
971 | |||
972 | return $ret_images; |
||
973 | } |
||
974 | |||
975 | /** |
||
976 | * Check to see if the upload url is already available in path. |
||
977 | * |
||
978 | * @since 3.1.14 |
||
979 | * @access protected |
||
980 | * |
||
981 | * @param string $img Uploaded image. |
||
982 | * |
||
983 | * @return string |
||
984 | */ |
||
985 | protected function get_real_upload_path( $img ) { |
||
986 | // check if upload path is already attached. |
||
987 | if ( false !== strpos( $img, $this->upload_url ) || preg_match( '/https?:\/\//', $img ) ) { |
||
988 | return $img; |
||
989 | } |
||
990 | |||
991 | return $this->upload_url . $img; |
||
992 | } |
||
993 | |||
994 | /** |
||
995 | * Retrieve featured images for specific post(s) including the default Featured Image. |
||
996 | * |
||
997 | * @since 3.1.7 |
||
998 | * @access public |
||
999 | * |
||
1000 | * @see $this->get_featured_images() |
||
1001 | * |
||
1002 | * @param int $post_id Current post id. |
||
1003 | * |
||
1004 | * @return array An array of images or an empty array on failure |
||
1005 | */ |
||
1006 | public function get_all_featured_images( $post_id = null ) { |
||
1007 | $post_id = $this->get_real_post_id( $post_id ); |
||
1008 | $thumbnail_id = get_post_thumbnail_id( $post_id ); |
||
1009 | $all_images = array(); |
||
1010 | |||
1011 | if ( ! empty( $thumbnail_id ) ) { |
||
1012 | $featured_image = array( |
||
1013 | 'thumb' => wp_get_attachment_thumb_url( $thumbnail_id ), |
||
1014 | 'full' => wp_get_attachment_url( $thumbnail_id ), |
||
1015 | 'attachment_id' => $thumbnail_id, |
||
1016 | ); |
||
1017 | |||
1018 | $all_images[] = $featured_image; |
||
1019 | } |
||
1020 | |||
1021 | return array_merge( $all_images, $this->get_featured_images( $post_id ) ); |
||
1022 | } |
||
1023 | |||
1024 | /** |
||
1025 | * Load the plugin's textdomain hooked to 'plugins_loaded'. |
||
1026 | * |
||
1027 | * @since 1.0.0 |
||
1028 | * @access public |
||
1029 | * |
||
1030 | * @see load_plugin_textdomain() |
||
1031 | * @see plugin_basename() |
||
1032 | * @action plugins_loaded |
||
1033 | * |
||
1034 | * @codeCoverageIgnore |
||
1035 | * |
||
1036 | * @return void |
||
1037 | */ |
||
1038 | public function load_plugin_textdomain() { |
||
1039 | load_plugin_textdomain( |
||
1040 | self::TEXT_DOMAIN, |
||
1041 | false, |
||
1042 | dirname( plugin_basename( __FILE__ ) ) . '/languages/' |
||
1043 | ); |
||
1044 | } |
||
1045 | } |
||
1046 | |||
1047 | /** |
||
1048 | * Instantiate the main class. |
||
1049 | * |
||
1050 | * @since 1.0.0 |
||
1051 | * @access public |
||
1052 | * |
||
1053 | * @var object $dynamic_featured_image holds the instantiated class {@uses Dynamic_Featured_Image} |
||
1054 | */ |
||
1055 | global $dynamic_featured_image; |
||
1056 | $dynamic_featured_image = new Dynamic_Featured_Image(); |
||
1057 |
Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: