Completed
Push — master ( 46e69a...7bf6a2 )
by Ankit
01:43
created

dynamic-featured-image.php (1 issue)

Severity

Upgrade to new PHP Analysis Engine

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.5
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.5';
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 1
    public function __construct() {
120
        // plugin update warning.
121 1
        add_action( 'in_plugin_update_message-' . plugin_basename( __FILE__ ), array( $this, 'update_notice' ) );
122
123 1
        add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) );
124 1
        add_action( 'add_meta_boxes', array( $this, 'initialize_featured_box' ) );
125 1
        add_action( 'save_post', array( $this, 'save_meta' ) );
126 1
        add_action( 'plugins_loaded', array( $this, 'load_plugin_textdomain' ) );
127
128
        // handle ajax request.
129 1
        add_action( 'wp_ajax_dfiMetaBox_callback', array( $this, 'ajax_callback' ) );
130
131
        // add action links.
132 1
        add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), array( $this, 'dfi_action_links' ) );
133
134
        // media uploader custom fields.
135 1
        add_filter( 'attachment_fields_to_edit', array( $this, 'media_attachment_custom_fields' ), 10, 2 );
136 1
        add_filter( 'attachment_fields_to_save', array( $this, 'media_attachment_custom_fields_save' ), 10, 2 );
137
138
        // get the site protocol.
139 1
        $protocol = $this->get_protocol();
140
141 1
        $this->upload_dir = wp_upload_dir();
142 1
        $this->upload_url = preg_replace( '#^https?://#', '', $this->upload_dir['baseurl'] );
143
144
        // add protocol to the upload url.
145 1
        $this->upload_url = $protocol . $this->upload_url;
146
147
        // post type filter added by user.
148 1
        $this->user_filter = array();
149
150 1
        global $wpdb;
151 1
        $this->db = $wpdb;
152 1
    }
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_enqueue_style()
173
     * @see  wp_register_script()
174
     * @see  wp_enqueue_script()
175
     *
176
     * @return void
177
     */
