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