README

下载插件。

要下载一个无需编译或获取依赖项的完整即用型插件，请访问以下链接。
前往 这里 并从最新版本下载 full-release.zip。

入门指南

要开始，您需要安装所需的 npm 包。为了安装这些组件，您需要在您的系统上安装 Node.js。

$ cd [THEME-DIR]
$ npm install
$ composer install

依赖关系

Municipio 需要 ACF PRO。

编码标准

对于 PHP，使用 PSR-2 和 PSR-4（如有适用）。

Gulp

您可以使用 Gulp 编译、连接和压缩 SASS 和 JavaScript。SASS 的编译还会自动在需要的地方添加供应商前缀。

要从主题目录运行以下命令以编译 js 和 sass 并启动 "watch" 任务：

$ gulp

我们添加了对 webpack 的支持

Webpack 比 Gulp 快一点。所以如果您想使用 webpack 而不是 Gulp，只需运行以下命令：

$ npm run watch

或者只是进行单个构建

$ npm run build

Composer

您可以使用 composer 安装依赖项。

$ composer install

常量

块作者页面

作者页面默认是被屏蔽的。要 "取消屏蔽"，请将以下常量添加到 wp-config（或其他合适的位置）。

define('MUNICIPIO_BLOCK_AUTHOR_PAGES', false);

从不同的主机加载样式指南

用于设置样式指南基本 URI 的常量。对于第三方网站很有用。

define('MUNICIPIO_STYLEGUIDE_URI', '//example.com/style/guide');

加载特定版本的样式指南

锁定样式指南版本的常量。当您希望确保网站的稳定性时，这很有用。

define('STYLEGUIDE_VERSION', 1.0.32);

加载特定开发版本的样式指南

加载样式指南本地版本的常量。

define('DEV_MODE', true);

BEMIT 风格的主题 CSS 类名

包含当前主题名称的 BEM 格式常量。当您想直接将组件样式连接到主题时可以使用。您不能更改此。

MUNICIPIO_BEM_THEME_NAME

动作

Municipio/blog/post_info

博客帖子信息标题（单个）

• @param object $post - 帖子对象

do_action('Municipio/author_display/name', $post);

Municipio/share_post/recipients

在通过电子邮件分享帖子时执行操作，例如发送通知

• @param object $user - 发件人的用户对象
• @param array $recipients - 电子邮件地址列表

do_action('Municipio/share_post/recipients', $user, $recipients);

Municipio/comment/save_like

在评论点赞时执行操作

• @param object $comment - 评论对象
• @param int $userId - 当前用户 ID
• @param bool $create - 如果创建了一个新的点赞则为 True。如果移除了则为 False

do_action('Municipio/comment/save_like', $comment, $userId, $create);

过滤器

Municipio/theme/key

过滤主题/样式指南资产密钥。

• @param string $key - 样式指南主题的密钥

apply_filters('Municipio/theme/key', $key);

Municipio/author_display/name

设置作者显示的名称

• @param string $name - 默认名称
• @param string $userId - 用户的 ID

apply_filters('Municipio/author_display/name', $name, $userId);

Municipio/author_display/title

设置作者名称显示的标题标签

• @param string $title - 默认标题

apply_filters('Municipio/author_display/title', $title);

Municipio/ajax_url_in_head

在

• @param string $ajax_url - 默认的 ajax url

apply_filters('Municipio/ajax_url_in_head', $ajax_url);

Municipio/favicon_sizes

为 favicon 添加主题选项的大小

• @param array $sizes - 默认的 favicon 大小

apply_filters('Municipio/favicon_sizes', $sizes);

Municipio/favicon_tag

为 favicon 添加主题选项的大小

• @param string $tag - HTML 标签
• @param array $icon - 图标数据

apply_filters('Municipio/favicon_tag', $tag, $icon);

Municipio/header_grid_size

应用于标题大小类字符串。

• @param string $classes -

apply_filters('Municipio/header_grid_size', $classes);

Municipio/mobile_menu_breakpoint

应用于移动汉堡菜单断点的类字符串。

• @param string $classes - 默认站点名称

apply_filters('Municipio/mobile_menu_breakpoint', $classes);

Municipio/logotype_text

应用于当在主题选项中上传了logotype图片时显示为logo的文本。

• @param string $title - 默认站点名称

apply_filters('Municipio/logotype_text', $title);

Municipio/logotype_class

应用于logotype类属性

• @param array $classes - 默认类

apply_filters('Municipio/logotype_class', $classes);

Municipio/logotype_tooltip

应用于logotype类属性

• @param string $tooltip - 默认提示文本

apply_filters('Municipio/logotype_tooltip', $tooltip);

Municipio/blade/data

应用于blade模板数据。可用于向Blade视图发送数据。

• @param array $data - 默认数据

apply_filters('Municipio/blade/data', $data);

Municipio/blade/template_types

应用于Blade模板类型的列表。

• @param array $types - 默认Blade模板类型

apply_filters('Municipio/blade/template_types', $types);

Municipio/search_result/…

应用于搜索结果内容的多个过滤器

• @param string $var - 变量的内容
• @param object $post - 帖子对象

apply_filters('Municipio/search_result/date', $date, $post);
apply_filters('Municipio/search_result/title', $title, $post);
apply_filters('Municipio/search_result/excerpt', $excerpt, $post);
apply_filters('Municipio/search_result/permalink_url', $permalink_url, $post);
apply_filters('Municipio/search_result/permalink_text', $permalink_text, $post);

