Kaip sukurti modernią žiniatinklio programą naudojant „WordPress“ ir reaguoti

Sujunkite „React“ sąsajos galią su populiariausia interneto TVS

Norite šiuolaikinio „React SPA“ pranašumų, bet reikalinga „back-end“, kuri jaučiasi pažįstama? Šiame straipsnyje mes apžvelgsime, kaip nustatyti „WordPress“ REST API, įskaitant pasirinktinius įrašų tipus ir laukus, ir kaip gauti šiuos duomenis „React“.

Neseniai dirbau su kliento programa „React“, kai jie man atsakė į šį klausimą: „Ar galime ją naudoti su„ WordPress “ ? "

Nuo 2015 m. Pabaigos atsakymas į šį klausimą buvo teigiamas. Tačiau veiksmai, būtini norint sukurti veikiančią atsietą svetainę, gali atrodyti nesudėtingi, ypač tiems, kurie nėra susipažinę su „WordPress“ ir „ React“.

Keliaudamas kurdamas veikiančią programą susidūriau su keliomis keblomis kliūtimis ir šiame straipsnyje paaiškinsiu, kaip jų išvengti. Taip pat pasidalinsiu keliais patarimais ir gudrybėmis, kurių išmokau pakeliui!

Turinys

1 dalis. Pagrindinė informacija

  • Kas yra CMS be galvos?
  • Ką turėčiau žinoti, kad galėčiau sekti kartu?
  • Pagrindiniai akronimai
  • Kur galiu pamatyti „WordPress“ JSON duomenis?

2 dalis: „WordPress“

  • Pridedamas pasirinktinis įrašo tipas
  • Pavadinimo vietos rezervavimo ženklo teksto keitimas
  • Tinkinto lauko pridėjimas prie pasirinktinio įrašo tipo
  • Pasirinktų laukų pateikimas kaip JSON
  • Apriboti matomus JSON duomenis

3 dalis: Reakcija

  • Pažadai „JavaScript“
  • „Fetch“ metodas
  • Tvarkyti pažadus

Darbinis „React“ pavyzdys

Išvada

1 dalis. Pagrindinė informacija

Kas yra CMS be galvos?

Anksčiau naudodamas CMS, pvz., „WordPress“, turėjai susikurti savo priekinę dalį naudodamas PHP.

Dabar, naudodamiesi TVS be galvos, galite sukurti savo priekinę dalį naudodami bet kokias jums patinkančias technologijas; taip yra dėl to, kad per API atskirtas front-end ir back-end. Jei norite sukurti SPA (vieno puslapio programą) naudodami „React“, „Angular“ arba „Vue“ ir valdyti turinį naudodami CMS, pvz., „WordPress“, galite!

Ką turėčiau žinoti, kad galėčiau sekti kartu?

Išnaudosite šį straipsnį kuo daugiau, jei turite:

  • šiek tiek žinių apie tai, kaip veikia CMS, pvz., „WordPress“, šiek tiek PHP ir idėja, kaip kompiuteryje nustatyti pagrindinį „WordPress“ projektą;
  • supratimas apie „JavaScript“, įskaitant ES6 + kalbos ypatybes ir „React“ klasės sintaksę.

Pagrindiniai akronimai