178 1
    public function enqueue_admin_scripts() {
179
        // enqueue styles.
180 1
        wp_enqueue_style( 'style-dfi', plugins_url( '/css/style-dfi.css', __FILE__ ), array(), self::VERSION );
181
182
        // register script.
183 1
        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 1
        wp_localize_script(
187 1
            'scripts-dfi',
188 1
            'DFI_SPECIFIC',
189
            array(
190 1
                'upload_url'               => $this->upload_url,
191 1
                'metabox_title'            => __( $this->metabox_title, self::TEXT_DOMAIN ),
192 1
                'mediaSelector_title'      => __( 'Dynamic Featured Image - Media Selector', self::TEXT_DOMAIN ),
193 1
                'mediaSelector_buttonText' => __( 'Set Featured Image', self::TEXT_DOMAIN ),
194 1
                'ajax_nonce'               => wp_create_nonce( plugin_basename( __FILE__ ) ),
195
            )
196 1
        );
197
198
        // enqueue scripts.
199 1
        wp_enqueue_script( 'scripts-dfi' );
200 1
    }
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 = is_array( $featured_data ) ? count( $featured_data ) : 0;
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 2
    protected function get_number_translation( $number ) {
270 2
        if ( $number <= 9 ) {
271 1
            return __( $number, self::TEXT_DOMAIN );
272
        } else {
273 1
            $pieces = str_split( $number, 1 );
274 1
            $buffer = '';
275 1
            foreach ( $pieces as $piece ) {
276 1
                $buffer .= __( $piece, self::TEXT_DOMAIN );
277 1
            }
278
279 1
            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
                    apply_filters( 'dfi_metabox_context', 'side' ),
301
                    apply_filters( 'dfi_metabox_priority', '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
                    apply_filters( 'dfi_metabox_context', 'side' ),
315
                    apply_filters( 'dfi_metabox_priority', '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 3
    private function separate( $url_string, $state = 'thumb' ) {
335 3
        $image_piece = explode( ',', $url_string );
336
337 3
        if ( 'thumb' === $state ) {
338 2
            return isset( $image_piece[0] ) ? $image_piece[0] : null;
339
        }
340
341 3
        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 2
    public function featured_meta_box( $post, $featured ) {
375 2
        $featured_img         = $featured['args'][0];
376 2
        $featured_id          = is_null( $featured['args'][1] ) ? 2 : --$featured['args'][1];
377 2
        $featured_img_full    = $featured_img;
378 2
        $featured_img_trimmed = $featured_img;
379
380 2
        if ( ! is_null( $featured_img ) ) {
381 2
            $featured_img_trimmed = $this->separate( $featured_img );
382 2
            $featured_img_full    = $this->separate( $featured_img, 'full' );
383 2
        }
384
385 2
        $thumbnail = $this->get_image_thumb( $this->upload_url . $featured_img_full, 'medium' );
386 2
        if ( empty( $thumbnail ) ) {
387
            // since medium sized thumbnail image is missing,
388
            // let's set full image url as thumbnail.
389 2
            $thumbnail = $featured_img_full;
390 2
        }
391
392
        // Add a nonce field.
393 2
        echo $this->nonce_field( 'dfi_fimageplug-' . $featured_id ); // WPCS: XSS ok.
394 2
        echo $this->get_featured_box( $featured_img_trimmed, $featured_img, $featured_id, $thumbnail, $post->ID ); // WPCS: XSS ok.
395 2
    }
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 2
    private function get_featured_box( $featured_img_trimmed, $featured_img, $featured_id, $thumbnail, $post_id ) {
412 2
        $has_featured_image = ! empty( $featured_img_trimmed ) ? 'hasFeaturedImage' : '';
413 2
        $thumbnail          = ! is_null( $thumbnail ) ? $thumbnail : '';
414 2
        $dfi_empty          = is_null( $featured_img_trimmed ) ? 'dfiImgEmpty' : '';
415
416 2
        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 2
            <img src='" . $thumbnail . "' class='dfiImg {$dfi_empty}'/>
418
            <div class='dfiLinks'>
419 2
                <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 2
                <a href='javascript:void(0)' class='dfiRemove dashicons dashicons-minus' title='" . __( 'Remove', self::TEXT_DOMAIN ) . "'></a>
421
            </div>
422
            <div class='dfiClearFloat'></div>
423 2
            <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 2
    public function ajax_callback() {
435 2
        check_ajax_referer( plugin_basename( __FILE__ ), 'security' );
436
437 1
        $featured_id = isset( $_POST['id'] ) ? intval( wp_unslash( $_POST['id'] ) ) : null;
438
439 1
        if ( ! is_numeric( $featured_id ) ) {
440
            return;
441
        }
442
443
        // @codingStandardsIgnoreStart
444 1
        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 1
        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 1
    public function add_metabox_classes( $classes ) {
477 1
        array_push( $classes, 'featured-meta-box' );
478
479 1
        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 1
    public function media_attachment_custom_fields( $form_fields, $post ) {
493 1
        $form_fields['dfi-link-to-image'] = array(
494 1
            'label' => __( 'Link to Image', self::TEXT_DOMAIN ),
495 1
            'input' => 'text',
496 1
            'value' => get_post_meta( $post->ID, '_dfi_link_to_image', true ),
497
        );
498
499 1
        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 1
    public function media_attachment_custom_fields_save( $post, $attachment ) {
513 1
        if ( isset( $attachment['dfi-link-to-image'] ) ) {
514 1
            update_post_meta( $post['ID'], '_dfi_link_to_image', $attachment['dfi-link-to-image'] );
515 1
        }
516
517 1
        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 2
    public function save_meta( $post_id ) {
535
        // Check auto save.
536 2
        if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
537 1
            return false;
538
        }
539
540 2
        if ( ! $this->verify_nonces() ) {
541 2
            return false;
542
        }
543
544
        // Check permission before saving data.
545 1
        if ( current_user_can( 'edit_posts', $post_id ) && isset( $_POST['dfiFeatured'] ) ) { // WPCS: CSRF ok.
546 1
            $featured_images = is_array( $_POST['dfiFeatured'] ) ? $_POST['dfiFeatured'] : array(); // WPCS: sanitization ok, CSRF ok.
547
548 1
            update_post_meta( $post_id, 'dfiFeatured', $this->sanitize_array( $featured_images ) );
549 1
        }
550 1
    }
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 1
    protected function sanitize_array( $input_array ) {
563 1
        $sanitized = array();
564
565 1
        foreach ( $input_array as $value ) {
566 1
            $sanitized[] = sanitize_text_field( wp_unslash( $value ) );
567 1
        }
568
569 1
        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
verify_nonces uses the super-global variable $_POST which is generally not recommended.

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:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
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 1
    public function update_notice() {
608 1
        $info = __( 'ATTENTION! Please read the <a href="' . self::WIKI_LINK . '" target="_blank">DOCUMENTATION</a> properly before update.',
609 1
        self::TEXT_DOMAIN );
610
611 1
        echo '<span style="color: red; padding: 7px 0; display: block">' . strip_tags( $info, '<a><b><i><span>' ) . '</span>'; // WPCS: XSS ok.
612 1
    }
613
614
    /**
615
     * Execute query.
616
     *
617
     * @param string $query Query to execute.
618
     *
619
     * @return null|string
620
     */
621 6
    private function execute_query( $query ) {
622 6
        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 1
    protected function get_attachment_id( $image_url ) {
637 1
        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 1
    public function get_image_url( $attachment_id, $size = 'full' ) {
654 1
        $image_thumb = wp_get_attachment_image_src( $attachment_id, $size );
655
656 1
        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 3
    public function get_image_thumb( $image_url, $size = 'thumbnail' ) {
674 3
        $attachment_id = $this->get_image_id( $image_url );
675 3
        $image_thumb   = wp_get_attachment_image_src( $attachment_id, $size );
676
677 3
        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 5
    public function get_image_id( $image_url ) {
691 5
        $attachment_id = $this->get_attachment_id( $image_url );
692
693 5
        if ( is_null( $attachment_id ) ) {
694
            // check if the image is edited image.
695
            // and try to get the attachment id.
696 4
            $image_url = str_replace( $this->upload_url . '/', '', $image_url );
697 4
            $row       = $this->execute_query( $this->db->prepare( 'SELECT post_id FROM ' . $this->db->postmeta . ' WHERE meta_value = %s', $image_url ) );
698
699 4
            if ( ! is_null( $row ) ) {
700 1
                $attachment_id = $row;
701 1
            }
702 4
        }
703
704 5
        return $attachment_id;
705
    }
706
707
    /**
708
     * Get image title.
709
     *
710
     * @since 2.0.0
711
     * @access public
712
     *
713
     * @param string $image_url URL of an image.
714
     *
715
     * @return string
716
     */
717 1
    public function get_image_title( $image_url ) {
718 1
        return $this->execute_query( $this->db->prepare( 'SELECT post_title FROM ' . $this->db->posts . ' WHERE guid = %s', $image_url ) );
719
    }
720
721
    /**
722
     * Get image title by id.
723
     *
724
     * @since 2.0.0
725
     * @access public
726
     *
727
     * @param  int $attachment_id Attachment id of an image.
728
     *
729
     * @return string
730
     */
731 1
    public function get_image_title_by_id( $attachment_id ) {
732 1
        return $this->execute_query( $this->db->prepare( 'SELECT post_title FROM ' . $this->db->posts . ' WHERE ID = %d', $attachment_id ) );
733
    }
734
735
    /**
736
     * Get image caption.
737
     *
738
     * @since 2.0.0
739
     * @access public
740
     *
741
     * @param  string $image_url URL of an image.
742
     *
743
     * @return string
744
     */
745 1
    public function get_image_caption( $image_url ) {
746 1
        return $this->execute_query( $this->db->prepare( 'SELECT post_excerpt FROM ' . $this->db->posts . ' WHERE guid = %s', $image_url ) );
747
    }
748
749
    /**
750
     * Get image caption by id.
751
     *
752
     * @since 2.0.0
753
     * @access public
754
     *
755
     * @param  int $attachment_id Attachment id of an image.
756
     *
757
     * @return string
758
     */
759 1
    public function get_image_caption_by_id( $attachment_id ) {
760 1
        return $this->execute_query( $this->db->prepare( 'SELECT post_excerpt FROM ' . $this->db->posts . ' WHERE ID = %d', $attachment_id ) );
761
    }
762
763
    /**
764
     * Get image alternate text.
765
     *
766
     * @since 2.0.0
767
     * @access public
768
     *
769
     * @see  get_post_meta()
770
     *
771
     * @param  string $image_url URL of an image.
772
     *
773
     * @return string
774
     */
775 1
    public function get_image_alt( $image_url ) {
776 1
        $attachment = $this->db->get_col( $this->db->prepare( 'SELECT ID FROM ' . $this->db->posts . ' WHERE guid = %s', $image_url ) );
777
778 1
        $alt = null;
779 1
        if ( ! empty( $attachment ) ) {
780 1
            $alt = get_post_meta( $attachment[0], '_wp_attachment_image_alt' );
781 1
        }
782
783 1
        return ( is_null( $alt ) || empty( $alt ) ) ? null : $alt[0];
784
    }
785
786
    /**
787
     * Get image alternate text by attachment id.
788
     *
789
     * @since 2.0.0
790
     * @access public
791
     *
792
     * @see  get_post_meta()
793
     *
794
     * @param  int $attachment_id Attachment id of an image.
795
     *
796
     * @return string
797
     */
798 1
    public function get_image_alt_by_id( $attachment_id ) {
799 1
        $alt = get_post_meta( $attachment_id, '_wp_attachment_image_alt' );
800
801 1
        return empty( $alt ) ? null : $alt[0];
802
    }
803
804
    /**
805
     * Get image description.
806
     *
807
     * @since 3.0.0
808
     * @access public
809
     *
810
     * @param  string $image_url URL of an image.
811
     *
812
     * @return string
813
     */
814 1
    public function get_image_description( $image_url ) {
815 1
        return $this->execute_query( $this->db->prepare( 'SELECT post_content FROM ' . $this->db->posts . ' WHERE guid = %s', $image_url ) );
816
    }
817
818
    /**
819
     * Get image description by id.
820
     *
821
     * @since 3.0.0
822
     * @access public
823
     *
824
     * @param  int $attachment_id attachment id of an image.
825
     *
826
     * @return string
827
     */
828 1
    public function get_image_description_by_id( $attachment_id ) {
829 1
        return $this->execute_query( $this->db->prepare( 'SELECT post_content FROM ' . $this->db->posts . ' WHERE ID = %d', $attachment_id ) );
830
    }
831
832
    /**
833
     * Get link to image.
834
     *
835
     * @since 3.4.0
836
     * @access public
837
     *
838
     * @param  int $attachment_id Attachment id of an image.
839
     *
840
     * @return string|null
841
     */
842 1
    public function get_link_to_image( $attachment_id ) {
843 1
        return get_post_meta( $attachment_id, '_dfi_link_to_image', true );
844
    }
845
846
    /**
847
     * Get all attachment ids of the post.
848
     *
849
     * @since 2.0.0
850
     * @access public
851
     *
852
     * @see  get_post_meta()
853
     *
854
     * @param  int $post_id id of the current post.
855
     *
856
     * @return array
857
     */
858 2
    public function get_post_attachment_ids( $post_id ) {
859 2
        $dfi_images = get_post_meta( $post_id, 'dfiFeatured', true );
860 2
        $ret_val    = array();
861
862 2
        if ( ! empty( $dfi_images ) && is_array( $dfi_images ) ) {
863 2
            foreach ( $dfi_images as $dfi_image ) {
864 2
                $dfi_image_full = $this->separate( $dfi_image, 'full' );
865 2
                $ret_val[]      = (int) $this->get_image_id( $this->upload_url . $dfi_image_full );
866 2
            }
867 2
        }
868
869 2
        return $ret_val;
870
    }
871
872
    /**
873
     * Get real post id.
874
     *
875
     * @since 3.6.0
876
     * @access protected
877
     *
878
     * @param int|null $post_id Post id.
879
     *
880
     * @return int|null
881
     */
882 6
    protected function get_real_post_id( $post_id = null ) {
883 6
        if ( ! is_null( $post_id ) && is_numeric( $post_id ) ) {
884 5
            return $post_id;
885
        }
886
887 3
        global $post;
888
889 3
        return $post->ID;
890
    }
891
892
    /**
893
     * Fetches featured image data of nth position.
894
     *
895
     * @since  3.0.0
896
     * @access  public
897
     *
898
     * @see  get_featured_images()
899
     *
900
     * @param  int $position Position of the featured image.
901
     * @param  int $post_id Current post id.
902
     *
903
     * @return array if found, null otherwise.
904
     */
905 2
    public function get_nth_featured_image( $position, $post_id = null ) {
906 2
        $post_id = $this->get_real_post_id( ( $post_id ) );
907
908 2
        $featured_images = $this->get_featured_images( $post_id );
909
910 2
        return isset( $featured_images[ $position - 2 ] ) ? $featured_images[ $position - 2 ] : null;
911
    }
912
913
    /**
914
     * Check if the image is attached with the particular post.
915
     *
916
     * @since 2.0.0
917
     * @access public
918
     *
919
     * @see  get_post_attachment_ids()
920
     *
921
     * @param  int $attachment_id Attachment id of an image.
922
     * @param  int $post_id Current post id.
923
     *
924
     * @return bool
925
     */
926 1
    public function is_attached( $attachment_id, $post_id ) {
927 1
        if ( empty( $attachment_id ) ) {
928 1
            return false;
929
        }
930
931 1
        $attachment_ids = $this->get_post_attachment_ids( $post_id );
932
933 1
        return in_array( $attachment_id, $attachment_ids, true ) ? true : false;
934
    }
935
936
    /**
937
     * Retrieve featured images for specific post(s).
938
     *
939
     * @since 2.0.0
940
     * @access public
941
     *
942
     * @see get_post_meta()
943
     *
944
     * @param  int $post_id id of the current post.
945
     *
946
     * @return array
947
     */
948 7
    public function get_featured_images( $post_id = null ) {
949 7
        $post_id    = $this->get_real_post_id( $post_id );
950 7
        $dfi_images = get_post_meta( $post_id, 'dfiFeatured', true );
951 7
        $ret_images = array();
952
953 7
        if ( ! empty( $dfi_images ) && is_array( $dfi_images ) ) {
954 7
            $dfi_images = array_filter( $dfi_images );
955
956 7
            $count = 0;
957 7
            foreach ( $dfi_images as $dfi_image ) {
958 7
                $dfi_image_trimmed = $this->separate( $dfi_image );
959 7
                $dfi_image_full    = $this->separate( $dfi_image, 'full' );
960
961
                try {
962 7
                    $ret_images[ $count ]['thumb']         = $this->get_real_upload_path( $dfi_image_trimmed );
963 7
                    $ret_images[ $count ]['full']          = $this->get_real_upload_path( $dfi_image_full );
964 7
                    $ret_images[ $count ]['attachment_id'] = $this->get_image_id( $ret_images[ $count ]['full'] );
965 7
                } catch ( Exception $e ) {
966
                    /* Ignore the exception and continue with other featured images */
967
                }
968
969 7
                $count ++;
970 7
            }
971 7
        }
972
973 7
        return $ret_images;
974
    }
975
976
    /**
977
     * Check to see if the upload url is already available in path.
978
     *
979
     * @since  3.1.14
980
     * @access protected
981
     *
982
     * @param  string $img Uploaded image.
983
     *
984
     * @return string
985
     */
986 2
    protected function get_real_upload_path( $img ) {
987
        // check if upload path is already attached.
988 2
        if ( false !== strpos( $img, $this->upload_url ) || preg_match( '/https?:\/\//', $img ) ) {
989 2
            return $img;
990
        }
991
992 2
        return $this->upload_url . $img;
993
    }
994
995
    /**
996
     * Retrieve featured images for specific post(s) including the default Featured Image.
997
     *
998
     * @since 3.1.7
999
     * @access public
1000
     *
1001
     * @see  $this->get_featured_images()
1002
     *
1003
     * @param int $post_id Current post id.
1004
     *
1005
     * @return array An array of images or an empty array on failure
1006
     */
1007 2
    public function get_all_featured_images( $post_id = null ) {
1008 2
        $post_id      = $this->get_real_post_id( $post_id );
1009 2
        $thumbnail_id = get_post_thumbnail_id( $post_id );
1010 2
        $all_images   = array();
1011
1012 2
        if ( ! empty( $thumbnail_id ) ) {
1013
            $featured_image         = array(
1014 2
                'thumb'         => wp_get_attachment_thumb_url( $thumbnail_id ),
1015 2
                'full'          => wp_get_attachment_url( $thumbnail_id ),
1016 2
                'attachment_id' => $thumbnail_id,
1017 2
            );
1018
1019 2
            $all_images[] = $featured_image;
1020 2
        }
1021
1022 2
        return array_merge( $all_images, $this->get_featured_images( $post_id ) );
1023
    }
1024
1025
    /**
1026
     * Load the plugin's textdomain hooked to 'plugins_loaded'.
1027
     *
1028
     * @since 1.0.0
1029
     * @access public
1030
     *
1031
     * @see    load_plugin_textdomain()
1032
     * @see    plugin_basename()
1033
     * @action plugins_loaded
1034
     *
1035
     * @codeCoverageIgnore
1036
     *
1037
     * @return void
1038
     */
1039
    public function load_plugin_textdomain() {
1040
        load_plugin_textdomain(
1041
            self::TEXT_DOMAIN,
1042
            false,
1043
            dirname( plugin_basename( __FILE__ ) ) . '/languages/'
1044
        );
1045
    }
1046
}
1047
1048
/**
1049
 * Instantiate the main class.
1050
 *
1051
 * @since 1.0.0
1052
 * @access public
1053
 *
1054
 * @var object $dynamic_featured_image holds the instantiated class {@uses Dynamic_Featured_Image}
1055
 */
1056
global $dynamic_featured_image;
1057
$dynamic_featured_image = new Dynamic_Featured_Image();
1058