Создание виджета домена и социальных данных WordPress Widget

В предыдущем уроке мы подробно изучили HTTP API WordPress и узнали, что такое APIs и как использовать HTTP API для использования веб-сервисов.

Я обещал показать некоторые реальные примеры использования API в WordPress с использованием HTTP API , это первая из серии предстоящих статей.

В этом руководстве мы разработаем виджет WordPress, который отображает WHOIS и социальную информацию о доменном имени, такую как Google PageRank и число +1, Alexa ранга, дату создания домена, когда истекает срок действия домена, серверы DNS-имен, Facebook количество лайков и лайков, твиты в Твиттере и акции LinkedIn.

Информация о домене, указанная выше, будет получена от JsonWhois API.

Чтобы получить эти данные, на конечную точку http://jsonwhois.com/api/whois будет отправлен запрос GET с вашим ключом API и именем домена в качестве параметров запроса.

Введите приведенный ниже URL в браузер, чтобы отобразить доступную информацию (в формате JSON) о домене sitepoint.com :

 http://jsonwhois.com/api/whois/?apiKey=54183ad8c433fac10b6f5d7c&domain=sitepoint.com

Именно из объекта JSON виджет, из которого мы разрабатываем, получит свои данные.

Если вы хотите продвинуться вперед в этом уроке, вы можете просмотреть демонстрацию виджета и загрузить плагин виджета .

Кодирование виджета

Прежде всего, включите заголовок плагина.

 <?php /* Plugin Name: Domain Whois and Social Data Plugin URI: http://sitepoint.com Description: Display whois and social data of a Domain. Version: 1.0 Author: Agbonghama Collins Author URI: http://w3guy.com License: GPL2 */

Создать виджет WordPress; сначала расширьте стандартный класс WP_Widget , WP_Widget необходимые функции класса или методы и, наконец, зарегистрируйте виджет.

