Rută personalizată pentru plugin în WordPress

Trebuie să faci trei lucruri importante:

1. Crează o regulă personalizată de rescriere pentru a transforma părți din URI în valori transmise către index.php.
2. Adaugă myroute și myargument la lista de variabile de interogare permise în WordPress, astfel încât WordPress să nu le ignore când apar într-un șir de interogare.
3. Resetează regulile de rescriere.

În primul rând, recomand să folosești un prefix sau sufix special pentru a indica când URI-ul ar trebui considerat una dintre aceste 'rute' speciale. Pentru acest exemplu, am ales prefixul api, astfel încât adresa să fie http://www.example.org/api/myroute/myargument. Am ales api pentru că atunci când am implementat ceva RESTful, similar cu ceea ce pare că lucrezi, a fost pentru un API.

Codul

add_filter( 'rewrite_rules_array', 'my_insert_rewrite_rules' );
add_filter( 'query_vars', 'my_insert_query_vars' );
add_action( 'wp_loaded', 'my_flush_rules' );

// Resetează regulile dacă regulile noastre nu sunt încă incluse
function my_flush_rules() {
    $rules = get_option( 'rewrite_rules' );

    if ( ! isset( $rules['api/(.*?)/(.+?)'] ) ) {
        global $wp_rewrite;
        $wp_rewrite->flush_rules();
    }
}

// Adăugarea unei noi reguli
function my_insert_rewrite_rules( $rules ) {
    $newrules = array();
    $newrules['api/(.*?)/(.+?)'] = 'index.php?myroute=$matches[1]&myargument=$matches[2]';
    return $newrules + $rules;
}

// Adăugarea variabilelor id astfel încât WordPress să le recunoască
function my_insert_query_vars( $vars ) {
    array_push( $vars, 'myroute', 'myargument' );
    return $vars;
}

Scurtă explicație

Este destul de simplu. Modelul regex este adăugat la lista tuturor regulilor de rescriere din WordPress, iar modelul tău personalizat este în partea de sus a listei. Când modelul este potrivit, WordPress va înceta să mai caute prin lista de reguli de rescriere și va folosi valorile capturate ale regex în locul referințelor ($matches[1] și $matches[2]) din șirul de interogare transmis către index.php.

Adăugarea variabilelor de interogare myroute și myargument la lista de permisiuni face ca WordPress să le ia în considerare în loc să le ignore.

Altă metodă de a 'namespace-ui' ruta personalizată

Dacă dorești să eviți utilizarea prefixului /api/, poți folosi în schimb o variabilă/câmp de interogare. Pentru a face asta, ai putea schimba regex-ul în ceva de genul (.*?)/(.+?)\\?api=1 și apoi să adaugi api ca parametru suplimentar la apelul array_push() din my_insert_query_vars().

Asta ar schimba ruta personalizată astfel încât să se activeze ori de câte ori api=1 este primul element al șirului de interogare, de exemplu, s-ar activa pentru http://example.com/anytext/anytext?api=1.

Ignoră utilizarea termenului 'namespacing' - l-am folosit doar pentru concizie.

Dacă nu folosești un prefix sau un sufix pentru a 'namespace-ui', vei ajunge cu modele de URI care se suprapun. Acest lucru se întâmplă pentru că WordPress nu va avea nicio modalitate de a distinge modelul tău personalizat de unul destinat să fie o postare sau o pagină. Cum ar ști WordPress că myroute nu este o taxonomie, un termen sau o pagină părinte?

Sper că acest lucru te ajută.