テンプレート内でプラグインクラスを使用する


9

リンクをクリックするとフォームを開く友達に招待状を送信するプラグインを書いています。@toschoによるReport Broken Videoプラグインで指定されたコードに従って、すべての関数をクラスにカプセル化しました。関連するコードは次のとおりです。

/*
Plugin Name: Send Invitation
Plugin URI: http://w3boutique.net
Description: Emails a the link of the current page to a friend
Author: Nandakumar Chandrasekhar
Version: 0.1
Author URI: http://w3boutique.net/about-nanda.html
License: GPL2
*/

// include() or require() any necessary files here

// Settings and/or Configuration Details go here
define('SEND_INVITATION_MIN_WORDPRESS_VERSION', '3.1.1');

define('SEND_INVITATION_PLUGIN_URL', plugins_url('', __FILE__));

add_action( 'init', array( 'SendInvitation', 'nc_sendinvitation_init' ) );

class SendInvitation {

    protected $nonce_name = 'nc_sendinvitation';
    protected $post_url = '';

    public static function nc_sendinvitation_init() {
        new self;
    }

    public function __construct() {
        add_action( 'init', array(&$this, 'nc_sendinvitation_head' ));
        add_action( 'init', array(&$this,  'nc_sendinvitation_check_wordpress_version' ));
       add_action( 'init', array(&$this, 'nc_sendinvitation_form_action' ));
       //$this->post_url = $this->nc_sendinvitation_get_post_url();
   }

   public function nc_sendinvitation_head() {
       wp_enqueue_script( 'jquery' );
       wp_enqueue_script( 'send_invitation_js',
        plugins_url( 'js/send-invitation.js', __FILE__ ),
        array( 'jquery' ) );

       wp_enqueue_style( 'send_invitation_css',
        plugins_url( 'css/send-invitation.css', __FILE__ ) );
   }

   public function nc_sendinvitation_check_wordpress_version() {
       global $wp_version;

       $exit_msg = 'Send Invitation requires version '
    . SEND_INVITATION_MIN_WORDPRESS_VERSION
    . 'or newer <a href="http://codex.wordpress.org/Upgrading_WordPress">Please
update!</a>';

       if ( version_compare( $wp_version, SEND_INVITATION_MIN_WORDPRESS_VERSION, '<') )
       {
            exit( $exit_msg );
       }
   }

   public function nc_sendinvitation_form_action() {

        $action = '';
        if ( $_SERVER['REQUEST_METHOD'] != 'POST' )
        {
             $action = $this->nc_sendinvitation_get_form();
        }
        else if ( $_SERVER['REQUEST_METHOD'] == 'POST' ) {
            $action = $this->nc_sendinvitation_handle_submit();
        }
        return $action;
   }

   public function nc_sendinvitation_get_form() {
       // Start the output buffer, prevents content being output directly into
       // script, instead it is stored in a buffer which can then be flushed
       // to allow the include file to be stored in a variable
       // See http://www.codingforums.com/showthread.php?t=124537
       ob_start();
       include('send-invitation-form.php');
       $send_invitation_link = ob_get_clean();

       return $send_invitation_link;
   }

   public function nc_sendinvitation_handle_submit() {
         if ( isset( $_POST['form_type'] ) && ( $_POST['form_type'] == 'nc_sendinvitation' ) ) {
            $to = 'navanitachora@gamil.com';
            $subject = 'Invitation to SwanLotus';
            $message = 'Navanitachora invites you to take a look at this link';
            wp_mail($to, $subject, $message);
            $result = 'Email was sent successfully';
    }
    else {
        $result = $this->nc_sendinvitation_get_form();
    }
    return $result;
}

public function nc_sendinvitation_get_post_url() {
    global $post;
    $blog_id = get_option('page_for_posts');
    $post_id = '';
    if (is_home($blog_id)) {
        $post_id = $blog_id;
    } else {
        $post_id = $post->ID;
    }

    return get_permalink($post_id);
}
}
/* End of File */
?>