Programavimas yra pilnas žargono, tačiau jis leidžia daug greičiau aptarti kai kurias šio straipsnio sąvokas. Štai trumpas terminų, kuriuos naudosime, santrauka:

  • CMS - turinio valdymo sistema. Pagalvokite apie „WordPress“, „Drupal“, „Joomla“, „Magneto“.
  • SPA - vieno puslapio programa. Užuot perkėlusi kiekvieną puslapį ištisai, SPA programa dinamiškai įkelia turinį. Pagrindinis svetainės kodas (HTML, CSS ir „JavaScript“) įkeliamas tik vieną kartą. Pagalvokite apie reakciją, teisybę, kampą.
  • API - programos programavimo sąsaja. Paprasčiau tariant, apibrėžimų, kuriuos teikia paslauga, serija, leidžianti jums paimti ir naudoti jos duomenis. „Google Maps“ turi vieną. „Medium“ turi vieną. Ir dabar kiekviena „WordPress“ svetainė turi integruotą API.
  • REST - reprezentacinės valstybės perkėlimas. Iš interneto architektūros stiliaus aplink HTTP prašymu metodus: GET, PUT, POSTir DELETE. „WordPress“ integruota API yra REST arba „RESTful“ API.
  • HTTP - hiperteksto perdavimo protokolas. Taisyklių rinkinys, naudojamas duomenims perduoti žiniatinklyje. URL pradžioje nurodoma kaip httparba https(saugi versija).
  • JSON - „JavaScript“ objektų žymėjimas. Nors tai gaunama iš „JavaScript“, tai yra nuo kalbos nepriklausomas duomenų saugojimo ir perdavimo formatas.

Šiame straipsnyje mes naudojame „WordPress“ kaip savo TVS. Tai reiškia, kad reikia programuoti mūsų programinę įrangą PHP programoje ir naudoti „WordPress“ REST API, kad JSON duomenys būtų pristatyti į mūsų priekinę dalį.

Kur galiu pamatyti „WordPress“ JSON duomenis?

Prieš eidami į gerus dalykus, greitai užrašykite, kur galite rasti JSON duomenis savo „WordPress“ svetainėje. Šiuo metu kiekvienoje „WordPress“ svetainėje yra JSON duomenų (nebent svetainės savininkas išjungė ar apribojo prieigą prie jų). Pažvelgę ​​į pagrindinį „WordPress“ svetainės JSON, pridedate /wp-jsonprie šakninio domeno vardo.

Taigi, pavyzdžiui, galite pažvelgti į „JSON for WordPress.org“ apsilankę //wordpress.org/wp-json. Arba, jei jūs naudojate „WordPress“ svetainę vietoje, galite pamatyti jos JSON sekdami localhost/yoursitename/wp-json.

Norėdami pasiekti savo įrašų duomenis, įveskite localhost/yoursitename/wp-json/wp/v2/posts. Jei norite naudoti pasirinktinį pranešimo formatą, pakeiskite nauju formatu (pvz. movies), O ne posts. Tai, kas dabar atrodo kaip neįskaitomas teksto blokas, būtent tai leis mums naudoti „WordPress“ kaip TV be galvos!

2 dalis: „WordPress“

Norėdami nustatyti „REST“ API, didžioji dalis to, ką turėsite padaryti, įvyks jūsų functions.phpfaile. Aš manysiu, kad jūs žinote, kaip sukurti „WordPress“ projektą ir prieiti prie jo naudodamiesi localhost, tačiau jei jums reikia pagalbos, rekomenduoju šį straipsnį (tai aš anksčiau pradėjau programuoti su „WordPress“).

Daugumoje projektų norėsite naudoti pasirinktinį įrašo tipą, todėl pradėkime nuo jo nustatymo.

Pridedamas pasirinktinis įrašo tipas

Tarkime, kad mūsų svetainė yra apie filmus ir norime įrašų tipo, vadinamo „filmai“. Pirmiausia norime įsitikinti, kad „filmų“ įrašų tipas yra kuo greičiau įkeltas, todėl pritvirtinsime jį prie initkablio naudodami add_action:

add_action( 'init', 'movies_post_type' );

Aš naudojuosi movies_post_type(), bet savo funkciją galite vadinti kuo tik norite.

Toliau norime registruoti „filmus“ kaip įrašo tipą, naudodamiesi register_post_type()funkcija.

The next chunk of code may look overwhelming, but it’s relatively simple: our function takes a lot of in-built arguments to control the functionality of your new post type, and most of them are self-explanatory. We’ll store these arguments in our $args array.

One of our arguments, labels , can take many different arguments of its own, so we split that off into a separate array, $labels , giving us:

Two of the most important arguments are 'supports' and 'taxomonies' , because these control which of the native post fields will be accessible in our new post type.

