veronq/wordpress-yaml

This package is abandoned and no longer maintained. No replacement package was suggested.

Fast WordPress configuration using YAML Syntax

1.0.6 2022-02-11 11:48 UTC

Requires

• php: >=7.2
• symfony/yaml: ^5.1

MIT

• veronQ

• symfony
• yaml
• wordpress

README

Fast WordPress configuration using YAML Syntax

Requirements

• PHP >= 7.2
• WordPress >= 5.0

Installation

The recommended way to install wordpress-yaml is through Composer.

$ composer require veronq/wordpress-yaml

Usage

See example folder for a complete usage demo.

functions.php

use veronq\wordpressYAML\Config;

// Path of YAML file.
Config::menu(__DIR__.'/menu.yaml');

// Accept default config as second parameter.
Config::size(__DIR__.'/size.yaml', ['crop' => true]);

Register two new menus.

menu.yaml

header_menu: "Menu 1"
footer_menu: "Menu 2"

Add two new custom image sizes.

size.yaml

-
  name: "580x720"
  width: 580
  height: 720
  crop: false
-
  name: "720x360"
  width: 720
  height: 360

API

Config::EditorColor($filename)

$filename (required)

Type: string|array

Path of file(s) to be used for defining new color palette.

Config::editorColor('editor-color.yaml');

-
  slug: "success"
  name: "Success"
  color: "#48bb78"
-
  slug: "error"
  name: "Error"
  color: "#f56565"

Config::Menu($filename)

$filename (required)

Type: string|array

Path of file(s) to be used for defining new menus.

Config::Menu('menu.yaml');

header_menu: "Menu 1"
footer_menu: "Menu 2"

Config::PostType($filename, ?$defaultArgs)

$filename (required)

Type: string|array

Path of file(s) to be used for defining new post types.

$defaultArgs

Type: array
Default: []

Default arguments to be used for every new post type.

Config::PostType('post-type.yaml',
[
  'taxonomies' =>
    'category',
    'post_tag',
  ]
);

event:
  labels:
    name: "Event"
  public: true
  show_in_rest: true
  supports:
    - "title"
    - "thumbnail"
    - "editor"
    - "excerpt"

Config::Sidebar($filename, ?$defaultArgs)

$filename (required)

Type: string|array

Path of file(s) to be used for defining new sidebars.

$defaultArgs

Type: array
Default: []

Default arguments to be used for every new sidebar.

Config::Sidebar('sidebar.yaml');

-
  id: "sidebar-default"
  name: "Default Sidebar"
-
  id: "sidebar-blog"
  name: "Sidebar for blogging"

Config::Size($filename, ?$defaultArgs)

$filename (required)

Type: string|array

Path of file(s) to be used for defining new image sizes.

$defaultArgs

Type: array
Default: []

Default arguments to be used for every new image size.

Config::Sidebar('sidebar.yaml');

-
  name: "580x720"
  width: 580
  height: 720
  crop: false

License

The Wordpress YAML library is open-sourced software licensed under the MIT License.