WP_AJAX ist eine Klasse für die Schnittstelle zum integrierten AJAX-System von WordPress. Diese Klasse soll den Entwickler vollständig vom traditionellen Hook-basierten System zu einer sauberen Controller-ähnlichen Struktur abstrahieren. Definieren Sie einfach die Klasse, geben Sie URLs mit der Methode url($params = []) zurück und schreiben Sie, welchen Code Sie in der Methode run() ausführen möchten.
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
BeispielAktion.php
< a href =" <?= ExampleAction::url(['name' => 'Anthony Budd']) ?> " > This is a link </ a >
Seitenvorlage.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' ) ;
} ) ;
script.js
Erfordert WP_AJAX mit Composer
$ composer require anthonybudd/wp_ajax
Laden Sie die Klasse WP_AJAX herunter und fordern Sie sie oben in Ihrer Datei „functions.php“ ein.
require ' src/WP_AJAX.php ' ;
Sie müssen eine neue Klasse erstellen, die WP_AJAX erweitert. Diese Klasse muss über eine geschützte Eigenschaft namens $action und eine geschützte Methode namens run() verfügen. $action ist der AJAX-Aktionsname. Siehe wp_ajax_(action).
Class Example extends WP_AJAX
{
protected $ action = ' example ' ;
protected function run (){
echo " Success! " ;
}
}
Als nächstes müssen Sie die statische Methode listen() aufrufen. Dadurch werden alle Hooks erstellt, sodass WordPress weiß, dass es die run()-Methode aufrufen muss, wenn der richtige AJAX-Endpunkt erreicht wird. Hinweis: Sie müssen die Methode listen() für jede Ihrer AJAX-Aktionen aufrufen.
ExampleAJAX:: listen ();
Wenn Sie nur angemeldeten Benutzern den Zugriff auf Ihren AJAX-Endpunkt erlauben möchten, fügen Sie der Listen-Methode das Argument FALSE hinzu.
ExampleAJAX:: listen ( FALSE );
Wenn Sie auf eine AJAX-Anfrage mit Daten antworten möchten, setzt die JSONResponse()-Methode den Inhaltstyp-Header automatisch auf „application/json“ und JSON kodiert die der Methode bereitgestellten Daten.
Ich bin mir bewusst, dass WordPress eine Funktion namens wp_send_json() hat, aber da ich weiß, wie sehr es WP-Entwickler nervt, dass ich diese Methode eingebunden habe, werde ich sie nicht entfernen.
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