In the above code, we’ve opted for just three 'supports':

  • 'title'— the title of each post.
  • 'editor'— the primary text editor, which we’ll use for our description.
  • 'thumbnail'— the post’s featured image.

To see the full list of what’s available, click here for supports, and here for taxonomies.

Generate WordPress also has a handy tool to help you code custom post types, which can make the process a lot quicker.

Changing Title Placeholder Text

If the title placeholder text “enter title here” could be a little misleading for your custom post type, you can edit this in a separate function:

Adding a Custom Field to Your Custom Post Type

What if you want a field that doesn’t come pre-defined by WordPress? For example, let’s say we want a special field called “Genre”. In that case, you’ll need to use add_meta_boxes() .

For, we need to attach a new function to WordPress’s add_meta_boxes hook:

add_action( 'add_meta_boxes', 'genre_meta_box' );

Inside our new function, we need to call WordPress’s add_meta_box() function, like so:

function genre_meta_box() { add_meta_box( 'global-notice', __( 'Genre', 'sitepoint' ), 'genre_meta_box_callback', 'movies', 'side', 'low' );}

You can read more about this function’s arguments here. For our purposes, the most critical part is the callback function, which we’ve named genre_meta_box_callback . This defines the actual contents on the meta box. We only need a simple text input, so we can use:

