Реальный пример разработки плагина WordPress

Регистрация Типа контента и Правила Перезаписи Перезаписи при Активации

Когда плагин активируется впервые, вы можете вызвать функцию для выполнения однократных действий. Это то, что мы делаем с функцией plugin_activate .

Несмотря на то, что мы регистрируем наш тип контента через ловушку init , нам все равно нужно вызвать из него register_location_content_type (чтобы убедиться, что наш тип контента был добавлен правильно)

Мы также очищаем правила перезаписи, чтобы мы могли использовать довольно постоянные ссылки для наших местоположений (у нас могут быть ссылки, такие как example.com/location/mylocation вместо example.com/?p=144 )

 //triggered on activation of the plugin (called only once) public function plugin_activate(){ //call our custom content type function $this->register_location_content_type(); //flush permalinks flush_rewrite_rules(); } 

Промывка Переписать правила деактивации

Деактивация плагина срабатывает, когда мы деактивируем наш плагин. Поскольку мы удаляем плагин, а плагин определяет пользовательский тип контента, мы хотим использовать эту возможность, чтобы очистить наши правила перезаписи для обеспечения согласованности.

 //trigered on deactivation of the plugin (called only once) public function plugin_deactivate(){ //flush permalinks flush_rewrite_rules(); } 

Отображение мета-информации о нашем местоположении в одном месте

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

