Cómo crear una aplicación web moderna usando WordPress y React

Programación

Combine el poder de un front-end de React con el CMS más popular de Internet

¿Quiere las ventajas de un React SPA moderno, pero necesita un back-end que le resulte familiar? En este artículo, veremos cómo configurar la API REST de WordPress, incluidos los tipos y campos de publicaciones personalizadas, y cómo obtener estos datos dentro de React.

Recientemente, estaba trabajando en una aplicación React para un cliente cuando me hicieron esta pregunta: '¿Podemos usarla con WordPress ? '

Desde finales de 2015, la respuesta a esta pregunta ha sido afirmativa. Pero los pasos necesarios para crear un sitio desacoplado que funcione pueden no parecer sencillos, especialmente para aquellos que no están familiarizados con WordPress y React.

En mi viaje para crear una aplicación funcional, encontré un puñado de obstáculos complicados y en este artículo explicaré cómo evitarlos. ¡También compartiré varios consejos y trucos que aprendí en el camino!

Contenido

Parte 1: Información general

  • ¿Qué es un CMS sin cabeza?
  • ¿Qué debo saber para seguir adelante?
  • Siglas clave
  • ¿Dónde puedo ver los datos JSON de WordPress?

Parte 2: WordPress

  • Agregar un tipo de publicación personalizada
  • Cambiar el texto del marcador de posición del título
  • Agregar un campo personalizado a su tipo de publicación personalizada
  • Hacer que los campos personalizados estén disponibles como JSON
  • Restricción de datos JSON visibles

Parte 3: Reaccionar

  • Promesas en JavaScript
  • El método de búsqueda
  • Manejo de promesas

Un ejemplo práctico en React

Conclusión

Parte 1: Información general

¿Qué es un CMS sin cabeza?

En el pasado, usar un CMS como WordPress significaba que tenía que construir su interfaz usando PHP.

Ahora, con un CMS sin cabeza, puede construir su interfaz con las tecnologías que desee; esto se debe a la separación del front-end y el back-end a través de una API. Si desea crear un SPA (aplicación de una sola página) usando React, Angular o Vue, y controlar el contenido usando un CMS como WordPress, ¡puede hacerlo!

¿Qué debo saber para seguir adelante?

Aprovecharás al máximo este artículo si tienes:

  • algún conocimiento de cómo funciona un CMS como WordPress, un poco de PHP y una idea sobre cómo configurar un proyecto básico de WordPress en su computadora;
  • una comprensión de JavaScript, incluidas las características del lenguaje ES6 + y la sintaxis de la clase React.

Siglas clave

La programación está llena de jerga, pero hace que sea mucho más rápido discutir algunos de los conceptos de este artículo. Aquí hay un resumen rápido de los términos que usaremos:

  • CMS - sistema de gestión de contenido. Piense en WordPress, Drupal, Joomla, Magneto.
  • SPA: aplicación de una sola página. En lugar de volver a cargar cada página en su totalidad, una aplicación de SPA carga contenido de forma dinámica. El código fundamental (HTML, CSS y JavaScript) del sitio web se carga una sola vez. Piensa en React, Vue, Angular.
  • API: interfaz de programación de aplicaciones. En términos simples, una serie de definiciones que proporciona un servicio para permitirle tomar y usar sus datos. Google Maps tiene uno. Medium tiene uno. Y ahora, cada sitio de WordPress viene con una API incorporada.
  • REST - transferencia de estado representacional. Un estilo de arquitectura de la web basa en métodos de petición de HTTP: GET, PUT, POSTy DELETE. La API incorporada de WordPress es una API REST o "RESTful".
  • HTTP: protocolo de transferencia de hipertexto. El conjunto de reglas que se utilizan para transferir datos a través de la web. Se especifica al principio de las URL como httpo https(la versión segura).
  • JSON: notación de objetos JavaScript. Aunque se deriva de JavaScript, este es un formato independiente del idioma para el almacenamiento y la transferencia de datos.

En este artículo, usamos WordPress como nuestro CMS. Eso significa programar nuestro back-end en PHP y usar la API REST de WordPress para entregar datos JSON a nuestro frontend.

¿Dónde puedo ver los datos JSON de WordPress?

Antes de llegar a lo bueno, una nota rápida sobre dónde puede encontrar los datos JSON en su sitio de WordPress. Hoy en día, todos los sitios web de WordPress tienen datos JSON disponibles (a menos que el propietario del sitio haya desactivado o restringido el acceso). Echa un vistazo al JSON principal de un sitio de WordPress añadiéndolo /wp-jsonal nombre de dominio raíz.

Entonces, por ejemplo, puede echar un vistazo al JSON para WordPress.org visitando //wordpress.org/wp-json. O, si está ejecutando un sitio de WordPress localmente, puede ver su JSON siguiendo localhost/yoursitename/wp-json.

Para acceder a los datos de sus publicaciones, escriba localhost/yoursitename/wp-json/wp/v2/posts. Para un formato de publicación personalizado, cambie el nuevo formato (por ejemplo movies) en lugar de posts. ¡Lo que ahora parece un bloque de texto ilegible es exactamente lo que nos permitirá usar WordPress como un CMS sin cabeza!

Parte 2: WordPress

Para configurar su API REST, la mayor parte de lo que deberá hacer sucederá en su functions.phparchivo. Asumiré que sabe cómo configurar un proyecto de WordPress y acceder a él usando localhost, pero si desea ayuda con eso, le recomiendo este artículo (es lo que solía comenzar a programar con WordPress).

Para la mayoría de los proyectos, querrá usar un tipo de publicación personalizada, así que comencemos por configurar una.

Agregar un tipo de publicación personalizada

Digamos que nuestro sitio trata sobre películas y queremos un tipo de publicación llamada "películas". Primero, queremos asegurarnos de que nuestro tipo de publicación de 'películas' se cargue lo antes posible, así que lo adjuntaremos al initgancho, usando add_action:

add_action( 'init', 'movies_post_type' );

Estoy usando movies_post_type(), pero puedes llamar a tu función como quieras.

A continuación, queremos registrar 'películas' como un tipo de publicación, usando la register_post_type()función.

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

Original text

Contribute a better translation

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.