webdevqa.jp.net

プラグイン付きのカスタムページ

カスタムページを有効にしたいプラグインを開発しています。私の場合、いくつかのカスタムページには連絡先フォームのようなフォームが含まれます(文字通りではありません)。ユーザーがこのフォームに記入して送信するときは、次のステップで詳細情報が必要になります。フォームを含む最初のページはwww.domain.tld/custom-page/に配置され、フォームの送信に成功したら、ユーザーはwww.domain.tld/custom-page/secondにリダイレクトされるはずです。 HTML要素とPHPコードを含むテンプレートもカスタムにする必要があります。

問題の一部はカスタムURLの書き換えで達成できると思いますが、他の部分は現在のところ私にはわかりません。私はどこから見ればいいのか、そしてその問題の正しい命名は何なのか本当にわかりません。どんな助けでも本当に感謝されるでしょう。

12
user1257255

フロントエンドページにアクセスすると、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()を呼び出します。そこで追加されたすべての仮想ページをチェックし、それらのうちの1つに現在のリクエストのURLが同じ場合はそれを表示します。すべてのコアグローバル変数($wp_query$post)を設定した後。正しいテンプレートをロードするためにTemplateLoaderクラスも使います。

このワークフローの間、私たちは wptemplate_redirecttemplate_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' では、コントローラクラスはこのストレージをループして、追加されたページの1つで現在の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;
} );

実際のファイルでは、おそらくプラグインや作者のリンク、説明、ライセンスなどのように、もっとヘッダを追加します。

プラグインの要旨

さて、これでプラグインは完成です。すべてのコードは要旨 here に​​あります。

ページを追加する

プラグインは準備が整い、機能していますが、ページを追加していません。

これは、プラグイン自体の内部、テーマ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>
54
gmazzap

私はかつてここで説明した解決策を使用しました: http://scott.sherrillmix.com/blog/blogger/creating-a-better-fake-post-with-a-wordpress-plugin/

実際、私がそれを使っていたとき、私は一度に複数のページを登録できるようにソリューションを拡張しています(残りのコードは、上の段落からリンクしているソリューションと+/-に似ています)。

解決策はあなたがニースパーマリンクを許可する必要があります...

<?php

class FakePages {

    public function __construct() {
        add_filter( 'the_posts', array( $this, 'fake_pages' ) );
    }

    /**
     * Internally registers pages we want to fake. Array key is the slug under which it is being available from the frontend
     * @return mixed
     */
    private static function get_fake_pages() {
        //http://example.com/fakepage1
        $fake_pages['fakepage1'] = array(
            'title'   => 'Fake Page 1',
            'content' => 'This is a content of fake page 1'
        );
        //http://example.com/fakepage2
        $fake_pages['fakepage2'] = array(
            'title'   => 'Fake Page 2',
            'content' => 'This is a content of fake page 2'
        );

        return $fake_pages;
    }

    /**
     * Fakes get posts result
     *
     * @param $posts
     *
     * @return array|null
     */
    public function fake_pages( $posts ) {
        global $wp, $wp_query;
        $fake_pages       = self::get_fake_pages();
        $fake_pages_slugs = array();
        foreach ( $fake_pages as $slug => $fp ) {
            $fake_pages_slugs[] = $slug;
        }
        if ( true === in_array( strtolower( $wp->request ), $fake_pages_slugs )
             || ( true === isset( $wp->query_vars['page_id'] )
                  && true === in_array( strtolower( $wp->query_vars['page_id'] ), $fake_pages_slugs )
            )
        ) {
            if ( true === in_array( strtolower( $wp->request ), $fake_pages_slugs ) ) {
                $fake_page = strtolower( $wp->request );
            } else {
                $fake_page = strtolower( $wp->query_vars['page_id'] );
            }
            $posts                  = null;
            $posts[]                = self::create_fake_page( $fake_page, $fake_pages[ $fake_page ] );
            $wp_query->is_page      = true;
            $wp_query->is_singular  = true;
            $wp_query->is_home      = false;
            $wp_query->is_archive   = false;
            $wp_query->is_category  = false;
            $wp_query->is_fake_page = true;
            $wp_query->fake_page    = $wp->request;
            //Longer permalink structures may not match the fake post slug and cause a 404 error so we catch the error here
            unset( $wp_query->query["error"] );
            $wp_query->query_vars["error"] = "";
            $wp_query->is_404              = false;
        }

        return $posts;
    }

    /**
     * Creates virtual fake page
     *
     * @param $pagename
     * @param $page
     *
     * @return stdClass
     */
    private static function create_fake_page( $pagename, $page ) {
        $post                 = new stdClass;
        $post->post_author    = 1;
        $post->post_name      = $pagename;
        $post->guid           = get_bloginfo( 'wpurl' ) . '/' . $pagename;
        $post->post_title     = $page['title'];
        $post->post_content   = $page['content'];
        $post->ID             = - 1;
        $post->post_status    = 'static';
        $post->comment_status = 'closed';
        $post->ping_status    = 'closed';
        $post->comment_count  = 0;
        $post->post_date      = current_time( 'mysql' );
        $post->post_date_gmt  = current_time( 'mysql', 1 );

        return $post;
    }
}

new FakePages();
0
david.binda