WP_AJAX

WP_AJAX

WordPress 用のシンプルなコントローラー

WP_AJAX は、WordPress の組み込み AJAX システムとインターフェイスするためのクラスです。このクラスは、開発者を従来のフック ベースのシステムからクリーンなコントローラー スタイルの構造に完全に抽象化するように設計されています。クラスを定義し、url($params = []) メソッドで URL をエコーし​​、実行したいコードを run() メソッドに記述するだけです。

はじめに:ミディアムポスト

 Class ExampleAction extends WP_AJAX {

    protected $ action = ' example-action ' ;

    protected function run (){

    	// Your Code Here!
    	
    	update_option ( ' name ' , $ this -> get ( ' name ' ));

    }
}
ExampleAction:: listen ();

ExampleAction::url() // http://example.com/wp-admin/admin-ajax.php?action=example-action
ExampleAction:: url ([ ' name ' => ' Anthony Budd ' ]) // http://example.com/wp-admin/admin-ajax.php?action=example-action&name=Anthony%20Budd

ExampleAction.php

フォントエンド

 < a href =" <?= ExampleAction::url(['name' => 'Anthony Budd']) ?> " > This is a link </ a >

ページテンプレート.php

または

 $ ( '.submit-btn' ) . click ( function ( ) {

    $ . post ( 'http://example.com/wp-admin/admin-ajax.php' , {
        action : 'example-action' ,
        name : $ ( '.name-field' ) . val ( ) ,
    } , function ( data ) {
        console . log ( data )
    } , 'JSON' ) ;
    
} ) ;

スクリプト.js

インストール

Composer では WP_AJAX が必要

 $ composer require anthonybudd/wp_ajax

または

WP_AJAX クラスをダウンロードし、functions.php ファイルの先頭でそれを要求します。

    require ' src/WP_AJAX.php ' ;

---

設定

WP_AJAX を拡張する新しいクラスを作成する必要があります。このクラスには、$action という名前の保護されたプロパティが 1 つと、run() という名前の保護されたメソッドが 1 つ必要です。 $action は AJAX アクション名になります。「wp_ajax_(action)」を参照してください。

 Class Example extends WP_AJAX
{
    protected $ action = ' example ' ;

    protected function run (){
        echo " Success! " ;
    }
}

---

聞く

次に、静的メソッド listen() を呼び出す必要があります。これにより、すべてのフックが作成され、WordPress は正しい AJAX エンドポイントがヒットしたときに run() メソッドを呼び出すことができるようになります。注: AJAX アクションごとに listen() メソッドを呼び出す必要があります。

ExampleAJAX:: listen ();

サインインしているユーザーのみに AJAX エンドポイントへのアクセスを許可する場合は、引数 FALSE を listen メソッドに追加します。

ExampleAJAX:: listen ( FALSE );

---

JSON応答

データを使用して AJAX リクエストに応答する場合、JSONResponse() メソッドはコンテンツ タイプ ヘッダーを自動的に「application/json」に設定し、メソッドに提供されたデータを JSON エンコードします。

WordPress に wp_send_json() と呼ばれる関数があることは知っていますが、このメソッドを含めたことが WP 開発者をどれほど悩ませているかを知っているため、削除するつもりはありません。

 Class ExampleAJAX extends WP_AJAX {
    ..

    protected function run (){
        $ post5 = get_post ( 5 );

        $ this -> JSONResponse ( $ post5 );
    }
}

---

ヘルパーメソッド

Example:: url () // Returns the url of the ajax endpoint. Example http://ajax.local/wp/wp-admin/admin-ajax.php?action=example

$ this -> isLoggedIn (); // Returns TRUE or FALSE if the current visitor is a logged in user.

$ this -> has ( $ key ); // has() will return TRUE or FALSE if an element exists in the $_REQUEST array with a key of $key

$ this -> get ( $ key , [ $ default = NULL ]); // The get() method will return the specified HTTP request variable. If the variable does not exist it will return NULL by default. If you would like to set a custom string as the default, provide it as the second argument.

$ this -> requestType (); // Returns 'PUT', 'POST', 'GET', 'DELETE' depending on HTTP request type

$ this -> requestType ( ' POST ' ); // Returns (bool) 

$ this -> requestType ([ ' POST ' , ' PUT ' ]); // Returns (bool)  

例

 Class CreatePost extends WP_AJAX
{
    protected $ action = ' create_post ' ;

    protected function run (){
        if ( $ this -> isLoggedIn ()){
            $ post = [
                ' post_status ' => ' publish '
            ];
            
            if ( $ this -> requestType ([ ' POST ' , ' put ' ]) ){
                $ post [ ' post_content ' ] = ' This request was either POST or PUT ' ;
            } else if ( $ this -> requestType ( ' get ' ) ){
                $ post [ ' post_content ' ] = ' This request was GET ' ;
            }

            $ post [ ' post_title ' ] = sprintf ( ' This post was created by %s ' , $ this -> user -> data -> user_nicename );
            
            wp_insert_post ( $ post );

            $ this -> JSONResponse ( $ post );
        }
    }
}

CreatePost:: listen ();

// http://example.com/wp-admin/admin-ajax.php?action=create_post