PHP programmers can use the WP Data Access API to create CRUD pages in minutes or access remote databases from their WordPress pages (or a combination of them 😉). There is no online API documentation, but it is very easy to generate your own copy.
Generate API documentation #
We recommend to store a local copy of the plugin in a separate folder to generate the API documentation and install GraphViz which is required to perform the documentation generation process.
- Start the command line interface
- Navigate to root folder containing the local copy of the plugin
- Enter the following commands:
- composer require phpdocumentor/phpdocumentor
- php vendor/phpdocumentor/phpdocumentor/bin/phpdoc.php
- Navigate to subfolder docs
- Open file index.html in your favourite browser
Delete API documentation #
- Start the command line interface
- Navigate to root folder containing the local copy of the plugin
- Enter the following command:
- composer remove phpdocumentor/phpdocumentor
- Delete subfolder docs