README

Timber 2.0

由 Jared Novack (@jarednova), Lukas Gächter (@lgaechter), Nicolas Lemoine (@nlemoine), Erik van der Bas (网站), Coby Tamayo (@cobytamayo), Upstatement 以及 成百上千的其他 GitHub 贡献者

⚠️ 关于 Timber 插件的重要信息 ⚠️

随着 Timber 2.0 的发布，Composer 是唯一支持的安装方法。我们无法继续在 WordPress.org 上作为插件发布或支持 Timber。我们建议所有人尽快 切换到基于 Composer 的 Timber 1 安装 作为第一步。如果您需要 PHP 8.2 支持，您必须切换到 Timber 2.0。

有关更多信息和其他资源列表，请访问此 讨论。

什么是 Timber？

因为 WordPress 很棒，但 The Loop 并不是。

Timber 帮助您使用更可持续的代码更快地创建完全定制的 WordPress 主题。使用 Timber，您可以使用 Twig 模板引擎 在 PHP 文件之外编写您的 HTML。

这样可以清理您的主题代码，例如，您的 PHP 文件可以专注于数据/逻辑，而您的 Twig 文件可以专注于 100% 的 HTML 和显示。

这是 Timber 的 .twig 文件的样子（来自这个 Hello World 示例）

{% extends "base.twig" %}

{% block content %}
  <h1 class="big-title">{{ foo }}</h1>
  <h2 class="post-title">{{ post.title }}</h2>

  <img src="{{ post.thumbnail.src }}" />

  <div class="body">
	{{ post.content }}
  </div>
{% endblock %}

一旦安装了 Timber，它就会让任何 WordPress 主题都能利用 Twig 和其他 Timber 功能的力量。

文档

• Timber 文档
• Timber 2.0 升级指南
• Twig 参考
• 概述 / 入门指南

安装

请遵循 安装指南 以了解如何使用 Composer 安装 Timber。

接下来做什么？

设置 Timber Starter Theme。一旦在您的 WordPress 设置中安装了它，请继续阅读 主题设计入门指南。

Timber 的使命

Timber 是一款为开发者设计的工具，它可以帮助开发者通过直观、一致且完全可访问的界面将 HTML 转换为高质量的 WordPress 主题。

• 直观：API 的设计围绕程序员的需求，以用户为中心。
• 一致：可以通过常见的多态属性（如 slug、ID 和名称）访问 WordPress 对象。
• 可访问：没有黑盒。我们尽一切努力确保开发者能够访问其 100% 的 HTML。

它看起来是什么样子？

什么都没有。Timber 旨在让您构建主题。就像 underscores 一样，它是无风格的，因为您是风格专家。相反，Timber 处理您需要构建一个看起来很棒的网站的逻辑。

它适合谁使用？

Timber 对任何关注编写良好、可维护代码的 WordPress 开发者来说都是很好的。它有助于设计师和开发团队合作。在 Upstatement，我们创建 Timber，因为虽然我们整个团队都需要参与构建 WordPress 网站，但并非每个人都了解 the_loop()、codex 和 PHP（也不应该这样做）。有了 Timber，您最好的 WordPress 工程师可以专注于构建带有 WordPress 请求的 .php 文件，并将数据传递到 .twig 文件中。一旦到了那里，设计师就可以轻松地标记数据并构建网站的样式和外观。

我应该使用它吗？

Timber 是 MIT 许可的，因此请在个人或商业工作中使用它。只是不要转售它。Timber 已被用于 成千上万的网站（以及更多我们不了解的网站）

Timber 1

您可以在 1.x 分支 上找到 Timber 1 的代码，并在此处阅读 Timber 1 文档 。

链接

相关 & 官方项目

• Twig Timber 所使用的模板语言。
• Timber Starter Theme Timber 的 "_s"，为您提供开始构建和自定义最基本主题的简单起点。
• wp-i18n-twig 从 Twig 文件中获取可翻译字符串的 WP CLI 命令。
• Timber Debug Bar 添加一个调试栏面板，它将显示正在使用的模板以及发送到您的 twig 文件的数据。

相关 Timber 项目

• Editor for Timber 从 WordPress 管理界面编辑您的 Twig 文件。
• Pine Timber 的 CLI 安装程序。
• Query Monitor Twig Profile Query Monitor 的插件，用于查看您的 Twig 文件中的内容（与 Timber 自动协同工作！）
• Timber ACF WP Blocks 简单创建 ACF Gutenberg 块。
• Timber CLI Timber 的 CLI。
• Timber Commented Include 在每个 include 语句之前和之后通过 HTML 注释进行调试输出。
• Timber Debugger 提供额外调试选项的包。
• Timber Dump Extension 以美观格式显示调试输出
• Timber Photon 插件，用于在Timber中使用JetPack的免费Photon图像处理和CDN
• Timber VS Code Extension Visual Studio Code中Timber代码片段
• Timber Sugar 用于Timber的各种实用工具
• Timber WebLink Extension 提供用于管理HTTP/2服务器推送和资源提示所需的Link HTTP头部的Twig函数
• Timmy Timber的高级图像处理

使用Timber的项目

• Branch Bootstrap 3 + Timber = Branch启动主题！
• Flynt 基于Timber和ACF Pro的组件化WordPress启动主题
• Gantry5 主题开发框架
• Hozokit 组件化启动主题
• Juniper 启动包，集成了Timber和Bedrock
• Seedling 使用Bootstrap 4的启动主题

有用的链接

• CSS Tricks @tjFogarty 对Timber的介绍
• Twig for Timber Cheatsheet by @laras126
• Timber Cheatsheet by @taotiwordpress
• TutsPlus @ahmadawais 提供的入门指南

报告安全问题

请通过 GitHub 提交报告来向我们的团队披露安全问题。

支持

请在 StackOverflow上的"Timber"标签 下发布帖子。请仅使用GitHub问题跟踪器报告特定错误、功能请求和其他类型的问题。

贡献 & 社区

我们热爱PRs！阅读贡献指南 了解更多信息。在 @TimberWP 上打招呼、分享你的技巧/作品，并传播爱心。

赞助我们

自2013年以来，Timber的目标是创建一个库，帮助您更快地使用更具可持续性的代码创建完全定制的WordPress主题。

通过我们专业团队和无数贡献者的共同努力，我们投入了无数小时来维护和提升Timber。为了继续这样做，我们依赖赞助商宝贵的支持。

你是WordPress专业人士，还是依赖Timber的代理商？通过成为赞助商来保持这份神奇！成为赞助商，你将为Timber的持续维护和提升做出贡献，最终惠及全球的开发者。

金牌赞助商

我们的支持者

文档

Timber的官方文档由本仓库的内容生成

• 类和函数的文档是自动生成的。如果需要修改文档中的参考部分，应通过编辑函数的DocBlock进行。对于内联文档，我们遵循WordPress PHP文档标准。
• 要修改指南中的某一部分，请编辑docs目录中的相关文件。