web-dev-qa-db-ja.com

を使用してウィジェットを構築するための正しい方法は何ですか OOP

私は自動補完機能を内蔵した簡単な検索フォームウィジェットを開発しています（現在のバージョンは ここ でダウンロードできます）。プラグインは動作していますが、私は現在OOPを使用してすべてのコードを書き換えています。私が遭遇した問題の1つは、WordpressウィジェットがすでにWP_Widgetクラスの一部であるという事実です。コードを2つのクラスに分けることができます。最初のスクリプトはすべてのスクリプトとCSSをロードし、ウィジェットを初期化します。コードの概要は次のとおりです。

class wdSearchForm {

        public function __construct() {
            // Action hook to load widget
            // Register and enqueue styles
            // Register and enqueue scripts
        }

        // register widget in WordPress so that it is available under the widgets section
        public function wd_searchform() {
            register_widget( 'wd_searchform' );
        }
}

これがウィジェットクラスの概要です。

class wd_searchform extends WP_Widget {

    // Constructor
    function wd_searchform() {

    }

    // The widget itself
    function widget( $args, $instance ) {
        // The widget code
    }

    //Update the widget 
    function update( $new_instance, $old_instance ) {
        // Update code
    }

    function form( $instance ) {
        //Set up widget settings.
    }
}

wp_localize_scriptを使用してウィジェットオプションでスクリプトをロードするために、2つを組み合わせたいと思います。どうすればいいの？あなたが私に完全に間違った方向にいると言ってもあなたがどんな提案でも歓迎します...

plugin-developmentphpwidgetsoopwp-localize-script
7
Yoav Kadosh

あなたのinitコードを単にクラスのコンストラクタ内に置くことができます。例えば：

class myWidget extends WP_Widget{

    function myWidget(){
       // Init code here
    }

    function widget( $args, $instance ) {
       // The widget code
       wp_enqueue_script(...);
       wp_enqueue_style(...);

   }

   // Over methods...

}

register_widget('myWidget');

私の好みは、特定のページで使用されていないJavaScriptとスタイルシートのロードに関連するオーバーヘッドと潜在的な競合を避けるために、実際にはエンキュー呼び出しをショートコード処理関数内に入れることです。

9
Steve

あなたのコードはPHP4スタイルです。 PHP 4スタイルのコードはもう使用しないでください。そして、クラス構成内にいくつかの関数を入れるだけでは、OOPにはなりません。再利用可能なコードを書きたい場合は、コードを分けてください。

例えば：

class Widget_Setup
{
    public $widget_class  = '';
    public $admin_styles  = array();
    public $admin_scripts = array();
    public $front_styles  = array();
    public $front_scripts = array();

    public $script_defaults = array(
        'handle'    => '',
        'src'       => '',
        'deps'      => array(),
        'version'   => false,
        'in_footer' => false
    );

    public $style_defaults = array(
        'handle'   => '',
        'src'      => '',
        'deps'     => array(),
        'version'  => false,
        'media'    => 'all'
    );

    public function __construct( $widget_class = '', $admin_styles = array(), $admin_scripts = array(), $front_styles = array(), $front_scripts = array() ) {

        $this->widget_class  = $widget_class;
        $this->admin_styles  = $admin_styles;
        $this->admin_scripts = $admin_scripts;
        $this->front_styles  = $front_styles;
        $this->front_scripts = $front_scripts;

        add_action( 'admin_print_styles',    array( $this, 'add_styles' ) );
        add_action( 'admin_enqueue_scripts', array( $this, 'add_scripts' ) );
        add_action( 'wp_enqueue_scripts',    array( $this, 'add_styles' ) );
        add_action( 'wp_enqueue_scripts',    array( $this, 'add_scripts' ) );

        if( ! empty( $this->widget_class ) )
            add_action( 'widgets_init', array( $this, 'register_widget' ) );

    }

    public function register_widget() {

        register_widget( $this->widget_class );

        return true;

    }

    public function add_styles() {

        $styles = ( is_admin() ) ?
            $this->admin_styles : $this->front_styles;

        if( empty( $styles ) )
            return false;

        foreach( $styles as $style ) {

            $style = wp_parse_args( $style, $this->style_defaults );

            wp_enqueue_style(
                $style['handle'],
                $style['src'],
                $style['deps'],
                $style['version'],
                $style['media']
            );

        }

        return true;
    }

    public function add_scripts() {

        $scripts = ( is_admin() ) ?
            $this->admin_scripts : $this->front_scripts;

        if( empty( $scripts ) )
            return false;

        foreach( $scripts as $script ) {

            $script = wp_parse_args( $script, $this->script_defaults );

            wp_enqueue_script(
                $script['handle'],
                $script['src'],
                $script['deps'],
                $script['version'],
                $script['media']
            );

        }

        return true;
    }

}

このクラスはすべてのウィジェットに再利用できます。 OOPの背後にある考え方は、追加の機能を持つデータ構造を書くことによってあなたのコードを再利用することです。誰かがそれが良いスタイルだと言うのでクラス構成を使わない。

このクラスは次のように使用できます。

class MyAwesomeWidget extends WP_Widget
{

    const TEXTDOMAIN = 'widget_textdomain';

    public function __construct() {

        parent::__construct(

            'widget-name-id',
            __( 'Widget Name', self::TEXTDOMAIN ),
            array(
                'classname'   =>    __CLASS__,
                'description' =>    __( 'Short description.', self::TEXTDOMAIN )
            )
        );

        $admin_style = array(
            array( 'handle' => 'somehandle', 'src' => 'path/to/source' ),
            array( 'handle' => 'someotherhandle', 'src' => 'path/to/source' ),
        );

        $admin_scripts = array(
            array( 'handle' => 'scrpthandle', 'src' => 'path/to/source', 'deps' => array( 'jquery') ),
        );

        $front_styles = array(
            array( 'handle' => 'frontstyle', 'src' => 'path/to/src' ),
        );

        new Widget_Setup( __CLASS__, $admin_style, $admin_scripts, $front_styles );
    }

    public function widget( $instance, $args ) {}

    public function update( $new_instance, $old_instance ) {}

    public function form( $instance ) {}

}
5
Ralf912