Создайте дочерний класс, расширяющий класс WP_Widget .

 class Domain_Whois_Social_Data extends WP_Widget { // ...

Дайте виджету имя и описание, используя магический метод __construct() следующим образом.

 function __construct() { parent::__construct( 'whois_social_widget', // Base ID __( 'Domain Whois and Social Data', 'dwsd' ), // Name array( 'description' => __( 'Display whois and social data of a Domain.', 'dwsd' ), ) // Description ); }

Мы создадим метод с именем json_whois_api который будет принимать два аргумента: домен для запроса и ваш ключ API, обязанностью которого является отправка запроса «GET» в API JsonWhois , получение тела ответа и затем преобразование ответа в объект с использованием json_decode () функция.

 /** * Retrieve the response body of the API GET request and convert it to an object * * @param $domain * @param $api_key * * @return object|mixed */ public function json_whois_api( $domain, $api_key ) { $url = 'http://jsonwhois.com/api/whois/?apiKey=' . $api_key . '&domain=' . $domain; $request = wp_remote_get( $url ); $response_body = wp_remote_retrieve_body( $request ); $decode_json_to_object = json_decode( $response_body ); return $decode_json_to_object; }

Для каждой части информации о домене, которую будет отображать виджет, также будет создан метод, который возвращает отдельные данные. То есть будет создан метод, который возвращает Alexa Rank, PageRank и т. Д.

Достойный внимания

Для новичков в программировании на PHP и разработке плагинов WordPress вы можете найти что-то вроде этого:

 return $response_data->social->facebook->data[0]->share_count;

-> используется для доступа к свойству объекта и [] для доступа к массиву.

Причина этого заключается в том, что ответ, возвращаемый JsonWhois после декодирования в объект, является многомерным объектом с некоторым свойством, содержащим массив в качестве значений.

Код ниже объясняет это $object->facebook->data[0]->share_count;

 [facebook] => stdClass Object ( [data] => Array ( [0] => stdClass Object ( https%3A%2F%2Fwww.sitepoint.com => http://sitepoint.com [normalized_url] => http://www.sitepoint.com/ [share_count] => 1094 [like_count] => 448 [comment_count] => 161 [total_count] => 1703 [commentsbox_count] => 0 [comments_fbid] => 501562723433 [click_count] => 138 ) ) )

В произвольном порядке ниже приведены методы или функции класса, которые будут возвращать различную информацию о домене, отображаемую виджетом WordPress.

 /** * Get the domain Alexa Rank * * @param object $response_data JSON decoded response body * * @return integer */ public function alexa_rank( $response_data ) { return $response_data->alexa->rank; }

 /** * Number of times domain have been tweeted * * @param object $response_data JSON decoded response body * * @return integer */ public function twitter_tweets( $response_data ) { return $response_data->social->twitter->count; }

 /** * Number of times domain have been shared on Facebook * * @param object $response_data JSON decoded response body * * @return integer */ public function facebook_share_count( $response_data ) { return $response_data->social->facebook->data[0]->share_count; }

 /** * Number of times domain have been liked on Facebook * * @param object $response_data JSON decoded response body * * @return mixed */ public function facebook_like_count( $response_data ) { return $response_data->social->facebook->data[0]->like_count; }

 /** * Number of times domain have been shared to LinkedIn * * @param object $response_data JSON decoded response body * * @return integer */ public function linkedin_share( $response_data ) { return $response_data->social->linkedIn; }

 /** * Number of times domain have been shared on Google+ * * @param object $response_data JSON decoded response body * * @return integer */ public function google_share( $response_data ) { return $response_data->social->google; }

 /** * Google PageRank of Domain * * @param object $response_data JSON decoded response body * * @return integer */ public function google_page_rank( $response_data ) { return $response_data->google->rank; }

 /** *Domain name servers * * @param object $response_data JSON decoded response body * * @return string */ public function domain_nameservers( $response_data ) { $name_servers = $response_data->whois->domain->nserver; return $name_servers->{0} . ' ' . $name_servers->{1}; }

 /** * Date domain was created * * @param object $response_data JSON decoded response body * * @return mixed */ public function date_created( $response_data ) { return $response_data->whois->domain->created; }

 /** * Domain expiration date * * @param object $response_data JSON decoded response body * * @return mixed */ public function expiration_date( $response_data ) { return $response_data->whois->domain->expires; }

Внутренняя форма настроек виджета создается методом form() состоящим из трех полей формы, в которых находятся заголовок виджета, домен и ваш ключ API.

 /** * Back-end widget form. * * @see WP_Widget::form() * * @param array $instance Previously saved values from database. * * @return string */ public function form( $instance ) { if ( isset( $instance['title'] ) ) { $title = $instance['title']; } else { $title = __( 'Domain Whois & Social Data', 'dwsd' ); } $domain_name = isset( $instance['domain_name'] ) ? $instance['domain_name'] : ''; $api_key = isset( $instance['api_key'] ) ? $instance['api_key'] : '54183ad8c433fac10b6f5d7c'; ?> <p> <label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php _e( 'Title:' ); ?></label> <input class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>"> </p> <p> <label for="<?php echo $this->get_field_id( 'domain_name' ); ?>"><?php _e( 'Domain name (without http://)' ); ?></label> <input class="widefat" id="<?php echo $this->get_field_id( 'domain_name' ); ?>" name="<?php echo $this->get_field_name( 'domain_name' ); ?>" type="text" value="<?php echo esc_attr( $domain_name ); ?>"> </p> <p> <label for="<?php echo $this->get_field_id( 'api_key' ); ?>"><?php _e( 'API Key)' ); ?></label> <input class="widefat" id="<?php echo $this->get_field_id( 'api_key' ); ?>" name="<?php echo $this->get_field_name( 'api_key' ); ?>" type="text" value="<?php echo esc_attr( $api_key ); ?>"> </p> <?php }

Когда форма виджета заполнена, метод update() очищает и сохраняет введенные значения в базе данных для повторного использования.

 /** * Sanitize widget form values as they are saved. * * @see WP_Widget::update() * * @param array $new_instance Values just sent to be saved. * @param array $old_instance Previously saved values from database. * * @return array Updated safe values to be saved. */ public function update( $new_instance, $old_instance ) { $instance = array(); $instance['title'] = ( ! empty( $new_instance['title'] ) ) ? strip_tags( $new_instance['title'] ) : ''; $instance['domain_name'] = ( ! empty( $new_instance['domain_name'] ) ) ? strip_tags( $new_instance['domain_name'] ) : ''; return $instance; }

Метод widget() отображает виджет в интерфейсе WordPress.

 /** * Front-end display of widget. * * @see WP_Widget::widget() * * @param array $args Widget arguments. * @param array $instance Saved values from database. */ public function widget( $args, $instance ) { // Retrieve the saved widget API key $api_key = ! empty( $instance['api_key'] ) ? $instance['api_key'] : '54183ad8c433fac10b6f5d7c'; // Get the Domain name saved in the widget $domain_name = ! empty( $instance['domain_name'] ) ? $instance['domain_name'] : ''; // JsonWhois API response $api_response = $this->json_whois_api( $domain_name, $api_key ); // Display the widget Title echo $args['before_widget']; if ( ! empty( $instance['title'] ) ) { echo $args['before_title'] . apply_filters( 'widget_title', $instance['title'] ) . $args['after_title']; } echo '<ol>'; echo '<li> <strong>Alexa Rank:</strong> ', $this->alexa_rank( $api_response ), '</li>'; echo '<li> <strong>Google Page Rank:</strong> ', $this->google_page_rank( $api_response ), '</li>'; echo '<li> <strong>Facebook shares:</strong> ', $this->facebook_share_count( $api_response ), '</li>'; echo '<li> <strong>Facebook likes:</strong> ', $this->facebook_like_count( $api_response ), '</li>'; echo '<li> <strong>Twitter Tweets:</strong> ', $this->twitter_tweets( $api_response ), '</li>'; echo '<li> <strong>Google +1:</strong> ', $this->google_share( $api_response ), '</li>'; echo '<li> <strong>LinkedIn shares:</strong> ', $this->linkedin_share( $api_response ), '</li>'; echo '<li> <strong>Date created:</strong> ', $this->date_created( $api_response ), '</li>'; echo '<li> <strong>Expiration date:</strong> ', $this->expiration_date( $api_response ), '</li>'; echo '<li> <strong>Name servers:</strong> ', $this->domain_nameservers( $api_response ), '</li>'; echo '</ol>'; echo $args['after_widget']; }

Объяснение кода: сначала сохраненные значения формы виджета (заголовок, домен и ключ API) извлекаются из базы данных и сохраняются в переменную.

Домен и ключ API передаются методу json_whois_api с результирующим телом ответа, сохраненным в $api_response .

Вызовы различных методов, которые возвращают данные домена, выполняются с телом ответа ( $api_response ) в качестве аргумента.

Наконец, мы закрываем класс виджета.

 } // class Domain_Whois_Social_Data

Класс виджета необходимо зарегистрировать, подключив его к widgets_init чтобы он распознавался внутренними widgets_init WordPress.

 // register Domain_Whois_Social_Data widget function register_whois_social_widget() { register_widget( 'Domain_Whois_Social_Data' ); } add_action( 'widgets_init', 'register_whois_social_widget' );

Ниже приведен скриншот виджета.

Посмотреть демо-версию виджета.

Связанные ресурсы

Если вы хотите узнать больше о том, как работают виджеты WordPress, вас могут заинтересовать следующие статьи:

Заворачивать

Чтобы лучше понять, как был создан виджет и как его реализовать на вашем сайте WordPress, загрузите плагин виджетов с GitHub.

Как я уже упоминал, эта статья является первой в серии, которая продемонстрирует, как HTTP-API WordPress используется в плагине.

Не забудьте следить за каналом WordPress для аналогичных учебных пособий.

Пока мы не встретимся снова, счастливого кодирования!

Создание виджета домена и социальных данных WordPress Widget

Кодирование виджета

Достойный внимания

Связанные ресурсы

Заворачивать

Категории

Последние статьи

Рефакторинг Hudson God Class

Альтернативы синтаксиса Java лямбда

Morphia и MongoDB: развивающиеся структуры документов

OpenShift Express: развертывание приложения Java EE (с поддержкой AS7)

Интеграция jqGrid, REST, AJAX и Spring MVC