function genre_meta_box_callback() { global $post; $custom = get_post_custom($post->ID); $genre = $custom["genre"][0]; ?>
    

Finally, our custom field won’t save its value unless we tell it to. For this purpose, we can define a new function save_genre() and attach it to WordPress’s save_post hook:

function save_genre(){ global $post; update_post_meta($post->ID, "printer_category", $_POST["printer_category"]);};
add_action( 'save_post', 'save_genre' );

Together, the code used to create the custom field should look something like this:

Making Custom Fields Available as JSON

Our custom posts are automatically available as JSON. For our “movies” post type, our JSON data can be found at localhost/yoursitename/wp-json/wp/v2/movies .

However our custom fields are not automatically part of this, and so we need to add a function to make sure they are also accessible via the REST API.

First, we’ll need to attach a new function to the rest_api_init hook:

add_action( 'rest_api_init', 'register_genre_as_rest_field' );

Then, we can use the in-built register_rest_field() function, like so:

function register_genre_as_rest_field() { register_rest_field( 'movies', 'genre', array( 'get_callback' => 'get_genre_meta_field', 'update_callback' => null, 'schema' => null, ) );};

This function takes an array with get and update callback. For a more straightforward use-case like this, we should only need to specify a 'get_callback' :

function get_genre_meta_field( $object, $field_name, $value ) { return get_post_meta($object['id'])[$field_name][0];};

As a whole, here is the code necessary to register a custom field.

Making Featured Image URLs Available as JSON

Out-of-the-box, WordPress’s REST API doesn’t include URL for your featured images. To make it easier to access this, you can use the following code:

The WordPress filter rest_prepare_posts is dynamic, so we can swap in our custom post type in place of “posts”, such as rest_prepare_movies .

Restricting Visible JSON Data

We almost ready to start pulling in data to our React app, but there’s one more quick optimisation we can make, by limiting the data that is made available.

Some data comes as standard which you may never need in your frontend and — if that’s the case — we can remove it using a filter, like this one. You can find the names of the data types by looking at your /wp-json/wp/v2/movies part of your website.

With that done, once you’ve added a few movies using the WordPress backend, and we have everything we need to start bringing the data into React!

Part 3: React

To fetch external data in JavaScript, you need to use promises. This will likely have implications for the way you want to structure your React components, and in my case (converting an existing React project), I had to re-write a fair amount of code.

Promises in JavaScript

Promises in JavaScript are used to handle asynchronous actions — things that happen outside the usual step-by-step or “synchronous” order of execution (after hoisting).

The good news is that asynchronous JavaScript is a lot easier than it used to be. Before ES6, we were dependent on callback functions. If multiple callbacks were necessary (and they often were), nesting would lead to code that was very difficult to read, scale and debug — a phenomenon sometimes known as callback hell, or the pyramid of doom!

Promises were introduced in ES6 (or ES2015) to solve that problem, and ES8 (or ES2018) saw the introduction of async ... await , two keywords which further simplify asynchronous functionality. But for our purposes, the most critical promise-based method is fetch() .

The Fetch Method

This method has been available since Chrome 40, and it is an easier-to-use alternative to XMLHttpRequest() .

fetch() returns a promise and so it is “then-able”, meaning that you can use the then() method to process the outcome.

You can add fetch to a method inside your React class component, like so:

fetchPostData() { fetch(`//localhost/yoursitename/wp-json/wp/v2/movies?per_page=100`) .then(response => response.json()) .then(myJSON => { // Logic goes here});}

In the code above, two things are important:

  • First, we are calling a URL with the filter ?per_page=100 appended onto the end. By default, WordPress only shows 10 items per page, and I often find myself wanting to increase that limit.
  • Second, before processing our data, we are using the .json() method. This method is used primarily in relation to fetch(), and it returns the data as a promise and parses the body text as JSON.

In most cases, we’ll want to run this function as soon as our React component has mounted, and we can specify this using the componentDidMount() method:

componentDidMount() { this.fetchPostData();}

Handling Promises

Once you have returned a promise, you have to be careful about handling it in the correct context.

When I first tried to use promises, I spent a while trying to pass that data to variables outside of the scope of the promise. Here are a few rules of thumb:

  • In React, the best way to use promises is via the state. You can use this.setState() to pass promise data into your component’s state.
  • It is best to process, sort and re-arrange your data within a series of then() methods following the initial fetch() . Once any processing is complete, it is best practice to add the data to state within your final then() method.
  • If you want to call any additional functions to process your promise (including within render()) it’s good practice to prevent the function from running until the promise has resolved.
  • So, for example, if you’re passing your promise to this.state.data , you can include a conditional within the body of any functions that depend on it, like below. This can prevent annoying unwanted behaviour!
myPromiseMethod() { if (this.state.data) { // process promise here } else { // what to do before the fetch is successful }}

A Working Example in React

Let’s say we want to pull in the name, description, featured_image and genre of the custom WordPress post type we defined in part 1.

In the following example, we’ll fetch those four elements for each movie and render them.

As so often with React tutorials, the following block of code may look intimidating, but I hope it will seem much simpler when we break it down.

constructor(props)

In this method, we call super(props), define our initial state (an empty data object) and bind three new methods:

  • fetchPostData()
  • renderMovies()
  • populatePageAfterFetch()

componentDidMount()

We want to fetch our data as soon as the component has mounted, so we’ll call fetchPostData() in here.

fetchPostData()

We fetch the JSON from our URL, passing .json() in the first .then() method.

In the second .then() method, we extract the four values we want for every movie entry we’ve fetched and then add them to our newState object.

We then use this.setState(newState) to add this information to this.state.data .

renderMovies()

The conditional if (this.state.data) means that the function will only run once data has been fetched.

In here, we take an array of all our fetched movies from this.state.data and pass it to the function populatePageAfterFetch() .

populatePageAfterFetch()

In this function, we prepare the data for each movie to be rendered. This should look straightforward to anyone who’s used JSX, with one potential stumbling block.

The value of movie.description is not plain text, but HTML markup. To display this, we can use dangerouslySetInnerHTML={{__html: movie.description}} .

Note: The reason this is potentially “dangerous” is that, if your data were hijacked to contain malicious XSS scripts, these would be parsed too. As we’re using our own server/CMS in this article, we shouldn’t need to worry. But if you do want to sanitise your HTML, take a look at DOMPurify.

render()

Finally, we control where our rendered data will appear by calling the renderMovies() method within our chosen iv> tags. We’ve now successfully fetched data from our WordPress site and displayed it!

Conclusion

Overall, I hope this article makes the process of connecting a React front-end to a WordPress back-end as painless as possible.

Like so much in programming, what can look intimidating to begin with quickly becomes second nature with practice!

I’d be very interested to hear about your own experiences using WordPress as a headless CMS, and I’m happy to answer any questions in the comments.