הוספת כמות צפיות לפוסטים בוורדרפס

מבוא

הוספת כמות צפיות לאתר מאפשרת לבעלי האתר לעקוב אחרי פופולריות התוכן שלהם ולהבין את העדפות של הגולשים. נתוני צפיות מאפשרים לבצע ניתוח מעמיק של התוכן ולבצעה שיפורים בעתיד.
כלים רבים לניתוח נתונים באתר עוזרים לנתח את סטטיסטיקה אך הם מצריכים הבנה וזמן ניתוח. לרוב בעל אתר צריך משהו פשוט כדי לקבל החלטות מהירות ולבצע שיפורים מקומיים.

בפוסט הזה אני רוצה לכתוב קוד קצר שמאפשר יצירה בהצגה של כמות צפיות באתר. את היישום ניתן לראות בתקציר המאמר למעלה.

תוספים בספריית וורדרפס

בספריית תוספים של וורדרפס יש לא מעט תוספים שמתאים לפי דרישות השונות. חלק מהתוספים מעודכנים ומתאימים לגרסה האחרונה ביותר חלק לא מעודכנים כבר הרבה מאוד שנים.
תוספים רבים מביאים איתם לא מעט אפשרויות: בלוקים של גוטנברג, תצוגה יפה, הגדרות נוספות וכו… רובם עושים את העבודה על הצד הטוב ביותר עם מגבלות של מקום ונראות.

אני פחות רוצה להתייחס לתוספים הקיימים ולבצע סקירה עבורם כי מדובר בסה״כ בפונקציאונל פשוט שאפשר לממש בעזרת קובץ אחד בלבד.

איך זה עובד מאוחרי הקלטים

אנחנו משתמישם בכמות צפיות בסנגל (פוסט, עמוד או cpt). הקוד לא מתיייחס לעמודי בלוג השונים: קטגוריה, טאגים וכו….
הקוד מתבצע על בסיס פונקציות של וורדרפס postmeta שמאשרים לנו לשמור או למשוך נתונים פר פוסט. אנחנו נשתמש שפונקציות הבאות של וורדרפס update_post_meta לצורך עדכון או יצירה (במקום create_post_meta) וget_post_meta לצורך שליפה.

עדכון בבסיס נתונים

עדכון של postmeta מתבצע בזמן טעינה מלאה של הדף. אפשר לעשות את זה במספר דרכים, הדרך הפשוטה ביותר הינה בצורה א-סינכרונית על ידי JavaScript כדי לא לעצור את הטעינה ולחסום כל ניסיונות של רובוטים השונים.

יוצרים קובץ חדש class-ya-posts-view.php בתקיית תבנית או תת תיקיה. בגלל שמדובר בPHP Class אני לרוב משתמש בתקיית classes שנמצאת בתקיים inc מסיבות היסטוריות של טמפלייט underscores.

נגדיר את הClass עם המשתנים שלו, שאחד מהם הוא מפתח בבסיס נתונים שנעבוד איתו.

 if ( ! class_exists( 'YA_Posts_View' ) ) {
    class YA_Posts_View{
        private static $version = '1.0.0';
        public static $meta_key = 'ya_post_view';

        function __construct(){
        }
    }
}

return new YA_Posts_View(); 

לתוך הקלאס נכניס את הפונקציה שתקבל את מספר פוסט לצורך בדיקה ראשונית שמדובר בפוסט ולא בסתפ מספר, לאחר מכן בדיקת כמות צפיות נוכחית מוסיפה כניסה נוכחית ומעדכנת את בסיס הנתונים.

 function increment_post_view($post_id){
    $post = get_post( $post_id );
    if ( ! $post instanceof WP_Post ) {
        die();
    }

    $current_counter = get_post_meta($post_id, self::$meta_key, true);
    $current_counter++;
    update_post_meta($post_id, self::$meta_key, $current_counter);
} 

קליטת נתונים בAJAX

כדי להפעיל פונקציה לעדכון בסיס צריך לבנות פונקציה אחרת שמקבלת את מספר הפוסט ואת המפתח אבטחה מובנה בוורדרפס (nonce) המשמש כוסם ניסיונות מתקפה ופריצה בעזרת ajax.
נעשה בדיקה של תקינות כל הנתונים ובמידה עברנו את כל הבדיקות נפעיל את הקוד של עדכון בבסיס נתונים.

 function ajax_update_post_view() {
    $post_id = intval($_GET['post_id']);
    $nonce = $_REQUEST['nonce'];

    if(empty($_REQUEST['nonce']) || empty($_GET['post_id']) ) {
        wp_send_json_error();
        die();
    }

    if( !wp_verify_nonce( $nonce,"update_counter-{$post_id}" )) {
        wp_send_json_error();
        die();
    }

    $this->increment_post_view($post_id);
    wp_send_json_success();
    die();
} 

