Automattic / Automattic/php-toolkit
Feature: Support arbitrary front matter metadata, categories, tags, author, featured image and SEO fields
- 主要言語
- PHP
- スター
- 22
- フォーク
- 5
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
### Summary
Push MD supports a fixed set of basic front matter keys (`title`, `date`, `status`, `description`). We should add support for arbitrary front matter metadata key-values. To begin, create hooks for front matter meta data, and add support for hierarchical categories, tags, author attribution, featured image, and SEO fields, complete with strict push validation to prevent typos.
We can create "master" reference files for categories etc, and support CRUD based on changes in these files. All this should respect the user permissions though. Special case: for authors - no create / delete support.
### Features & How They Should Work
1. **Extensible Arbitrary Front Matter Meta Support (Primary Feature)**:
- Add developer hook framework allowing any custom post meta or third-party plugin metadata to be registered, exported, and imported via Markdown front matter:
- `push_md_supported_frontmatter_keys`
- `push_md_export_frontmatter`
- `push_md_import_frontmatter`
- `push_md_export_author` & `push_md_import_author`
2. **Master Reference Files & Strict Validation**:
- Generate `categories.md`, `tags.md`, and `authors.md` during checkout/seed.
- Pushing a post with an unknown category, tag, or author that is not in WordPress or the reference files should trigger a strict validation error to prevent typos.
3. **Categories, Tags, Authors & Featured Image**:
- `categories`: Support YAML lists, JSON arrays (`["Cat A", "Cat B"]`), or comma-separated strings. Full support for hierarchical category paths using `"Parent > Child"` (e.g., `Tech > WordPress`).
- `tags`: Support YAML/JSON lists or comma-separated tag strings.
- `author`: Match author by display name, username (`user_login`), nicename, or email address.
- `featured_image`: Resolve local path or attachment URL to WordPress attachment ID.
4. **Built-in SEO Metadata**:
- Build on top of the front matter hooks: supports `seo_title`, `seo_description`, and `seo_focus_keyword`.
- Automatically map to **Rank Math** or **Yoast SEO** post meta depending on which plugin is active.
### Acceptance Criteria
- [ ] Custom front matter keys can be registered via `push_md_supported_frontmatter_keys`.
- [ ] Front matter list parser supports YAML lists, JSON arrays, and comma-separated strings.
- [ ] Hierarchical categories (`Parent > Child`) parse and map correctly.
- [ ] Unknown terms/authors trigger a push validation error.
- [ ] Permission checks
- [ ] SEO fields map automatically to Rank Math / Yoast SEO meta.
- [ ] No creation or deletion of users from `authors.md` sync. Only updates.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
調査の方向性
実装ファイルやテストは指定されていないため、まず既存の front-matter checkout、import/export、push-validation のエントリポイントを見つけ、次に提案されている hook 名と権限ルールを確認してください。完了とは、リスト形式、階層的な用語、厳密なバリデーション、SEO マッピング、作者の作成や削除を行わないことを含め、記載された受け入れ基準が満たされていることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- php, wordpress
- 領域
- backend, content
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 静か
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100