wordpress_api 0.1.3+1

  • Readme
  • Changelog
  • Example
  • Installing
  • 84

WordPress API client for Dart (Flutter) #

Description #

A WordPress API client for dart with support for WooCommerce and custom namespaces.

Features #

  • Retrieve data from standard WordPress endpoints.
  • Retrieve data from any custom endpoint and namespace

Installation #

In the dependencies: section of your pubspec.yaml, add the following line:

wordpress_api: <latest_version>

Usage #

  • Import the package
import 'package:wordpress_api/wordpress_api';
  • Initialize WPAPI
  WordPressAPI api = WordPressAPI('site.com');
  • Retrieve data from a custom endpoint
  void main() async {
    final wp = WordPressAPI('260blog.com');
    final posts = (await wp.getAsync('posts'))['data'];
    for (final post in posts) {
      print(post['title']['rendered']);
    }
  }
  • Retrieve WP users
  void main() async {
    final wp = WordPressAPI('260blog.com');
    final users = (await wp.getUsers())['data'];
    for (final user in users) {
      print(user['name']);
    }
  }

To Do #

  • Add authentication function
  • Add postAsync function

Contributions are welcome, report any issues here

[0.1.3+1] #

  • Fixed issue when retireving single post in issue #4

[0.1.3] #

  • Removed all flutter references because the package also works standalone for dart. Thanks jld3103
  • Added Wordpress Standard endpoints as requested in issue #3. These include getPosts(), getCategories(), getTags(), getComments(), and getUsers() functions.

[0.1.2+3] #

  • Minor fixes

[0.1.2+2] #

  • Added endpoint query handler

[0.1.2+1] #

  • Added getAsyc exception

[0.1.2] #

  • Fixed the error in JSON endpoint retrieval

[0.1.1+2] #

  • Changed getAsync return raw json body
  • Changed example code url

[0.1.1+1] #

  • Changed getAsync return data to a map.

[0.1.1] #

  • Updated example and readme

[0.1.0] #

  • Added an example

[0.0.2] #

  • Updated documentation

[0.0.1] #

  • Initial release.

example/lib/main.dart

import 'package:wordpress_api/wordpress_api.dart';

void main() async {
  final wp = WordPressAPI('260blog.com');
  final posts = (await wp.getAsync('posts'))['data'];
  for (final post in posts) {
    print(post['title']['rendered']);
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  wordpress_api: ^0.1.3+1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:wordpress_api/wordpress_api.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
68
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
84
Learn more about scoring.

We analyzed this package on Mar 31, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6

Health suggestions

Fix lib/wordpress_api.dart. (-1 points)

Analysis of lib/wordpress_api.dart reported 2 hints:

line 103 col 11: Don't explicitly initialize variables to null.

line 104 col 11: Don't explicitly initialize variables to null.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
http ^0.12.0+4 0.12.0+4
Transitive dependencies
async 2.4.1
charcode 1.1.3
collection 1.14.12
http_parser 3.1.4
meta 1.1.8
path 1.6.4
pedantic 1.9.0
source_span 1.7.0
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6