pryley / site-reviews

deprecated.php

<?php

defined('WPINC') || die;

if (apply_filters('site-reviews/support/deprecated/v4', true)) {
    // Unprotected review meta has been deprecated
    add_filter('get_post_metadata', function ($data, $postId, $metaKey, $single) {
        $metaKeys = array_keys(glsr('Defaults\CreateReviewDefaults')->defaults());
        if (!in_array($metaKey, $metaKeys) || glsr()->post_type != get_post_type($postId)) {
            return $data;
        }
        glsr()->deprecated[] = sprintf(
            'The "%1$s" meta_key has been deprecated for Reviews. Please use the protected "_%1$s" meta_key instead.',
            $metaKey
        );
        return get_post_meta($postId, '_'.$metaKey, $single);
    }, 10, 4);

    // Modules/Html/Template.php
    add_filter('site-reviews/interpolate/reviews', function ($context, $template) {
        $search = '{{ navigation }}';
        if (false !== strpos($template, $search)) {
            $context['navigation'] = $context['pagination'];
            glsr()->deprecated[] = 'The {{ navigation }} template key in "YOUR_THEME/site-reviews/reviews.php" has been deprecated. Please use the {{ pagination }} template key instead.';
        }
        return $context;
    }, 10, 2);

    // Modules/Html/Template.php
    add_filter('site-reviews/build/template/reviews', function ($template) {

The parameter $template is not used and could be removed.

        if (has_filter('site-reviews/reviews/pagination-wrapper')) {
            glsr()->deprecated[] = 'The "site-reviews/reviews/pagination-wrapper" hook has been removed. Please use the "site-reviews/builder/result" hook instead.';
        }
        if (has_filter('site-reviews/reviews/reviews-wrapper')) {
            glsr()->deprecated[] = 'The "site-reviews/reviews/reviews-wrapper" hook has been removed. Please use the "site-reviews/builder/result" hook instead.';
        }
    });

    // Database/ReviewManager.php
    add_action('site-reviews/review/created', function ($review) {
        if (has_action('site-reviews/local/review/create')) {
            glsr()->deprecated[] = 'The "site-reviews/local/review/create" hook has been deprecated. Please use the "site-reviews/review/created" hook instead.';
            do_action('site-reviews/local/review/create', (array) get_post($review->ID), (array) $review, $review->ID);
        }
    }, 9);

    // Handlers/CreateReview.php
    add_action('site-reviews/review/submitted', function ($review) {
        if (has_action('site-reviews/local/review/submitted')) {
            glsr()->deprecated[] = 'The "site-reviews/local/review/submitted" hook has been deprecated. Please use the "site-reviews/review/submitted" hook instead.';
            do_action('site-reviews/local/review/submitted', null, $review);
        }
        if (has_filter('site-reviews/local/review/submitted/message')) {
            glsr()->deprecated[] = 'The "site-reviews/local/review/submitted/message" hook has been deprecated.';
        }
    }, 9);

    // Database/ReviewManager.php
    add_filter('site-reviews/create/review-values', function ($values, $command) {
        if (has_filter('site-reviews/local/review')) {
            glsr()->deprecated[] = 'The "site-reviews/local/review" hook has been deprecated. Please use the "site-reviews/create/review-values" hook instead.';
            return apply_filters('site-reviews/local/review', $values, $command);
        }
        return $values;
    }, 9, 2);

    // Handlers/EnqueuePublicAssets.php
    add_filter('site-reviews/enqueue/public/localize', function ($variables) {
        if (has_filter('site-reviews/enqueue/localize')) {
            glsr()->deprecated[] = 'The "site-reviews/enqueue/localize" hook has been deprecated. Please use the "site-reviews/enqueue/public/localize" hook instead.';
            return apply_filters('site-reviews/enqueue/localize', $variables);
        }
        return $variables;
    }, 9);

    // Modules/Rating.php
    add_filter('site-reviews/rating/average', function ($average) {
        if (has_filter('site-reviews/average/rating')) {
            glsr()->deprecated[] = 'The "site-reviews/average/rating" hook has been deprecated. Please use the "site-reviews/rating/average" hook instead.';
        }
        return $average;
    }, 9);

    // Modules/Rating.php
    add_filter('site-reviews/rating/ranking', function ($ranking) {
        if (has_filter('site-reviews/bayesian/ranking')) {
            glsr()->deprecated[] = 'The "site-reviews/bayesian/ranking" hook has been deprecated. Please use the "site-reviews/rating/ranking" hook instead.';
        }
        return $ranking;
    }, 9);

    // Modules/Html/Partials/SiteReviews.php
    add_filter('site-reviews/review/build/after', function ($renderedFields) {
        if (has_filter('site-reviews/reviews/review/text')) {
            glsr()->deprecated[] = 'The "site-reviews/reviews/review/text" hook has been deprecated. Please use the "site-reviews/review/build/after" hook instead.';
        }
        if (has_filter('site-reviews/reviews/review/title')) {
            glsr()->deprecated[] = 'The "site-reviews/reviews/review/title" hook has been deprecated. Please use the "site-reviews/review/build/after" hook instead.';
        }
        return $renderedFields;
    }, 9);

    // Modules/Html/Partials/SiteReviews.php
    add_filter('site-reviews/review/build/before', function ($review) {
        if (has_filter('site-reviews/rendered/review')) {
            glsr()->deprecated[] = 'The "site-reviews/rendered/review" hook has been deprecated. Please either use a custom "review.php" template (refer to the documentation), or use the "site-reviews/review/build/after" hook instead.';
        }
        if (has_filter('site-reviews/rendered/review/meta/order')) {
            glsr()->deprecated[] = 'The "site-reviews/rendered/review/meta/order" hook has been deprecated. Please use a custom "review.php" template instead (refer to the documentation).';
        }
        if (has_filter('site-reviews/rendered/review/order')) {
            glsr()->deprecated[] = 'The "site-reviews/rendered/review/order" hook has been deprecated. Please use a custom "review.php" template instead (refer to the documentation).';
        }
        if (has_filter('site-reviews/rendered/review-form/login-register')) {
            glsr()->deprecated[] = 'The "site-reviews/rendered/review-form/login-register" hook has been deprecated. Please use a custom "login-register.php" template instead (refer to the documentation).';
        }
        if (has_filter('site-reviews/reviews/navigation_links')) {
            glsr()->deprecated[] = 'The "site-reviews/reviews/navigation_links" hook has been deprecated. Please use a custom "pagination.php" template instead (refer to the documentation).';
        }
        return $review;
    }, 9);

    add_filter('site-reviews/validate/custom', function ($result, $request) {
        if (has_filter('site-reviews/validate/review/submission')) {
            glsr_log()->warning('The "site-reviews/validate/review/submission" hook has been deprecated. Please use the "site-reviews/validate/custom" hook instead.');
            return apply_filters('site-reviews/validate/review/submission', $result, $request);
        }
        return $result;
    }, 9, 2);

    add_filter('site-reviews/views/file', function ($file, $view, $data) {
        if (has_filter('site-reviews/addon/views/file')) {
            glsr()->deprecated[] = 'The "site-reviews/addon/views/file" hook has been deprecated. Please use the "site-reviews/views/file" hook instead.';
            $file = apply_filters('site-reviews/addon/views/file', $file, $view, $data);
        }
        return $file;
    }, 9, 3);
}

add_action('wp_footer', function () {
    $notices = array_keys(array_flip(glsr()->deprecated));
    natsort($notices);
    foreach ($notices as $notice) {
        glsr_log()->warning($notice);
    }
});