WP_AJAX

WP_AJAX

Простые контроллеры для WordPress

WP_AJAX — это класс для взаимодействия со встроенной системой AJAX WordPress. Этот класс предназначен для полного абстрагирования разработчика от традиционной системы, основанной на хуках, к чистой структуре стиля контроллера. Просто определите класс, отобразите URL-адреса с помощью метода url($params = []) и напишите, какой код вы хотите выполнить в методе 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

ПримерAction.php

Конец шрифта

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

Страница-Template.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 знал, что нужно вызвать метод run() при попадании в правильную конечную точку AJAX. Примечание. Вам нужно будет вызвать метод Listen() для каждого действия AJAX.

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