Introduzione alle API di WordPress

In questo articolo introdurremo le API di WordPress.

Le API di WordPress si suddividono in diverse sezioni. Ogni sezione comprende in genere due tipi di argomenti associati:

1. Classi
2. Funzioni

Le classi sono una scelta obbligatoria solo in alcuni casi, perché il principio chiave di WordPress è quello di permettere agli autori di temi e plugin di utilizzare le funzioni.

Tutte le funzioni di WordPress fanno riferimento ad una classe del Core. Di fatto le funzioni nascondono la logica della classe secondo il principio della modularità.

Quando si usa una funzione bisogna leggere nella documentazione tre parti fondamentali:

1. parametri
2. valori di ritorno
3. casi d’uso

WordPress in genere usa gli array associativi per assegnare alle funzioni dei parametri predefiniti. A differenza del tradizionale modo con cui i parametri predefiniti vengono passati alle funzioni in PHP, in questo caso l’ordine dei parametri non è rilevante.

Al contrario, se la funzione utilizza il modo tradizionale di passare gli argomenti, in questo caso invece l’ordine dei parametri è rilevante.

Quello a cui bisogna prestare un’attenzione particolare sono i valori di ritorno.

I valori di ritorno si differenziano a seconda che la funzione restituisca il valore sperato o no. Se la funzione ha successo, WordPress restituirà un valore (ad esempio un array di oggetti), altrimenti può restituire un tipo di dati PHP (false, null ecc.) oppure un’istanza della classe WP_Error. Ad esempio, prendiamo la funzione wp_remote_get():

$remote_file = wp_remote_get( ‘http://sito/file.txt' );
if( !is_wp_error( $remote_file ) ) {
    // Successo!
}

Invece, per la funzione wp_get_attachment_image_src() avremo:

$attachment_id = 8;
$image = wp_get_attachment_image_src( $attachment_id );
if( $image ) {
    // Successo!
}

Questa funzione restituisce un array, quindi in questo caso la verifica da effettuare è diversa.

Leggete sempre con attenzione gli esempi forniti nella documentazione. Si tratta di codice che illustra perfettamente i casi d’uso delle funzioni o delle classi trattate.