{"id":2255,"date":"2023-06-07T10:00:00","date_gmt":"2023-06-07T15:00:00","guid":{"rendered":"http:\/\/racmanuel.dev\/?p=2255"},"modified":"2023-06-04T16:43:42","modified_gmt":"2023-06-04T21:43:42","slug":"como-crear-un-plugin-para-la-api-rest-de-wordpress-con-operaciones-crud-en-una-tabla-personalizada","status":"publish","type":"post","link":"https:\/\/racmanuel.dev\/en\/como-crear-un-plugin-para-la-api-rest-de-wordpress-con-operaciones-crud-en-una-tabla-personalizada\/","title":{"rendered":"How to create a WordPress REST API plugin with CRUD operations on a custom table"},"content":{"rendered":"\n
\"close
Photo by Christina Morillo on Pexels.com<\/a><\/figcaption><\/figure>\n\n\n\n

Te has puesto a pensar como hay plugins como Jetpack CRM, Yoast SEO, Gravity Forms o otros muchos plugins pueden a\u00f1adir a la REST API de WordPress sus Endpoints a la API nativa de WordPress bueno pues en este en este tutorial revisaremos como crear un plugin para la API REST de WordPress con operaciones CRUD en una tabla personalizada, Aqu\u00ed hay algunos beneficios de crear un plugin en WordPress que agregue un endpoint a la API REST y permita realizar operaciones CRUD en una tabla personalizada:<\/p>\n\n\n\n

    \n
  1. Flexibilidad y personalizaci\u00f3n:<\/span> Al crear un plugin personalizado, tienes el control total sobre las operaciones CRUD en tu tabla personalizada. Puedes definir las rutas, los m\u00e9todos y los par\u00e1metros seg\u00fan tus necesidades espec\u00edficas.<\/li>\n\n\n\n
  2. Integraci\u00f3n con otros sistemas:<\/span> Al utilizar la API REST de WordPress, puedes integrar tu tabla personalizada con otros sistemas y aplicaciones. Esto te permite compartir datos de forma f\u00e1cil y segura con otras plataformas, como aplicaciones m\u00f3viles, sistemas de gesti\u00f3n de contenidos externos, sistemas de comercio electr\u00f3nico y m\u00e1s.<\/li>\n\n\n\n
  3. Automatizaci\u00f3n de tareas:<\/span> Al proporcionar un endpoint de la API REST para tu tabla personalizada, puedes automatizar la creaci\u00f3n, lectura, actualizaci\u00f3n y eliminaci\u00f3n de datos. Esto puede ahorrarte tiempo y esfuerzo al eliminar la necesidad de realizar estas tareas manualmente.<\/li>\n\n\n\n
  4. Acceso a los datos desde cualquier lugar:<\/span> La API REST te permite acceder a tus datos desde cualquier lugar a trav\u00e9s de solicitudes HTTP. Esto significa que puedes realizar operaciones CRUD en tu tabla personalizada desde aplicaciones, servicios web o incluso desde otros sitios web.<\/li>\n\n\n\n
  5. Escalabilidad y modularidad:<\/span> Al utilizar la API REST, tu tabla personalizada se convierte en un recurso independiente que puede ser escalado y utilizado en diferentes contextos. Puedes agregar m\u00e1s endpoints y funcionalidades seg\u00fan sea necesario, lo que te brinda una mayor flexibilidad para adaptarte a futuros cambios y requerimientos.<\/li>\n\n\n\n
  6. Mejora del rendimiento:<\/span> Al utilizar la API REST en lugar de acceder directamente a la base de datos, puedes aprovechar la cach\u00e9 y las optimizaciones de rendimiento integradas en WordPress. Esto puede resultar en una mejor respuesta y tiempos de carga m\u00e1s r\u00e1pidos para tus operaciones CRUD.<\/li>\n\n\n\n
  7. Seguridad y control de acceso:<\/span> Puedes aplicar autenticaci\u00f3n y control de permisos en tus endpoints de la API REST para garantizar que solo los usuarios autorizados puedan acceder y manipular los datos en tu tabla personalizada. Esto te brinda un mayor control sobre la seguridad de tus datos.<\/li>\n<\/ol>\n\n\n\n

    En resumen, al crear un plugin que agregue un endpoint a la API REST de WordPress para manipular datos en una tabla personalizada, obtienes flexibilidad, integraci\u00f3n con otros sistemas, automatizaci\u00f3n de tareas, acceso desde cualquier lugar, escalabilidad, mejor rendimiento, seguridad y control de acceso. Estos beneficios pueden mejorar significativamente la funcionalidad y la eficiencia de tu sitio web o aplicaci\u00f3n basada en WordPress.<\/p>\n\n\n\n

    Paso 1: Preparaci\u00f3n del entorno<\/h2>\n\n\n\n
      \n
    1. Crea una carpeta en la ubicaci\u00f3n wp-content\/plugins<\/code> de tu instalaci\u00f3n de WordPress. Puedes darle el nombre que desees, por ejemplo, “rest-api-clientes”.<\/li>\n\n\n\n
    2. Dentro de la carpeta reci\u00e9n creada, crea un archivo llamado rest-api-clientes.php<\/code>. Este ser\u00e1 el archivo principal de nuestro plugin.<\/li>\n<\/ol>\n\n\n\n

      Paso 2: Creaci\u00f3n de la tabla en la base de datos<\/h2>\n\n\n\n
        \n
      1. Abre el archivo rest-api-clientes.php<\/code> en tu editor de c\u00f3digo y agrega el siguiente c\u00f3digo al principio del archivo:<\/li>\n<\/ol>\n\n\n\n
        <?php\r\n\/*\r\nPlugin Name: REST API Clientes\r\nDescription: Este plugin agrega un endpoint a la API REST de WordPress para manipular datos de la tabla de clientes.\r\nVersion: 1.0\r\nAuthor: Tu Nombre\r\n*\/\r\n\r\n\/\/ Funci\u00f3n para crear la tabla de clientes al activar el plugin\r\nfunction crear_tabla_clientes() {\r\n    global $wpdb;\r\n    $tabla_clientes = $wpdb->prefix . 'clientes';\r\n\r\n    \/\/ Definir la estructura de la tabla\r\n    $sql = \"CREATE TABLE $tabla_clientes (\r\n        id INT NOT NULL AUTO_INCREMENT,\r\n        nombre VARCHAR(255),\r\n        correo_electronico VARCHAR(255),\r\n        telefono VARCHAR(20),\r\n        PRIMARY KEY (id)\r\n    )\";\r\n\r\n    \/\/ Incluir el archivo necesario para ejecutar dbDelta()\r\n    require_once( ABSPATH . 'wp-admin\/includes\/upgrade.php' );\r\n\r\n    \/\/ Crear o modificar la tabla en la base de datos\r\n    dbDelta( $sql );\r\n}\r\n\r\n\/\/ Agregar la acci\u00f3n para crear la tabla de clientes al activar el plugin\r\nregister_activation_hook( __FILE__, 'crear_tabla_clientes' );\r<\/code><\/pre>\n\n\n\n
        Este c\u00f3digo crea la estructura de la tabla clientes<\/code> en la base de datos utilizando la funci\u00f3n dbDelta()<\/code>. La tabla tendr\u00e1 cuatro columnas: id<\/code> (clave primaria autoincremental), nombre<\/code>, correo_electronico<\/code> y telefono<\/code>. La funci\u00f3n crear_tabla_clientes()<\/code> se ejecutar\u00e1 cuando se active el plugin y crear\u00e1 la tabla.<\/p>\n\n\n\n
        Paso 3: Registro del endpoint de la API REST<\/h2>\n\n\n\n
          \n
        1. A continuaci\u00f3n, agregaremos el c\u00f3digo para registrar el endpoint de la API REST y definir las operaciones CRUD. Agrega el siguiente c\u00f3digo despu\u00e9s del bloque de c\u00f3digo anterior:<\/li>\n<\/ol>\n\n\n\n
          \/\/ Funci\u00f3n para obtener un cliente por ID\r\nfunction obtener_cliente( $request ) {\r\n    global $wpdb;\r\n    $tabla_clientes = $wpdb->prefix . 'clientes';\r\n    $id = $request['id'];\r\n\r\n    \/\/ Obtener el cliente de la base de datos\r\n    $cliente = $wpdb->get_row( \"SELECT * FROM $tabla_clientes WHERE id = $id\" );\r\n\r\n    return $cliente;\r\n}\r\n\r\n\/\/ Funci\u00f3n para crear un cliente\r\nfunction crear_cliente( $request ) {\r\n    global $wpdb;\r\n    $tabla_clientes = $wpdb->prefix . 'clientes';\r\n    $cliente = array(\r\n        'nombre' => $request->get_param( 'nombre' ),\r\n        'correo_electronico' => $request->get_param( 'correo_electronico' ),\r\n        'telefono' => $request->get_param( 'telefono' ),\r\n    );\r\n\r\n    \/\/ Insertar el cliente en la base de datos\r\n    $wpdb->insert( $tabla_clientes, $cliente );\r\n\r\n    \/\/ Devolver el ID del nuevo cliente\r\n    return $wpdb->insert_id;\r\n}\r\n\r\n\/\/ Funci\u00f3n para actualizar un cliente por ID\r\nfunction actualizar_cliente( $request ) {\r\n    global $wpdb;\r\n    $tabla_clientes = $wpdb->prefix . 'clientes';\r\n    $id = $request['id'];\r\n    $cliente = array(\r\n        'nombre' => $request->get_param( 'nombre' ),\r\n        'correo_electronico' => $request->get_param( 'correo_electronico' ),\r\n        'telefono' => $request->get_param( 'telefono' ),\r\n    );\r\n\r\n    \/\/ Actualizar el cliente en la base de datos\r\n    $wpdb->update( $tabla_clientes, $cliente, array( 'id' => $id ) );\r\n\r\n    \/\/ Devolver la cantidad de filas afectadas\r\n    return $wpdb->rows_affected;\r\n}\r\n\r\n\/\/ Funci\u00f3n para eliminar un cliente por ID\r\nfunction eliminar_cliente( $request ) {\r\n    global $wpdb;\r\n    $tabla_clientes = $wpdb->prefix . 'clientes';\r\n    $id = $request['id'];\r\n\r\n    \/\/ Eliminar el cliente de la base de datos\r\n    $wpdb->delete( $tabla_clientes, array( 'id' => $id ) );\r\n\r\n    \/\/ Devolver la cantidad de filas afectadas\r\n    return $wpdb->rows_affected;\r\n}\r\n\r\n\/\/ Funci\u00f3n para registrar el endpoint de la API REST\r\nfunction registrar_endpoint_rest_clientes() {\r\n    register_rest_route( 'clientes\/v1', '\/(?P<id>\\d+)', array(\r\n        'methods' => WP_REST_Server::READABLE,\r\n        'callback' => 'obtener_cliente',\r\n        'args' => array(\r\n            'id' => array(\r\n                'validate_callback' => function( $param, $request, $key ) {\r\n                    return is_numeric( $param );\r\n                }\r\n            ),\r\n        ),\r\n    ) );\r\n\r\n    register_rest_route( 'clientes\/v1', '\/', array(\r\n        'methods' => WP_REST_Server::CREATABLE,\r\n        'callback' => 'crear_cliente',\r\n    ) );\r\n\r\n    register_rest_route( 'clientes\/v1', '\/(?P<id>\\d+)', array(\r\n        'methods' => WP_REST_Server::EDITABLE,\r\n        'callback' => 'actualizar_cliente',\r\n        'args' => array(\r\n            'id' => array(\r\n                'validate_callback' => function( $param, $request, $key ) {\r\n                    return is_numeric( $param );\r\n                }\r\n            ),\r\n        ),\r\n    ) );\r\n\r\n    register_rest_route( 'clientes\/v1', '\/(?P<id>\\d+)', array(\r\n        'methods' => WP_REST_Server::DELETABLE,\r\n        'callback' => 'eliminar_cliente',\r\n        'args' => array(\r\n            'id' => array(\r\n                'validate_callback' => function( $param, $request, $key ) {\r\n                    return is_numeric( $param );\r\n                }\r\n            ),\r\n        ),\r\n    ) );\r\n}\r\nadd_action( 'rest_api_init', 'registrar_endpoint_rest_clientes' );<\/code><\/pre>\n\n\n\n
          Este c\u00f3digo define las funciones obtener_cliente()<\/code>, crear_cliente()<\/code>, actualizar_cliente()<\/code> y eliminar_cliente()<\/code>, que corresponden a las operaciones de lectura, creaci\u00f3n, actualizaci\u00f3n y eliminaci\u00f3n respectivamente. Estas funciones utilizan la instancia de la clase wpdb<\/code> para interactuar con la tabla clientes<\/code> en la base de datos.<\/p>\n\n\n\n
          Luego, la funci\u00f3n registrar_endpoint_rest_clientes()<\/code> se encarga de registrar el endpoint de la API REST utilizando register_rest_route()<\/code>. Se definen las rutas y los m\u00e9todos para cada operaci\u00f3n.<\/p>\n\n\n\n
          Paso 4: Prueba de la API REST<\/h2>\n\n\n\n
            \n
          1. Ahora que hemos registrado el endpoint de la API REST, podemos probarlo. Aseg\u00farate de que el plugin est\u00e9 activo en tu instalaci\u00f3n de WordPress.<\/li>\n\n\n\n
          2. Para obtener un cliente por ID<\/span>, puedes hacer una solicitud GET a la siguiente URL en tu navegador: http:\/\/tusitio.com\/wp-json\/clientes\/v1\/1\n
              \n
            • Reemplaza “tusitio.com” con la URL de tu sitio web y “1” con el ID del cliente que deseas obtener. Deber\u00edas recibir los datos del cliente en formato JSON.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
            • Para crear un cliente<\/span>, puedes hacer una solicitud POST a la siguiente URL utilizando una herramienta como Postman: http:\/\/tusitio.com\/wp-json\/clientes\/v1\/\n
                \n
              • Aseg\u00farate de enviar los par\u00e1metros requeridos (nombre<\/code>, correo_electronico<\/code> y telefono<\/code>) en el cuerpo de la solicitud en formato JSON.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
              • Para actualizar un cliente por ID<\/span>, puedes hacer una solicitud PUT a la siguiente URL utilizando una herramienta como Postman: http:\/\/tusitio.com\/wp-json\/clientes\/v1\/1\n
                  \n
                • Reemplaza “tusitio.com” con la URL de tu sitio web y “1” con el ID del cliente que deseas actualizar. Aseg\u00farate de enviar los par\u00e1metros requeridos (nombre<\/code>, correo_electronico<\/code> y telefono<\/code>) en el cuerpo de la solicitud en formato JSON.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                • Para eliminar un cliente por ID<\/span>, puedes hacer una solicitud DELETE a la siguiente URL utilizando una herramienta como Postman: http:\/\/tusitio.com\/wp-json\/clientes\/v1\/1 \n
                    \n
                  • Reemplaza “tusitio.com” con la URL de tu sitio web y “1” con el ID del cliente que deseas eliminar.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n
                    C\u00f3digo Completo<\/h2>\n\n\n\n
                    <?php\r\n\/*\r\nPlugin Name: REST API Clientes\r\nDescription: Este plugin agrega un endpoint a la API REST de WordPress para manipular datos de la tabla de clientes.\r\nVersion: 1.0\r\nAuthor: Tu Nombre\r\n*\/\r\n\r\n\/\/ Funci\u00f3n para crear la tabla de clientes al activar el plugin\r\nfunction crear_tabla_clientes() {\r\n    global $wpdb;\r\n    $tabla_clientes = $wpdb->prefix . 'clientes';\r\n\r\n    \/\/ Definir la estructura de la tabla\r\n    $sql = \"CREATE TABLE $tabla_clientes (\r\n        id INT NOT NULL AUTO_INCREMENT,\r\n        nombre VARCHAR(255),\r\n        correo_electronico VARCHAR(255),\r\n        telefono VARCHAR(20),\r\n        PRIMARY KEY (id)\r\n    )\";\r\n\r\n    \/\/ Incluir el archivo necesario para ejecutar dbDelta()\r\n    require_once( ABSPATH . 'wp-admin\/includes\/upgrade.php' );\r\n\r\n    \/\/ Crear o modificar la tabla en la base de datos\r\n    dbDelta( $sql );\r\n}\r\n\r\n\/\/ Agregar la acci\u00f3n para crear la tabla de clientes al activar el plugin\r\nregister_activation_hook( __FILE__, 'crear_tabla_clientes' );\r\n\r\n\r\n\/\/ Funci\u00f3n para obtener un cliente por ID\r\nfunction obtener_cliente( $request ) {\r\n    global $wpdb;\r\n    $tabla_clientes = $wpdb->prefix . 'clientes';\r\n    $id = $request['id'];\r\n\r\n    \/\/ Obtener el cliente de la base de datos\r\n    $cliente = $wpdb->get_row( \"SELECT * FROM $tabla_clientes WHERE id = $id\" );\r\n\r\n    return $cliente;\r\n}\r\n\r\n\/\/ Funci\u00f3n para crear un cliente\r\nfunction crear_cliente( $request ) {\r\n    global $wpdb;\r\n    $tabla_clientes = $wpdb->prefix . 'clientes';\r\n    $cliente = array(\r\n        'nombre' => $request->get_param( 'nombre' ),\r\n        'correo_electronico' => $request->get_param( 'correo_electronico' ),\r\n        'telefono' => $request->get_param( 'telefono' ),\r\n    );\r\n\r\n    \/\/ Insertar el cliente en la base de datos\r\n    $wpdb->insert( $tabla_clientes, $cliente );\r\n\r\n    \/\/ Devolver el ID del nuevo cliente\r\n    return $wpdb->insert_id;\r\n}\r\n\r\n\/\/ Funci\u00f3n para actualizar un cliente por ID\r\nfunction actualizar_cliente( $request ) {\r\n    global $wpdb;\r\n    $tabla_clientes = $wpdb->prefix . 'clientes';\r\n    $id = $request['id'];\r\n    $cliente = array(\r\n        'nombre' => $request->get_param( 'nombre' ),\r\n        'correo_electronico' => $request->get_param( 'correo_electronico' ),\r\n        'telefono' => $request->get_param( 'telefono' ),\r\n    );\r\n\r\n    \/\/ Actualizar el cliente en la base de datos\r\n    $wpdb->update( $tabla_clientes, $cliente, array( 'id' => $id ) );\r\n\r\n    \/\/ Devolver la cantidad de filas afectadas\r\n    return $wpdb->rows_affected;\r\n}\r\n\r\n\/\/ Funci\u00f3n para eliminar un cliente por ID\r\nfunction eliminar_cliente( $request ) {\r\n    global $wpdb;\r\n    $tabla_clientes = $wpdb->prefix . 'clientes';\r\n    $id = $request['id'];\r\n\r\n    \/\/ Eliminar el cliente de la base de datos\r\n    $wpdb->delete( $tabla_clientes, array( 'id' => $id ) );\r\n\r\n    \/\/ Devolver la cantidad de filas afectadas\r\n    return $wpdb->rows_affected;\r\n}\r\n\r\n\/\/ Funci\u00f3n para registrar el endpoint de la API REST\r\nfunction registrar_endpoint_rest_clientes() {\r\n    register_rest_route( 'clientes\/v1', '\/(?P<id>\\d+)', array(\r\n        'methods' => WP_REST_Server::READABLE,\r\n        'callback' => 'obtener_cliente',\r\n        'args' => array(\r\n            'id' => array(\r\n                'validate_callback' => function( $param, $request, $key ) {\r\n                    return is_numeric( $param );\r\n                }\r\n            ),\r\n        ),\r\n    ) );\r\n\r\n    register_rest_route( 'clientes\/v1', '\/', array(\r\n        'methods' => WP_REST_Server::CREATABLE,\r\n        'callback' => 'crear_cliente',\r\n    ) );\r\n\r\n    register_rest_route( 'clientes\/v1', '\/(?P<id>\\d+)', array(\r\n        'methods' => WP_REST_Server::EDITABLE,\r\n        'callback' => 'actualizar_cliente',\r\n        'args' => array(\r\n            'id' => array(\r\n                'validate_callback' => function( $param, $request, $key ) {\r\n                    return is_numeric( $param );\r\n                }\r\n            ),\r\n        ),\r\n    ) );\r\n\r\n    register_rest_route( 'clientes\/v1', '\/(?P<id>\\d+)', array(\r\n        'methods' => WP_REST_Server::DELETABLE,\r\n        'callback' => 'eliminar_cliente',\r\n        'args' => array(\r\n            'id' => array(\r\n                'validate_callback' => function( $param, $request, $key ) {\r\n                    return is_numeric( $param );\r\n                }\r\n            ),\r\n        ),\r\n    ) );\r\n}\r\nadd_action( 'rest_api_init', 'registrar_endpoint_rest_clientes' );\r<\/code><\/pre>\n\n\n\n
                    Conclusion<\/h2>\n\n\n\n
                    \u00a1Felicitaciones! Ahora tienes un plugin que agrega un endpoint a la API REST de WordPress para realizar operaciones CRUD en una tabla personalizada. Puedes personalizar y ampliar este plugin seg\u00fan tus necesidades.<\/p>\n\n\n\n
                    Recuerda que es importante tener precauci\u00f3n al trabajar con la API REST y asegurarte de proteger tus endpoints de manera adecuada, utilizando autenticaci\u00f3n y control de permisos seg\u00fan sea necesario.<\/p>\n\n\n\n
                    Espero que este tutorial te haya sido \u00fatil y te haya brindado una comprensi\u00f3n clara de c\u00f3mo crear un plugin para la API REST de WordPress con operaciones CRUD en una tabla personalizada.<\/p>\n\n\n