フォームを表示できるように、テンプレートでこのクラスを使用する方法について迷っています。クラスをインスタンス化する必要があることはわかっていますが、コードをどこに配置し、どのようにオブジェクトにアクセスして、テンプレートで使用できるかわかりません。私はOOPの知識を持っていますが、これまでこのコンテキストで使用したことがなく、少しずつ手順を説明する必要があります。

どうもありがとう。

回答:


9

オブジェクトを知らなくてもクラスを使用する最良の方法はアクションです。プレゼンテーション用のテーマファイルが読み込まれる前にアクションを登録すると、WordPressが残りを処理します。

サンプルコード:

<?php # -*- coding: utf-8 -*-
/**
 * Plugin Name: Plugin Action Demo
 */
add_action( 'init', array ( 'Plugin_Action_Demo', 'init' ) );

class Plugin_Action_Demo
{
    /**
     * Creates a new instance.
     *
     * @wp-hook init
     * @see    __construct()
     * @return void
     */
    public static function init()
    {
        new self;
    }

    /**
     * Register the action. May do more magic things.
     */
    public function __construct()
    {
        add_action( 'plugin_action_demo', array ( $this, 'print_foo' ), 10, 1 );
    }

    /**
     * Prints 'foo' multiple $times.
     *
     * Usage:
     *    <code>do_action( 'plugin_action_demo', 50 );</code>
     *
     * @wp-hook plugin_action_demo
     * @param int $times
     * @return void
     */
    public function print_foo( $times = 1 )
    {
        print str_repeat( ' foo ', (int) $times );
    }
}

これdo_action( 'plugin_action_demo', 50 );で、テーマまたは別のプラグインのどこかで呼び出すことができ、クラスの内部の仕組みを気にする必要がなくなります。

プラグインを非アクティブ化しても、安全です。WordPressは不明なアクションを無視do_action()するだけで、害はありません。さらに、他のプラグインはアクションを削除または置き換えることができるので、1つの素晴らしいAPIを作成できますadd_action()

シングルトンを構築することもできます:

<?php # -*- coding: utf-8 -*-
/**
 * Plugin Name: Plugin Singleton Demo
 */
class Plugin_Singleton_Demo
{
    protected static $instance = NULL;

    /**
     * Creates a new instance if there isn't one.
     *
     * @wp-hook init
     * @return object
     */
    public static function get_instance()
    {

        NULL === self::$instance and self::$instance = new self;
        return self::$instance;
    }

    /**
     * Not accessible from the outside.
     */
    protected function __construct() {}

    /**
     * Prints 'foo' multiple $times.
     *
     * @param int $times
     * @return void
     */
    public function print_foo( $times = 1 )
    {
        echo str_repeat( ' foo ', (int) $times );
    }
}

現在print_foo()は次の方法でアクセスできます。

Plugin_Singleton_Demo::get_instance()->print_foo();

シングルトンパターンはお勧めしません。いくつかの重大な欠点があります。


1
好奇心から、目的のものですplugin_action_demoではadd_action()do_action( 'print_foo', 50 );アクションplugin_action_demoがその名前である、またはその名前が無関係であることをどうやって知るのですか?
Jared、

わかりました、少し混乱しました。:)それを片付けてくれてありがとう。
Jared

記録のため:declare()php 5.3+が必要です:)
カイザー

機能するおかげで、検証を追加するだけで済みます。@toschoに感謝します。:-)
navanitachora 2012年

@tosco WordPressプラグインのシングルトンに関する記事を探してあなたの答えを見つけました。あなたが実現しないされている、あなたはそれをあなたの推奨の答えにシングルトンを使用して施行されていませんか?themerコールを想像してみnew Plugin_Action_Demo?を使用しているユーザーは、あなたが望むものではなく、do_action('plugin_action_demo')への2つの呼び出しをトリガーしPlugin_Action_Demo->print_foo()ます。シングルトンをめぐる騒動では、適切なユースケースは無視されます。参考までに、@ ericmannと私は両方ともWordPressプラグインのネームスペースのシングルトンを提唱するためにブログを書いています。彼はeamann.comに、私はhardcorewp.comにいます。
MikeSchinkel 2013年
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.