helsingborg-stad/trenomvarldsanalys-wp

3.0 市镇子主题，适用于Trend, Omvarld。

维护者

详细信息

github.com/helsingborg-stad/trenomvarldsanalys-wp

来源

安装: 14

依赖: 0

建议: 0

安全性: 0

星标: 0

关注者: 1

分支: 1

类型：wordpress-theme

dev-main 2022-01-28 15:09 UTC

Requires

MIT d1860322a02f73a47a1a5f90c2022e59c03391a3

  • Sebastian Thulin <sebastian.thulin.woop@helsingborg.se>

This package is auto-updated.

Last update: 2024-08-28 20:29:53 UTC

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并启动"监视"任务，请在主题目录中运行以下命令

$ 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

应用于当在主题选项中未上传标志图像时显示为标志的文本。

  • @param string $title - 默认站点名称
apply_filters('Municipio/logotype_text', $title);

Municipio/logotype_class

应用于标志类的属性

  • @param array $classes - 默认类
apply_filters('Municipio/logotype_class', $classes);

Municipio/logotype_tooltip

应用于标志类的属性

  • @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 - True 或 false（显示或隐藏）
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 字体。它启用智能字体加载，防止使用 Google & Adobe Web 字体加载器时的不可见字体。

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优化
  • 评论的蜜罐功能（将移至独立插件）。还将包括Google reCAPTCHA。
  • 联系小部件（模块化中可用）
  • 富文本小部件（集成在核心中）
  • 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的出色工具进行测试。