フロントエンドページにアクセスすると、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の一致を見つけるために、このストレージをループします。
見つかった場合、クラスは計画したとおりに実行します：いくつかのフックをトリガーし、変数を設定し、クラスextendsを介してテンプレートを読み込みます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;
} );
実際のファイルには、おそらくプラグインと作成者のリンク、説明、ライセンスなどのヘッダーを追加します。
プラグインの要点
OK、プラグインはこれで完了です。すべてのコードは、ここで 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;
}
}
} );
OPの注意事項
ページから別のページにデータを渡すことは、これらの仮想ページに関連するものではなく、単なる一般的なタスクです。
ただし、最初のページにフォームがあり、そこから2番目のページにデータを渡す場合は、フォームactionプロパティで2番目のページのURLを使用します。
たとえば、最初のページテンプレートファイルでは次のことができます。
<form action="<?php echo home_url( '/custom/page/deep' ); ?>" method="POST">
<input type="text" name="testme">
</form>
次に、2ページ目のテンプレートファイルで：
<?php $testme = filter_input( INPUT_POST, 'testme', FILTER_SANITIZE_STRING ); ?>
<h1>Test-Me value form other page is: <?php echo $testme; ?></h1>