Коли ви відвідуєте сторінку на передній панелі, WordPress запитує базу даних, і якщо ваша сторінка не існує в базі даних, цей запит не потрібен і є лише марною витратою ресурсів.
На щастя, WordPress пропонує спосіб обробляти запити на замовлення на замовлення. Це робиться завдяки 'do_parse_request'
фільтру.
Повернувшись false
на цей гачок, ви зможете зупинити WordPress від обробки запитів і зробити це власним способом.
З цього приводу я хочу поділитися способом побудови простого плагіна OOP, який може обробляти віртуальні сторінки простим у використанні (та повторному використанні) способом.
Що нам потрібно
- Клас для об’єктів віртуальних сторінок
- Клас контролера, який буде розглядати запит, і якщо він призначений для віртуальної сторінки, покаже його за допомогою відповідного шаблону
- Клас для завантаження шаблонів
- Основні файли плагінів, щоб додати гачки, які змусять все працювати
Інтерфейси
Перш ніж будувати класи, давайте запишемо інтерфейси для 3 перелічених вище об’єктів.
Спочатку інтерфейс сторінки (файл PageInterface.php
):
<?php
namespace GM\VirtualPages;
interface PageInterface {
function getUrl();
function getTemplate();
function getTitle();
function setTitle( $title );
function setContent( $content );
function setTemplate( $template );
/**
* Get a WP_Post build using virtual Page object
*
* @return \WP_Post
*/
function asWpPost();
}
Більшість методів - це лише геттери і сетери, пояснення не потребують. Останній метод слід використовувати для отримання WP_Post
об’єкта з віртуальної сторінки.
Інтерфейс контролера (файл ControllerInterface.php
):
<?php
namespace GM\VirtualPages;
interface ControllerInterface {
/**
* Init the controller, fires the hook that allows consumer to add pages
*/
function init();
/**
* Register a page object in the controller
*
* @param \GM\VirtualPages\Page $page
* @return \GM\VirtualPages\Page
*/
function addPage( PageInterface $page );
/**
* Run on 'do_parse_request' and if the request is for one of the registered pages
* setup global variables, fire core hooks, requires page template and exit.
*
* @param boolean $bool The boolean flag value passed by 'do_parse_request'
* @param \WP $wp The global wp object passed by 'do_parse_request'
*/
function dispatch( $bool, \WP $wp );
}
та інтерфейс (файл TemplateLoaderInterface.php
) завантажувача шаблонів :
<?php
namespace GM\VirtualPages;
interface TemplateLoaderInterface {
/**
* Setup loader for a page objects
*
* @param \GM\VirtualPagesPageInterface $page matched virtual page
*/
public function init( PageInterface $page );
/**
* Trigger core and custom hooks to filter templates,
* then load the found template.
*/
public function load();
}
коментарі phpDoc повинні бути досить чіткими для цих інтерфейсів.
План
Тепер, коли у нас є інтерфейси, і перш ніж писати конкретні класи, давайте розглянемо наш робочий процес:
- Спочатку ми інстанціюємо
Controller
клас (реалізує ControllerInterface
) та вводимо (можливо, у конструктор) екземпляр TemplateLoader
класу (реалізує TemplateLoaderInterface
)
- На
init
гачку ми називаємо ControllerInterface::init()
метод встановлення контролера та запуску гака, який споживчий код використовуватиме для додавання віртуальних сторінок.
- На "do_parse_request" ми зателефонуємо
ControllerInterface::dispatch()
, і там ми перевіримо всі додані віртуальні сторінки, і якщо одна з них має ту саму URL-адресу поточного запиту, відобразимо її; після встановлення всіх основних глобальних змінних ( $wp_query
, $post
). Ми також будемо використовувати TemplateLoader
клас для завантаження потрібного шаблону.
Під час цього робочого процесу ми будемо запускати деякі основні крюки, як wp
, template_redirect
, template_include
... щоб зробити плагін більш гнучким і забезпечити сумісність з ядром та іншими плагінами, або , по крайней мере , з хорошим кількістю їх.
Окрім попереднього робочого процесу, нам також потрібно буде:
- Очистіть гачки та глобальні змінні після запуску основного циклу, щоб покращити сумісність з основним та стороннім кодом
- Додайте фільтр,
the_permalink
щоб він міг повернути потрібну URL-адресу віртуальної сторінки при необхідності.
Бетонні класи
Тепер ми можемо кодувати наші конкретні класи. Почнемо з класу сторінки (файлу Page.php
):
<?php
namespace GM\VirtualPages;
class Page implements PageInterface {
private $url;
private $title;
private $content;
private $template;
private $wp_post;
function __construct( $url, $title = 'Untitled', $template = 'page.php' ) {
$this->url = filter_var( $url, FILTER_SANITIZE_URL );
$this->setTitle( $title );
$this->setTemplate( $template);
}
function getUrl() {
return $this->url;
}
function getTemplate() {
return $this->template;
}
function getTitle() {
return $this->title;
}
function setTitle( $title ) {
$this->title = filter_var( $title, FILTER_SANITIZE_STRING );
return $this;
}
function setContent( $content ) {
$this->content = $content;
return $this;
}
function setTemplate( $template ) {
$this->template = $template;
return $this;
}
function asWpPost() {
if ( is_null( $this->wp_post ) ) {
$post = array(
'ID' => 0,
'post_title' => $this->title,
'post_name' => sanitize_title( $this->title ),
'post_content' => $this->content ? : '',
'post_excerpt' => '',
'post_parent' => 0,
'menu_order' => 0,
'post_type' => 'page',
'post_status' => 'publish',
'comment_status' => 'closed',
'ping_status' => 'closed',
'comment_count' => 0,
'post_password' => '',
'to_ping' => '',
'pinged' => '',
'guid' => home_url( $this->getUrl() ),
'post_date' => current_time( 'mysql' ),
'post_date_gmt' => current_time( 'mysql', 1 ),
'post_author' => is_user_logged_in() ? get_current_user_id() : 0,
'is_virtual' => TRUE,
'filter' => 'raw'
);
$this->wp_post = new \WP_Post( (object) $post );
}
return $this->wp_post;
}
}
Не що інше, як реалізація інтерфейсу.
Тепер клас контролера (файл Controller.php
):
<?php
namespace GM\VirtualPages;
class Controller implements ControllerInterface {
private $pages;
private $loader;
private $matched;
function __construct( TemplateLoaderInterface $loader ) {
$this->pages = new \SplObjectStorage;
$this->loader = $loader;
}
function init() {
do_action( 'gm_virtual_pages', $this );
}
function addPage( PageInterface $page ) {
$this->pages->attach( $page );
return $page;
}
function dispatch( $bool, \WP $wp ) {
if ( $this->checkRequest() && $this->matched instanceof Page ) {
$this->loader->init( $this->matched );
$wp->virtual_page = $this->matched;
do_action( 'parse_request', $wp );
$this->setupQuery();
do_action( 'wp', $wp );
$this->loader->load();
$this->handleExit();
}
return $bool;
}
private function checkRequest() {
$this->pages->rewind();
$path = trim( $this->getPathInfo(), '/' );
while( $this->pages->valid() ) {
if ( trim( $this->pages->current()->getUrl(), '/' ) === $path ) {
$this->matched = $this->pages->current();
return TRUE;
}
$this->pages->next();
}
}
private function getPathInfo() {
$home_path = parse_url( home_url(), PHP_URL_PATH );
return preg_replace( "#^/?{$home_path}/#", '/', esc_url( add_query_arg(array()) ) );
}
private function setupQuery() {
global $wp_query;
$wp_query->init();
$wp_query->is_page = TRUE;
$wp_query->is_singular = TRUE;
$wp_query->is_home = FALSE;
$wp_query->found_posts = 1;
$wp_query->post_count = 1;
$wp_query->max_num_pages = 1;
$posts = (array) apply_filters(
'the_posts', array( $this->matched->asWpPost() ), $wp_query
);
$post = $posts[0];
$wp_query->posts = $posts;
$wp_query->post = $post;
$wp_query->queried_object = $post;
$GLOBALS['post'] = $post;
$wp_query->virtual_page = $post instanceof \WP_Post && isset( $post->is_virtual )
? $this->matched
: NULL;
}
public function handleExit() {
exit();
}
}
По суті, клас створює SplObjectStorage
об'єкт, де зберігаються всі додані сторінки.
Увімкнено 'do_parse_request'
клас контролера циклічно зберігає цю пам’ять, щоб знайти відповідність для поточної URL-адреси на одній із доданих сторінок.
Якщо він знайдений, клас виконує саме те, що ми планували: запустити деякі гачки, встановити змінні та завантажити шаблон через клас, що розширюється TemplateLoaderInterface
. Після цього просто exit()
.
Тож давайте напишемо останній клас:
<?php
namespace GM\VirtualPages;
class TemplateLoader implements TemplateLoaderInterface {
public function init( PageInterface $page ) {
$this->templates = wp_parse_args(
array( 'page.php', 'index.php' ), (array) $page->getTemplate()
);
}
public function load() {
do_action( 'template_redirect' );
$template = locate_template( array_filter( $this->templates ) );
$filtered = apply_filters( 'template_include',
apply_filters( 'virtual_page_template', $template )
);
if ( empty( $filtered ) || file_exists( $filtered ) ) {
$template = $filtered;
}
if ( ! empty( $template ) && file_exists( $template ) ) {
require_once $template;
}
}
}
Шаблони, що зберігаються на віртуальній сторінці, об’єднуються в масив із за замовчуванням page.php
і index.php
перед запуском шаблону для завантаження 'template_redirect'
для додання гнучкості та покращення сумісності.
Після цього знайдений шаблон проходить через спеціальні 'virtual_page_template'
та основні 'template_include'
фільтри: знову ж таки для гнучкості та сумісності.
Нарешті файл шаблону щойно завантажується.
Основний файл плагіна
У цей момент нам потрібно написати файл із заголовками плагінів і використовувати його, щоб додати гачки, які сприятимуть нашому робочому процесу:
<?php namespace GM\VirtualPages;
/*
Plugin Name: GM Virtual Pages
*/
require_once 'PageInterface.php';
require_once 'ControllerInterface.php';
require_once 'TemplateLoaderInterface.php';
require_once 'Page.php';
require_once 'Controller.php';
require_once 'TemplateLoader.php';
$controller = new Controller ( new TemplateLoader );
add_action( 'init', array( $controller, 'init' ) );
add_filter( 'do_parse_request', array( $controller, 'dispatch' ), PHP_INT_MAX, 2 );
add_action( 'loop_end', function( \WP_Query $query ) {
if ( isset( $query->virtual_page ) && ! empty( $query->virtual_page ) ) {
$query->virtual_page = NULL;
}
} );
add_filter( 'the_permalink', function( $plink ) {
global $post, $wp_query;
if (
$wp_query->is_page && isset( $wp_query->virtual_page )
&& $wp_query->virtual_page instanceof Page
&& isset( $post->is_virtual ) && $post->is_virtual
) {
$plink = home_url( $wp_query->virtual_page->getUrl() );
}
return $plink;
} );
У реальний файл ми, мабуть, додамо більше заголовків, таких як посилання на плагін та автор, опис, ліцензія тощо.
Plugin Gist
Гаразд, ми зробили наш плагін. Весь код ви можете знайти в Gist тут .
Додавання сторінок
Плагін готовий і працює, але ми не додали жодної сторінки.
Це можна зробити всередині самого плагіна, всередині теми functions.php
, в іншому додатку тощо.
Додавання сторінок - це лише питання:
<?php
add_action( 'gm_virtual_pages', function( $controller ) {
// first page
$controller->addPage( new \GM\VirtualPages\Page( '/custom/page' ) )
->setTitle( 'My First Custom Page' )
->setTemplate( 'custom-page-form.php' );
// second page
$controller->addPage( new \GM\VirtualPages\Page( '/custom/page/deep' ) )
->setTitle( 'My Second Custom Page' )
->setTemplate( 'custom-page-deep.php' );
} );
І так далі. Ви можете додати всі потрібні сторінки, просто не забудьте використати відносні URL-адреси для сторінок.
Всередині файлу шаблону ви можете використовувати всі теги шаблонів WordPress, і ви можете написати всі необхідні PHP та HTML.
Об'єкт глобальної пошти заповнений даними, що надходять з нашої віртуальної сторінки. До самої віртуальної сторінки можна отримати доступ через $wp_query->virtual_page
змінну.
Отримати URL-адресу для віртуальної сторінки так само просто, як перейти до home_url()
того ж шляху, який використовується для створення сторінки:
$custom_page_url = home_url( '/custom/page' );
Зауважте, що в основному циклі завантаженого шаблону the_permalink()
повернеться правильна посилання на віртуальну сторінку.
Примітки до стилів / сценаріїв для віртуальних сторінок
Можливо, коли додаються віртуальні сторінки, бажано також, щоб користувацькі стилі / сценарії були заповнені, а потім просто використовувались wp_head()
у користувацьких шаблонах.
Це дуже просто, адже віртуальні сторінки легко розпізнати, переглядаючи $wp_query->virtual_page
змінні, а віртуальні сторінки можна відрізнити одна від іншої, переглядаючи їх URL.
Просто приклад:
add_action( 'wp_enqueue_scripts', function() {
global $wp_query;
if (
is_page()
&& isset( $wp_query->virtual_page )
&& $wp_query->virtual_page instanceof \GM\VirtualPages\PageInterface
) {
$url = $wp_query->virtual_page->getUrl();
switch ( $url ) {
case '/custom/page' :
wp_enqueue_script( 'a_script', $a_script_url );
wp_enqueue_style( 'a_style', $a_style_url );
break;
case '/custom/page/deep' :
wp_enqueue_script( 'another_script', $another_script_url );
wp_enqueue_style( 'another_style', $another_style_url );
break;
}
}
} );
Примітки до ОП
Передача даних зі сторінки на іншу не пов’язана з цими віртуальними сторінками, а є лише загальним завданням.
Однак якщо у вас є форма на першій сторінці та ви хочете передати дані звідти на другу сторінку, просто скористайтеся URL-адресою другої сторінки у action
власності форми .
Наприклад, у файлі шаблону на першій сторінці ви можете:
<form action="<?php echo home_url( '/custom/page/deep' ); ?>" method="POST">
<input type="text" name="testme">
</form>
а потім у файлі шаблону на другій сторінці:
<?php $testme = filter_input( INPUT_POST, 'testme', FILTER_SANITIZE_STRING ); ?>
<h1>Test-Me value form other page is: <?php echo $testme; ?></h1>