web-dev-qa-db-ja.com

プラグインを使用してテーマにテンプレートを追加する方法

私は自分のプラグインで使用するためのページテンプレートが必要です。シングルやアーカイブなどのテーマテンプレートを置き換える必要はありません。

通常は使用します

/*
* Template Name: Blah Blah Blah
*/

しかし、ページオプションにテンプレートを追加するために、これはプラグインではうまく機能しません。カスタム投稿タイプのテンプレートをプラグインに追加する方法を私は知っています。ただし、これはページオプションのテンプレートドロップダウンのオプションにする必要があります。

pluginstemplates
2
dcp3450

私の知る限りでは、これに対する直接的な方法はありません。私は同様に検索しようとしました、そして以下のものより良い解決策を見つけませんでした。

以下のコードはあなたが探しているものを正確にあなたに提供します：

class PageTemplater {

    /**
     * A Unique Identifier
     */
     protected $plugin_slug;

    /**
     * A reference to an instance of this class.
     */
    private static $instance;

    /**
     * The array of templates that this plugin tracks.
     */
    protected $templates;


    /**
     * Returns an instance of this class. 
     */
    public static function get_instance() {

            if( null == self::$instance ) {
                    self::$instance = new PageTemplater();
            } 

            return self::$instance;

    } 

    /**
     * Initializes the plugin by setting filters and administration functions.
     */
    private function __construct() {

            $this->templates = array();


            // Add a filter to the attributes metabox to inject template into the cache.
            add_filter(
                'page_attributes_dropdown_pages_args',
                 array( $this, 'register_project_templates' ) 
            );


            // Add a filter to the save post to inject out template into the page cache
            add_filter(
                'wp_insert_post_data', 
                array( $this, 'register_project_templates' ) 
            );


            // Add a filter to the template include to determine if the page has our 
            // template assigned and return it's path
            add_filter(
                'template_include', 
                array( $this, 'view_project_template') 
            );


            // Add your templates to this array.
            $this->templates = array(
                    'goodtobebad-template.php'     => 'It\'s Good to Be Bad',
            );

    } 


    /**
     * Adds our template to the pages cache in order to trick WordPress
     * into thinking the template file exists where it doens't really exist.
     *
     */

    public function register_project_templates( $atts ) {

            // Create the key used for the themes cache
            $cache_key = 'page_templates-' . md5( get_theme_root() . '/' . get_stylesheet() );

            // Retrieve the cache list. 
            // If it doesn't exist, or it's empty prepare an array
            $templates = wp_get_theme()->get_page_templates();
            if ( empty( $templates ) ) {
                    $templates = array();
            } 

            // New cache, therefore remove the old one
            wp_cache_delete( $cache_key , 'themes');

            // Now add our template to the list of templates by merging our templates
            // with the existing templates array from the cache.
            $templates = array_merge( $templates, $this->templates );

            // Add the modified cache to allow WordPress to pick it up for listing
            // available templates
            wp_cache_add( $cache_key, $templates, 'themes', 1800 );

            return $atts;

    } 

    /**
     * Checks if the template is assigned to the page
     */
    public function view_project_template( $template ) {

            global $post;

            if (!isset($this->templates[get_post_meta( 
                $post->ID, '_wp_page_template', true 
            )] ) ) {

                    return $template;

            } 

            $file = plugin_dir_path(__FILE__). get_post_meta( 
                $post->ID, '_wp_page_template', true 
            );

            // Just to be safe, we check if the file exist first
            if( file_exists( $file ) ) {
                    return $file;
            } 
            else { echo $file; }

            return $template;

    } 


}
add_action( 'plugins_loaded', array( 'PageTemplater', 'get_instance' ) );

これは、何が起こっているのか、そしてその理由についての詳細を含む完全なチュートリアル です。

1
тнє Sufi

これは私がプラグイン内で作業することができたかなり簡単なアプローチです。あなたは https://developer.wordpress.org/reference/hooks/theme_page_templates/ と を参照したいでしょう。下記のコードを確認しながら、https://developer.wordpress.org/reference/hooks/template_include/ .

<?php
//Add our custom template to the admin's templates dropdown
add_filter( 'theme_page_templates', 'pluginname_template_as_option', 10, 3 );
function pluginname_template_as_option( $page_templates, $theme, $post ){

    $page_templates['template-landing.php'] = 'Example Landing Page';

    return $page_templates;

}

//When our custom template has been chosen then display it for the page
add_filter( 'template_include', 'pluginname_load_template', 99 );
function pluginname_load_template( $template ) {

    global $post;
    $custom_template_slug   = 'template-landing.php';
    $page_template_slug     = get_page_template_slug( $post->ID );

    if( $page_template_slug == $custom_template_slug ){
        return plugin_dir_path( __FILE__ ) . $custom_template_slug;
    }

    return $template;

}
1
jg314

あなたはあなたのページテンプレートを挿入するためにtheme_page_templatesフィルタを使うことができます。

例えば：

add_filter( 'theme_page_templates', 'filter_inject_page_templates' );

filter_inject_page_templates( $templates ) {
    $path               = 'path/to/the/template/relative/to/the/theme/folder';
    $templates[ $path ] = 'Name of the template that displays in dropdown;
    return $templates;
}

正しい値にするには$pathの値を試してみる必要があるかもしれませんが、これでうまくいくはずです。

それが役に立てば幸い！

1
Welcher