Easily interact with the Wordpress REST API. Get support for most common endpoints & CRUD operations.
- 🔄 Request Synchronization.
- 📦 API discovery support.
- ⏲️ Measures request completion time.
- 📝 Supports all CRUD operations.
- 🌐 Supports all common endpoints.
- 🎨 Custom Requests & Authorization systems.
- 🔐 3 Popular authorization methods.
- 🎣 Events for preprocessing response operations.
Add wordpress_client in your pubspec.yaml:
dependencies:
wordpress_client: ^8.3.7💡 Ensure you get the latest version here.
Import the package where you need:
import 'package:wordpress_client/wordpress_client.dart';You can initialize WordpressClient in two methods:
- Default (Simple Method)
- Advanced (with Bootstrapper for additional configurations)
Simple Method:
final baseUrl = Uri.parse('https://example.com/wp-json/wp/v2');
final client = WordpressClient(baseUrl: baseUrl);
client.initialize();📘 Learn more about the Advanced Method here.
Example to retrieve 20 recent WordPress posts in ascending order:
final request = ListPostRequest(
page: 1,
perPage: 20,
order = Order.asc,
);
final wpResponse = await client.posts.list(request);
// Dart 3 style
switch (wpResponse) {
case WordpressSuccessResponse():
final data = wpResponse.data; // List<Post>
break;
case WordpressFailureResponse():
final error = wpResponse.error; // WordpressError
break;
}
// or
// wordpress_client style
final result = postsResponse.map(
onSuccess: (response) {
print(response.message);
return response.data;
},
onFailure: (response) {
print(response.error.toString());
return <Post>[];
},
);Refer to the documentation for more request examples.
By the WordPress Team, this method uses basic HTTP authentication where credentials are passed with every request. Details
Developed by Enrique Chavez, it involves JSON Web Token (JWT) authentication where a token is issued and then used in subsequent requests. Details
By Useful Team, this is another implementation using JWT for authentication purposes. Details
For custom authorization, check the Authorization Wiki.
| Endpoint | Create | Read | Update | Delete |
|---|---|---|---|---|
| Posts | ✅ | ✅ | ✅ | ✅ |
| Comments | ✅ | ✅ | ✅ | ✅ |
| Categories | ✅ | ✅ | ✅ | ✅ |
| Tags | ✅ | ✅ | ✅ | ✅ |
| Users | ✅ | ✅ | ✅ | ✅ |
| Me | ✅ | ✅ | ✅ | ✅ |
| Media | ✅ | ✅ | ✅ | ✅ |
| Pages | ✅ | ✅ | ✅ | ✅ |
| Application Passwords | ✅ | ✅ | ✅ | ✅ |
| Search | - | ✅ | - | - |
| Post Revisions | ❌ | ❌ | ❌ | ❌ |
| Taxonomies | ❌ | ❌ | ❌ | ❌ |
| Post Types | ❌ | ❌ | ❌ | ❌ |
| Post Statuses | ❌ | ❌ | ❌ | ❌ |
| Settings | ❌ | ❌ | ❌ | ❌ |
Learn how to implement Custom Requests here.
- 🐛 For bugs or feature requests, use the issue tracker.
- 💡 Contributions are always appreciated. PRs are welcome!
Licensed under MIT.
Support Me:
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent