rmp-up/wp-fixtures

Expressive fixtures persistence in WordPress (and some plugins)

0.9.0-rc.1 2021-04-15 11:47 UTC

Requires

• php: ~7.0|8.0.*
• nelmio/alice: ~3

Requires (Dev)

• bamarni/composer-bin-plugin: 1.4.*
• johnpbloch/wordpress: >=4.7.0
• squizlabs/php_codesniffer: ~3
• wpackagist-plugin/woocommerce: 3.*
• wpackagist-plugin/yith-woocommerce-product-bundles: 1.1.*

Suggests

• wp-cli/wp-cli: Allows using 'wp fixture' on CLI

Conflicts

• johnpbloch/wordpress: <4.5.0
• symfony/property-access: ~5

proprietary

• rmp up

• faker
• data
• test
• Fixture
• wordpress

README

WordPress Fixture Generator

Expressive fixtures persistence in WordPress (and some plugins).

GDPR and fluent data is a PITA while developing solutions to specific problems for your customers. Faker and Alice is already there for Symfony, Nette, Zend and now for WordPress to ...

• ... create data using wp-cli or plain PHP.
• ... generate tons of pages, posts, comments, products and more with just a few YAML-lines
• ... seed WordPress with specific use-cases for testing

Overall the goal is simplicity and no time wasting crap (for me and you) which we achieve by using raw WordPress structures in the YAML instead of reinventing the wheel.

By now we bring helper for:

• WordPress 4.6 - 5.4, e.g. posts, pages, user, options etc.

See below how a small Yaml-File can seed the database with tons of entries or read the documentation to find out more about entities and possibilities.

Install

Download or just

composer install --dev rmp-up/wp-fixtures

We mostly require what Alice also needs (see Packagist.org for more details):

• PHP
• WordPress

Optional:

• wp-cli 2, which eats YAML and seeds the DB for you

Tests expand continuously to cover a bigger range one day (see Travis CI).

Usage

Lets define one simple page, multiple posts by random users and plenty of comments within one yaml:

WP_Post:
  page_1:
    # Well known wp_insert_post() structure
    post_type: page
    post_title: Imprint
    post_content: |
      Beth Doe
      Meestreet 42
      1337 Muskegon
    meta_input:
      simple: 1
      flat: # will append like add_post_meta
      - penny
      - claire
      - emily
      - lucy
      complex: # will be serialized
        company: True TV
        best: Ellen


  # or with abbreviated field-names
  post_{1..10}:
    author: '<wpUser()>'
    title: '<sentence()>'
    content: '<realText()>'
      

WP_Comment:
  # 100 comments randomly spread among posts
  comment_{2..102}:
    post_ID: '@post_<numberBetween(1,10)>'
    content: '<realText()>'

Other possible entities:

• Options
• WP_Comment
• WP_Post
• WP_Role
• WP_Site
• WP_Term
• WP_User

License

Copyright 2019 Mike Pretzlaw (mike-pretzlaw.de)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.