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

範例操作.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

安裝

需要 WP_AJAX 與作曲家

 $ composer require anthonybudd/wp_ajax

或者

下載 WP_AJAX 類別並將其新增至 function.php 檔案的頂部。

    require ' src/WP_AJAX.php ' ;

---

設定

您將需要建立一個擴展 WP_AJAX 的新類別。此類別必須具有一個名為 $action 的受保護屬性和一個名為 run() 的受保護方法。 $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 新增至監聽方法。

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