web-dev-qa-db-fra.com

Quelle est la bonne façon de construire un widget en utilisant OOP

Je travaille sur un widget de formulaire de recherche simple, avec une fonctionnalité de saisie semi-automatique intégrée (vous pouvez télécharger la version actuelle ici ). Le plugin fonctionne, mais je suis en train de réécrire tout le code en utilisant la POO. L'un des problèmes que j'ai rencontré est le fait qu'un widget Wordpress fait déjà partie de la classe WP_Widget. Je peux diviser le code en 2 classes. Le premier charge tous les scripts et css, et initialise le widget. Voici le contour du code:

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' );
        }
}

Et voici le contour de la classe de widgets:

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.
    }
}

J'aimerais combiner les deux afin d'utiliser wp_localize_script et de charger le script avec les options du widget. Comment devrais-je faire ça? Toutes les suggestions sont les bienvenues, même si vous me direz que je suis dans la mauvaise direction ...

plugin-developmentphpwidgetsoopwp-localize-script
7
Yoav Kadosh

Vous pouvez simplement mettre votre code init dans le constructeur de la classe. Par exemple:

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');

Ma préférence est de placer les appels de mise en file d'attente dans la fonction de traitement du shortcode afin d'éviter les frais généraux et les conflits potentiels associés au chargement de JavaScript et de feuilles de style non utilisées sur une page donnée.

9
Steve

Votre code est de style PHP4. Le code stylé PHP4 ne devrait plus être utilisé. Et simplement mettre certaines fonctions dans une construction de classe n'est pas une POO. Si vous voulez écrire du code réutilisable, séparez votre code.

Par exemple:

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;
    }

}

Cette classe peut être réutilisée pour chaque widget. L'idée derrière OOP est de réutiliser votre code en écrivant des constructions de données avec une fonction supplémentaire. Ne pas utiliser les constructions de classe parce que quelqu'un dit que c'est un bon style.

La classe pourrait être utilisée comme ceci:

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