Brickset API

Brickset API

from 0$

Brickset API is a Package Installer from the Open Source WP Plugins range Display your favorite LEGO® set information on your website using the Brickset API.

For more information about a tailored Package Installer like Brickset API please contact us directly.

This plugin is an implementation of the Brickset Webservice. It includes methods to get LEGO® set and theme data from Brickset as well as pre-formated methods to display set data. The set data requested is cached daily to reduce HTTP requests and page load time. Please visit Brickset for more information on the webservice. You can obtain an API key from Brickset.

The main development is all happening on GitHub.

This is not an official Brickset.com plugin. LEGO® is a trademark of the LEGO Group of companies which does not sponsor, authorize or endorse this plugin.

Oembed

You can paste a Brickset set or theme url into your post or page. Once you publish the post or page information about the set or theme will be displayed. Two example URLs are below.

  • Set URL: http://brickset.com/detail/?Set=79003-1
  • Theme URL: http://brickset.com/browse/themes/?theme=The%20Hobbit

Template Tags

The plugin has numerous template tags you are able to use in your theme. They are listed below with a short description.

  • brickset_themes(); outputs a list of all themes.
  • brickset_subthemes( $theme ); outputs a table of all subthemes of the theme specified, the number of sets, and years available.
  • brickset_theme_years( $theme ); outputs a table of all the years the specified theme was available and the number of sets each year.
  • brickset_popular_searches(); outputs a list of the most popular search terms on Brickset.com.
  • brickset_updated_since( $date ); outputs a table of the sets updated since the date specified. The table includes thumbnail, set name and set number.
  • brickset_set_number( $set ); outputs a list of details about the sets specified. More than one set can be requested by separating the set numbers with a comma, e.g. ‘1380,10240’.

Shortcode

The plugin has a shortcode you may use in your posts and pages to display information about a set or sets.

  • [bs_set number='XXX'] outputs information about a specific set. Thumbnail, set name, set number, pieces, theme, subtheme and year. You can display multiple sets by seperating the set numbers with a comma.

Widgets

The plugin has four widgets you can activate in your theme. The first displays a list of all themes on Brickset with a link to browse each theme on Brickset.com and the second to display the details about a specific set. The third allows you to show off the total count of your minifigs. The last widget displays a count of sets produced in each year for a given theme.

Advanced Use

This example shows how to get the data about a specific set. You can find the developer docs here.

  1. Instantiate the class.

    $brickset = new BricksetAPISearch();

  2. Pass a set number to the get_by_number method.

    $set_data = $brickset->get_by_number( ‘8014’ );

  3. Test for an error

    if( is_wp_error( $set_data ) {
    echo $set_data->get_error_message;
    }

  4. Display the results how you like. This will display the set’s theme.

    else {
    echo $set_data->theme;
    }

Road Map

  1. Template tags to display sets specific to a user.
  2. Caching of images

You can follow all the open feature requests and enhancements on GitHub.

Download & install the zip archive

The plugin package installer can be downloaded from the WP2E project tab called “code”.

1 – Select the version to download if this option is available otherwise the “latest” version of the main plugin will be used.

2 – After downloading the zip archive install the plugin package installer in you local environment and activate the script from the plugin list.

3 – Under the section “Plugins” of the admin dashboard you should see a new “Dependencies & Licenses” link. Follow the instructions from this panel to finalize the installation of the missing dependencies.

Tips: Use the WP2E panel to add/suggest new dependencies to the local installation. Press F5 in the list of dependencies if the changes are not displayed right away.

Brickset API

typePlugin
versionlatest
descriptionDisplay your favorite LEGO® set information on your website using the Brickset API.