Функция prepend_location_meta_to_content подключена к фильтру the_content что означает, что мы можем добавить нашу дополнительную информацию перед основным содержанием страниц.

 public function prepend_location_meta_to_content($content){ global $post, $post_type; //display meta only on our locations (and if its a single location) if($post_type == 'wp_locations' && is_singular('wp_locations')){ //collect variables $wp_location_id = $post->ID; $wp_location_phone = get_post_meta($post->ID,'wp_location_phone',true); $wp_location_email = get_post_meta($post->ID,'wp_location_email',true); $wp_location_address = get_post_meta($post->ID,'wp_location_address',true); //display $html = ''; $html .= '<section class="meta-data">'; //hook for outputting additional meta data (at the start of the form) do_action('wp_location_meta_data_output_start',$wp_location_id); $html .= '<p>'; //phone if(!empty($wp_location_phone)){ $html .= '<b>Location Phone</b> ' . $wp_location_phone . '</br>'; } //email if(!empty($wp_location_email)){ $html .= '<b>Location Email</b> ' . $wp_location_email . '</br>'; } //address if(!empty($wp_location_address)){ $html .= '<b>Location Address</b> ' . $wp_location_address . '</br>'; } $html .= '</p>'; //location if(!empty($this->wp_location_trading_hour_days)){ $html .= '<p>'; $html .= '<b>Location Trading Hours </b></br>'; foreach($this->wp_location_trading_hour_days as $day_key => $day_value){ $trading_hours = get_post_meta($post->ID, 'wp_location_trading_hours_' . $day_key , true); $html .= '<span class="day">' . $day_key . '</span><span class="hours">' . $trading_hours . '</span></br>'; } $html .= '</p>'; } //hook for outputting additional meta data (at the end of the form) do_action('wp_location_meta_data_output_end',$wp_location_id); $html .= '</section>'; $html .= $content; return $html; }else{ return $content; } } 

Давайте рассмотрим, что делает эта функция:

• Поскольку функция добавляется в хук the_content , она будет запускаться каждый раз при загрузке страницы. $post_type мы используем глобальные переменные $post и $post_type чтобы гарантировать, что мы находимся только на одной странице местоположения.
• Мы собираем основную информацию о местоположении, такую ​​как электронная почта, телефон и адрес.
• Как только мы собираемся отобразить нашу метаинформацию, мы вызываем wp_location_meta_data_output_start действия wp_location_meta_data_output_start . Это действие позволит другим плагинам или темам подключиться к начальному выводу метаинформации (если кто-то добавил новое поле в местоположение, этот хук можно использовать для отображения сохраненной информации).
• Мы выводим электронную почту, телефон и адресную информацию.
• Мы просматриваем нашу переменную wp_location_trading_hour_days и видим, определены ли дни. Если мы это сделаем, мы пройдемся по всем из них, соберем его торговые часы и отобразим их.
• Непосредственно перед тем, как мы закончим весь наш вывод, мы вызываем действие wp_location_meta_data_output_end . Это действие позволит кому-либо вывести дополнительную информацию до закрытия мета-местоположения.

Получение списка местоположений

Мы создаем функцию, целью которой является создание HTML-кода для списка наших местоположений.

Функция get_locations_output является как get_locations_output местоположения, так и виджетом местоположения, чтобы генерировать свою разметку.

Поскольку она используется для нескольких целей, эта функция выполняет несколько важных действий. Я сломаю их всех шаг за шагом.

 //main function for displaying locations (used for our shortcodes and widgets) public function get_locations_output($arguments = ""){ //default args $default_args = array( 'location_id' => '', 'number_of_locations' => -1 ); //update default args if we passed in new args if(!empty($arguments) && is_array($arguments)){ //go through each supplied argument foreach($arguments as $arg_key => $arg_val){ //if this argument exists in our default argument, update its value if(array_key_exists($arg_key, $default_args)){ $default_args[$arg_key] = $arg_val; } } } //find locations $location_args = array( 'post_type' => 'wp_locations', 'posts_per_page'=> $default_args['number_of_locations'], 'post_status' => 'publish' ); //if we passed in a single location to display if(!empty($default_args['location_id'])){ $location_args['include'] = $default_args['location_id']; } //output $html = ''; $locations = get_posts($location_args); //if we have locations if($locations){ $html .= '<article class="location_list cf">'; //foreach location foreach($locations as $location){ $html .= '<section class="location">'; //collect location data $wp_location_id = $location->ID; $wp_location_title = get_the_title($wp_location_id); $wp_location_thumbnail = get_the_post_thumbnail($wp_location_id,'thumbnail'); $wp_location_content = apply_filters('the_content', $location->post_content); if(!empty($wp_location_content)){ $wp_location_content = strip_shortcodes(wp_trim_words($wp_location_content, 40, '...')); } $wp_location_permalink = get_permalink($wp_location_id); $wp_location_phone = get_post_meta($wp_location_id,'wp_location_phone',true); $wp_location_email = get_post_meta($wp_location_id,'wp_location_email',true); //apply the filter before our main content starts //(lets third parties hook into the HTML output to output data) $html = apply_filters('wp_location_before_main_content', $html); //title $html .= '<h2 class="title">'; $html .= '<a href="' . $wp_location_permalink . '" title="view location">'; $html .= $wp_location_title; $html .= '</a>'; $html .= '</h2>'; //image & content if(!empty($wp_location_thumbnail) || !empty($wp_location_content)){ $html .= '<p class="image_content">'; if(!empty($wp_location_thumbnail)){ $html .= $wp_location_thumbnail; } if(!empty($wp_location_content)){ $html .= $wp_location_content; } $html .= '</p>'; } //phone & email output if(!empty($wp_location_phone) || !empty($wp_location_email)){ $html .= '<p class="phone_email">'; if(!empty($wp_location_phone)){ $html .= '<b>Phone: </b>' . $wp_location_phone . '</br>'; } if(!empty($wp_location_email)){ $html .= '<b>Email: </b>' . $wp_location_email; } $html .= '</p>'; } //apply the filter after the main content, before it ends //(lets third parties hook into the HTML output to output data) $html = apply_filters('wp_location_after_main_content', $html); //readmore $html .= '<a class="link" href="' . $wp_location_permalink . '" title="view location">View Location</a>'; $html .= '</section>'; } $html .= '</article>'; $html .= '<div class="cf"></div>'; } return $html; } 

• Во-первых, функция имеет необязательный аргумент под названием arguments . Это используется потому, что и шорткод, и виджет будут передавать параметры на дисплей (чтобы точно настроить, что будет возвращено).
• Функция определяет набор аргументов по умолчанию в массиве $default_args . Это в основном установит число местоположений равным -1 (все местоположения), а также установит нулевой идентификатор местоположения (то есть мы хотим отобразить список местоположений, а не только одно по умолчанию).
• Мы проверяем, не является ли переданная переменная $arguments не пустой и также является массивом (то есть мы передали массив аргументов). Мы просматриваем все элементы в массиве $arguments и проверяем, соответствует ли какой-либо из ключей массива чему-либо в нашем массиве $default_args . Если что-то совпадает, мы обновляем массив $default_args .
• Мы используем массив $default_args чтобы построить поиск для get_posts() который найдет все наши местоположения (если мы указали одно местоположение, мы просто найдем его)
• Теперь мы начинаем создавать наш вывод HTML. Мы определяем нашу переменную $html и начинаем строить наш вывод.
• Мы собираем всю нашу информацию о местоположении (название, содержание, изображение, ссылки и т. Д.) И готовим ее к выводу.
• Прежде чем мы продолжим собирать наши выходные данные, мы все wp_location_before_main_content в нашей переменной $html . Это позволит третьим лицам добавлять дополнительный контент перед названием местоположения. Это полезно, как если бы мы определили какие-либо дополнительные поля в нашем администраторе, мы можем использовать их для вывода.
• Заголовок, изображение, контент, телефон и электронная почта добавляются к нашему выводу (условно проверяя, существуют ли они).
• Прежде чем мы wp_location_after_main_content кнопку «читать дальше», мы вызываем наш второй фильтр — фильтр wp_location_after_main_content . Это позволит третьим лицам добавлять контент прямо перед кнопкой.
• Мы добавляем нашу кнопку read more в вывод и затем возвращаем нашу переменную $html .

Сохранение дополнительной мета-информации для местоположений

Когда мы сохраняем одно местоположение, мы хотим запустить функцию для сбора и обновления нашей дополнительной мета-информации (такой как электронная почта, телефон, адрес и т. Д.).

Мы используем функцию save_location для этой цели.

 //triggered when adding or editing a location public function save_location($post_id){ //check for nonce if(!isset($_POST['wp_location_nonce_field'])){ return $post_id; } //verify nonce if(!wp_verify_nonce($_POST['wp_location_nonce_field'], 'wp_location_nonce')){ return $post_id; } //check for autosave if(defined('DOING_AUTOSAVE') && DOING_AUTOSAVE){ return $post_id; } //get our phone, email and address fields $wp_location_phone = isset($_POST['wp_location_phone']) ? sanitize_text_field($_POST['wp_location_phone']) : ''; $wp_location_email = isset($_POST['wp_location_email']) ? sanitize_text_field($_POST['wp_location_email']) : ''; $wp_location_address = isset($_POST['wp_location_address']) ? sanitize_text_field($_POST['wp_location_address']) : ''; //update phone, memil and address fields update_post_meta($post_id, 'wp_location_phone', $wp_location_phone); update_post_meta($post_id, 'wp_location_email', $wp_location_email); update_post_meta($post_id, 'wp_location_address', $wp_location_address); //search for our trading hour data and update foreach($_POST as $key => $value){ //if we found our trading hour data, update it if(preg_match('/^wp_location_trading_hours_/', $key)){ update_post_meta($post_id, $key, $value); } } //location save hook //used so you can hook here and save additional post fields added via 'wp_location_meta_data_output_end' or 'wp_location_meta_data_output_end' do_action('wp_location_admin_save',$post_id, $_POST); } 

 //enqueus scripts and stles on the back end public function enqueue_admin_scripts_and_styles(){ wp_enqueue_style('wp_location_admin_styles', plugin_dir_url(__FILE__) . '/css/wp_location_admin_styles.css'); } //enqueues scripts and styled on the front end public function enqueue_public_scripts_and_styles(){ wp_enqueue_style('wp_location_public_styles', plugin_dir_url(__FILE__). '/css/wp_location_public_styles.css'); } 

 defined( 'ABSPATH' ) or die( 'Nope, not accessing this' ); 

 //defines the functionality for the location shortcode class wp_location_shortcode{ } 

 //on initialize public function __construct(){ add_action('init', array($this,'register_location_shortcodes')); //shortcodes } 

 //location shortcode public function register_location_shortcodes(){ add_shortcode('wp_locations', array($this,'location_shortcode_output')); } 

 //shortcode display public function location_shortcode_output($atts, $content = '', $tag){ //get the global wp_simple_locations class global $wp_simple_locations; //build default arguments $arguments = shortcode_atts(array( 'location_id' => '', 'number_of_locations' => -1) ,$atts,$tag); //uses the main output function of the location class $html = $wp_simple_locations->get_locations_output($arguments); return $html; } 

 $wp_location_shortcode = new wp_location_shortcode; 

 defined( 'ABSPATH' ) or die( 'Nope, not accessing this' ); 

 //main widget used for displaying locations class wp_location_widget extends WP_widget{ } 

 //initialise widget values public function __construct(){ //set base values for the widget (override parent) parent::__construct( 'wp_location_widget', 'WP Location Widget', array('description' => 'A widget that displays your locations') ); add_action('widgets_init',array($this,'register_wp_location_widgets')); } 

  //handles the back-end admin of the widget //$instance - saved values for the form public function form($instance){ //collect variables $location_id = (isset($instance['location_id']) ? $instance['location_id'] : 'default'); $number_of_locations = (isset($instance['number_of_locations']) ? $instance['number_of_locations'] : 5); ?> <p>Select your options below</p> <p> <label for="<?php echo $this->get_field_name('location_id'); ?>">Location to display</label> <select class="widefat" name="<?php echo $this->get_field_name('location_id'); ?>" id="<?php echo $this->get_field_id('location_id'); ?>" value="<?php echo $location_id; ?>"> <option value="default">All Locations</option> <?php $args = array( 'posts_per_page' => -1, 'post_type' => 'wp_locations' ); $locations = get_posts($args); if($locations){ foreach($locations as $location){ if($location->ID == $location_id){ echo '<option selected value="' . $location->ID . '">' . get_the_title($location->ID) . '</option>'; }else{ echo '<option value="' . $location->ID . '">' . get_the_title($location->ID) . '</option>'; } } } ?> </select> </p> <p> <small>If you want to display multiple locations select how many below</small><br/> <label for="<?php echo $this->get_field_id('number_of_locations'); ?>">Number of Locations</label> <select class="widefat" name="<?php echo $this->get_field_name('number_of_locations'); ?>" id="<?php echo $this->get_field_id('number_of_locations'); ?>" value="<?php echo $number_of_locations; ?>"> <option value="default" <?php if($number_of_locations == 'default'){ echo 'selected';}?>>All Locations</option> <option value="1" <?php if($number_of_locations == '1'){ echo 'selected';}?>>1</option> <option value="2" <?php if($number_of_locations == '2'){ echo 'selected';}?>>2</option> <option value="3" <?php if($number_of_locations == '3'){ echo 'selected';}?>>3</option> <option value="4" <?php if($number_of_locations == '4'){ echo 'selected';}?>>4</option> <option value="5" <?php if($number_of_locations == '5'){ echo 'selected';}?>>5</option> <option value="10" <?php if($number_of_locations == '10'){ echo 'selected';}?>>10</option> </select> </p> <?php } 

 //handles updating the widget //$new_instance - new values, $old_instance - old saved values public function update($new_instance, $old_instance){ $instance = array(); $instance['location_id'] = $new_instance['location_id']; $instance['number_of_locations'] = $new_instance['number_of_locations']; return $instance; } 

 //handles public display of the widget //$args - arguments set by the widget area, $instance - saved values public function widget( $args, $instance ) { //get wp_simple_location class (as it builds out output) global $wp_simple_locations; //pass any arguments if we have any from the widget $arguments = array(); //if we specify a location //if we specify a single location if($instance['location_id'] != 'default'){ $arguments['location_id'] = $instance['location_id']; } //if we specify a number of locations if($instance['number_of_locations'] != 'default'){ $arguments['number_of_locations'] = $instance['number_of_locations']; } //get the output $html = ''; $html .= $args['before_widget']; $html .= $args['before_title']; $html .= 'Locations'; $html .= $args['after_title']; //uses the main output function of the location class $html .= $wp_simple_locations->get_locations_output($arguments); $html .= $args['after_widget']; echo $html; } 

 //registers our widget for use public function register_wp_location_widgets(){ register_widget('wp_location_widget'); }