תצוגה של כמות הצפיות עבור מנהל אתר

הצורך העיקרי של כתיבת כל הלוגיקה היה להציג במקום מרוכז את כמות הצפיות של כל הפוסטים. לצורך זה בחרתי להציג את זה בעמוד שבו מרוכזים כל הפוסטים ליד בלוק של YoastSEO. הגדרתי גם גודל זהה לעמוד זהה לזה של Yoast.

הביצוע התבצע בשלוש פונקציות שונות, הראשונה יותרת את העמודה, השניה ממלא את העמוד והשלישית מוסיפה קוד CSS לתוך חלק העליון של הניהול.

 function add_custom_column($columns){
    $html = '<span class="dash-icon dashicons dashicons-chart-bar" title="' . esc_attr__('Post Views', 'ya') . '">'
          . '<span class="screen-reader-text">' . esc_attr__('Post Views', 'ya') . '</span>'
          . '</span>';
    $columns['ya_post_view'] = $html;
    return $columns;
}

function add_custom_column_counter($column, $post_id) {
    if ($column === 'ya_post_view') {
        $page_views = get_post_meta($post_id, self::$meta_key, true);
        echo ($page_views) ? $page_views : '0';
    }
}

function add_custom_column_style() {
    echo '<style>
            .column-ya_posts_views {
                text-align: center;
                width: 3em;
            }
        </style>';
} 

שימוש בפונקציית AJAX

חשבתי לא מעט על מיקום ההטמעה של הקוד, ועל הצורה שלו, האם זה רק JS או להוסיף כחלק מהדר או פוטר. לכל אחד מהדרכים יש ייתרונות וחסרונות. הצורך הראשוני זה יצירת מפתח אבטחה (nonce). לאור זאת בחרתי פונקציה שתהיה חלק מהקלאס עצמו.

 function add_ajax_footer_code(){
    if (is_single() || is_page()) {
        $post_id = get_the_ID();
        $query_params = array(
            'action' => 'ya_increment_post_view',
            'post_id' => $post_id,
            'nonce' => wp_create_nonce('update_counter-' . $post_id)
        );


        echo "<script>fetch(`" . admin_url('admin-ajax.php') . "?" . http_build_query($query_params) . "`)</script>";

    }
} 

חיבור של הקוד לתוך הוורדרפס

חיברתי את כל פונקציות לaction וfilter שיופיעו בתוך האתר במקמות הנדשרים.

 function __construct() {
    add_action('wp_ajax_ya_increment_counter', array($this, 'ajax_update_post_view'));
    add_action('wp_ajax_nopriv_ya_increment_counter', array($this, 'ajax_update_post_view'));

    add_action('admin_head', array($this, 'add_custom_column_style'));
    add_filter('manage_posts_columns',  array($this, 'add_custom_column'));
    add_action('manage_posts_custom_column', array($this, 'add_custom_column_counter'), 10, 2);
    add_filter('manage_pages_columns', array($this, 'add_custom_column'));
    add_action('manage_pages_custom_column', array($this, 'add_custom_column_counter'), 10, 2);

    add_action('wp_footer', array($this, 'add_ajax_footer_code'));
} 

נשאר רק ללכת לקובץ functions.php ולמשוך את הקובץ לשימוש פנימי.

 /**
 * Load Post View Counter
 */
require dirname( __FILE__ ) . '/inc/classes/class-ya-posts-view.php'; 

הקוד שלנו מוכן לשימוש ואפשר להתחיל לספור את כמות הכניסות פר עמוד או פוסט. הקוד יעבוד גם בcpt.

תצוגה של כמות הצפיות עבור גושלים באתר

במידת הצורך ניתן להציג לגולשים את כמות הצפיות על ידי משיכה שלהם בסינגל.

 <?php echo get_post_meta(get_the_ID(), 'ya_post_view' , true); ?> 

מעכשיו גם הגולשים יכולים לראות את התוצאה. רק לשים לב, בשלב הראשון לאחר הטמע של הקוד באתרים הוותיקים תציג את כמות הפיות על 0, לא להתבאס מזה.

סיכום

הוספה של כמות צפיות לאתר בעזרת שימוש בקוד PHP ו-JavaScript יותר נוחה. תהליך זה חוסף התעסקות עם תוספים השונם. יחד עם זאת, תוספים הקיימים מאפשרים גמישור רבה יותר ויכולות הרבה יותר טובות.
מומלץ מאוד להתקין את כמות הצפיות בכל דרך, ולתת לגולשים את מידע העדכני והנכון על כמות הצפיות.