Download the PHP package humanmade/rest-api-search-by-id without Composer
On this page you can find all versions of the php package humanmade/rest-api-search-by-id. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download humanmade/rest-api-search-by-id
More information about humanmade/rest-api-search-by-id
Files in humanmade/rest-api-search-by-id
Package rest-api-search-by-id
Short Description WordPress plugin to support the include & exclude parameters on the REST API /search endpoint.
License GPL-2.0+
Homepage https://github.com/humanmade/rest-api-search-by-id
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package rest-api-search-by-id
REST API Search by ID
This plugin modifies the WordPress REST API /wp/v2/search endpoint to support the include and exclude query parameters used in other collections.
In the default REST API you must know the post type for a resource in order to be able to query it, because API routes are broken out by resource type. However, in WordPress we have many functions which accept only an ID and return a matching post regardless of type. With this plugin active it is possible to query for a specific post object by ID, even if you do not know that record's post type:
useResourceById Hook
In addition to the API query parameter changes described above, when this plugin is active there is also a script with the handle use-resource-by-id enqueued while you are using the Block Editor. This script declares a React hook which wraps the WordPress Block Editor's own getEntityRecord selector to let you request a post resource without knowing its post type.
Usage:
This hook uses the search endpoint with the include parameter to determine the subtype of the requested record. That subtype is cached in memory once known, and the hook will thereafter return the results of a direct getEntityRecord call so that the resource is properly routed through the Block Editor data store.
Installation
Add this to your site with Composer by running,
The package specifies that this is a WordPress plugin, so depending on how you have your Composer installers configured, this should automatically end up in your plugins directory. You can of course also manually download a zipfile of a release and load it into your site by other means.
Caveats
At present include and exclude as implemented in this plugin assume you are querying only for post objects. Support may be added later to permit searching across object types.
Release Process
To release a new version,
- bump the version numbers in
package.jsonandplugin.php(both the plugin header and the version parameter in thewp_enqueue_scriptcall) - generate the minified file with
npm run build - commit the built code
- tag with the desired version number
For example,
License
GPL v2 or later
