README

使用 YAML 语法快速配置 WordPress

要求

• PHP >= 7.2
• WordPress >= 5.0

安装

推荐通过 Composer 安装 wordpress-yaml。

$ composer require veronq/wordpress-yaml

使用

查看 示例 文件夹以获取完整使用演示。

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]);

注册两个新菜单。

menu.yaml

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

添加两个新自定义图片尺寸。

size.yaml

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

API

Config::EditorColor($filename)

$filename (必需)

类型: string|array

用于定义新颜色调的文件（夹）路径。

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

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

Config::Menu($filename)

$filename (必需)

类型: string|array

用于定义新菜单的文件（夹）路径。

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

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

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

$filename (必需)

类型: string|array

用于定义新文章类型的文件（夹）路径。

$defaultArgs

类型: array
默认: []

为每个新文章类型使用的默认参数。

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 (必需)

类型: string|array

用于定义新侧边的文件（夹）路径。

$defaultArgs

类型: array
默认: []

为每个新侧边使用的默认参数。

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

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

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

$filename (必需)

类型: string|array

用于定义新图片尺寸的文件（夹）路径。

$defaultArgs

类型: array
默认: []

为每个新图片尺寸使用的默认参数。

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

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

许可协议

Wordpress YAML 库是开源软件，许可证为 MIT 许可证。