wp-avorg

Installation

Development

0. git clone https://github.com/AVORG/wp-avorg-dev.git
1. Follow wp-avorg-dev readme instructions
2. Optional: Update dependencies: cd wp-avorg-dev/wp-avorg-plugin && composer install

If you edit the Composer auto-load rules, you'll need to run composer dump-autoload to make them go into effect.

Run composer update narthur/natlib to update Composer's commit reference to the natlib dependency. CircleCI will do this while running tests, but the updated reference won't be persisted back to the repository.

CircleCI automatically deploys dev branch builds to http://dev.audioverse.org/

Production

0. Open CircleCI and select the latest build
1. Select the "Artifacts" tab
2. Drill down until you see a file named wp-avorg-plugin.zip and click it to download
3. In the WordPress admin panel, navigate to "Plugins > Add New" and click the "Upload Plugin" button
4. Upload the zip file you downloaded
5. Activate the plugin

PHP 7.2

On MacOS install using these scripts, then add /usr/local/php5/bin to your path.

Routes

Routes are defined and documented in the routes.csv file.

API

Endpoint	Description
/wp-json/avorg/v1/placeholder-ids	Retrieve placeholder identifiers
/wp-json/avorg/v1/placeholder-content/{id}	Retrieve placeholder content

Data Object Endpoints

All the following endpoints should support search and start GET query parameters for search and pagination functionality.

Endpoint	Description
/wp-json/avorg/v1/books
/wp-json/avorg/v1/conferences
/wp-json/avorg/v1/playlists
/wp-json/avorg/v1/presenters
/wp-json/avorg/v1/series
/wp-json/avorg/v1/sponsors
/wp-json/avorg/v1/stories
/wp-json/avorg/v1/topics
/wp-json/avorg/v1/user/playlists
/wp-json/avorg/v1/suggestions

Testing

composer test

Working With Translation Files

Install gettext on your mac:

brew install gettext
brew link --force gettext

Convert a PO language file to an MO language file:

msgfmt -o wp-avorg-plugin-es_ES.mo wp-avorg-plugin-es_ES.po

File names:

• {textdomain}-{languagecode}.po
• {textdomain}-{languagecode}.mo

Pluralized translations should appear in a language's .po file in the following format:

msgid "%1$d day ago"
msgid_plural "%1$d days ago"
msgstr[0] "Hace %1$d días"
msgstr[1] "Hace %1$d días"

More information on plugin localization:

• Everything You Need to Know About Translating WordPress Plugins