Municipio/search_form/…

应用于搜索表单的过滤器

• @param string $var - 变量的内容

apply_filters('Municipio/search_form/action', $url);

Municipio/archive/sort_keys

修改存档可用的排序键

• @param array $keys - 键
• @param string $postType - 帖子类型

apply_filters('Municipio/archive/sort_keys', $keys, $postType);

Municipio/archive/date_filter

修改日期过滤WHERE子句

• @param string $where - sql WHERE子句
• @param string $from - 查询字符串中的"from"日期
• @param string $to - 查询字符串中的"to"日期

apply_filters('Municipio/archive/date_filter', $where, $from, $to);

Municipio/Breadcrumbs

显示/隐藏（true/false）面包屑

• @param boolean $bool- 真或假（显示或隐藏）

apply_filters('Municipio/Breadcrumbs', $bool, get_queried_object())

Municipio/Breadcrumbs/Items

过滤面包屑中的项/链接

• @param array $items - 面包屑项

apply_filters('Municipio/Breadcrumbs/Items', $items, get_queried_object());

Municipio/admin/editor_stylesheet

更改自定义编辑器样式表

• @param string $url - 样式表URL

apply_filters('Municipio/admin/editor_stylesheet', $url);

Municipio/oembed/should_filter_markup

决定oembed标记是否应该被过滤到HbgPrime视频播放器（youtube和vimeo）。

• @param string $url - 资源URL
• @param int $postId - 当前帖子的ID

apply_filters('Municipio/oembed/should_filter_markup', true, $url, $postId);

Municipio/Menu/Vertical/EnabledSidebars

指定当前页面应显示垂直菜单的侧边栏。简单的包含侧边栏ID的数组。

• @param array $sidebars - 包含侧边栏ID的扁平数组。

apply_filters('Municipio/Menu/Vertical/EnabledSidebars', $sidebars);

Municipio/archive/tax_query

额外的分类查询。

• @param array $taxQuery - 包含分类查询。
• @param object $query - 当前查询对象。

apply_filters('Municipio/archive/tax_query', $taxQuery, $query);

Municipio/taxonomy/tag_style

向分类标签添加自定义样式。

• @param string $style - 自定义CSS。
• @param string $term - 术语。
• @param string $taxonomy - 分类。

apply_filters('Municipio/taxonomy/tag_style', $style, $term, $taxonomy);

Municipio/Menu/Vertical/Items

应可见于垂直导航菜单的项。表示为带有悬停标签的点。

• @param array $items - 包含表示链接的项的数组。

apply_filters('Municipio/Menu/Vertical/EnabledSidebars', array(array('title' => 'Page section title', 'link' => '#anchorlink'));

开发者模式

从本地样式指南加载资源。设置常量DEV_MODE为"true"。

define('DEV_MODE', true);

主题字体

Municipio与Google Web Fonts集成。它启用智能加载字体，防止使用Google和Adobe Webfont Loader时字体不可见。

define('WEB_FONT', 'Roboto'); //The google fonts name (without weights)
define('WEB_FONT_REMOTE', true); //Load font kit from cdn

版本2.0

版本2.0的目标是重构主题前端，并朝着BEM（IT）标准进行标记。将以自动方式添加更多过滤器，类似于ACF所做的那样。现在，以下将进行文档记录。

已弃用功能（通知阶段）

版本2.0将引入一些关于删除一些先前功能的警告。根据计划，这些功能将在版本3.0中实际删除。将在3.0中删除的功能包括。

• Gravitiforms优化
• 评论中的Honeypot功能（这将被移动到单独的插件）。还将包括Google reCAPTCHA。
• 联系表单小部件（在模块化中可用作替代品）
• RichText小部件（内置于核心中替代）
• PostType & Taxonomy创建器（移动到插件）
• 上传过滤器（移动到插件）

过滤器

弃用的过滤器

• HbgBlade/data 已由 Municipio/viewData 替换
• Municipio/ajax_url_in_head 已由 Municipio/ajaxUrl 替换
• Modularity/CoreTemplatesSearchPaths

Blade 视图过滤器

在控制器中创建的所有变量（发送的变量）将自动通过以变量键命名的过滤器。

apply_filters('Municipio/{{KEY}}', $var);

全局视图过滤器

您可能希望获取发送到视图的全量数组。在上面的过滤器运行之后，将应用全局过滤器。这替换了旧过滤器。

apply_filters('Municipio/viewData', $var);

常量

MUNICIPIO_FRAGMENT_CACHE - 设置为 false 以删除片段缓存。

主题视图结构

bem-views 
│   [Main folder for  theme views, containing WordPress templates like page.blade.php] 
│
└───components
│   │   [Components for the theme like card.blade.php]
│   │
└───partials
│   │   [Big chunks that are reused in templates footer.blade.php]
│   │
└───templates
    │   [General templates that are included in main WordPress views like master.blade.php]
│   │
└───utilities
    │   [Small pieces used by components like button.blade.php]
│   │
└───widgets
    │   [Widgetized components]
    │

图像压缩

Municipio 支持使用 shortpixel 进行图像压缩。这将延迟排队一个 cronjob 以压缩新上传的图像。只需在您的配置文件中定义 SHORTPIXEL_API_KEY 常量即可！

压缩级别将为中等/光亮，适用于高质量照片。

与 BrowserStack 的支持进行测试

本软件与 Browserstack 的出色工具进行了测试。