-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update GETSTARTED.md based on Google Doc notes (#108)
via @bacoords and @candy02058912
- Loading branch information
1 parent
9d52171
commit 5e03a6e
Showing
1 changed file
with
76 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,94 @@ | ||
|
|
||
| # Get Started | ||
| Start leveraging the latest WordPress core features with WordPress.com’s experimental Create Content Model plugin. | ||
|
|
||
| ## Quick Start Guide | ||
| Create custom post types and custom fields directly in the Block Editor, and then export your data model and data entry UI as a standalone, maintenance-free plugin. Everything you build is using core WordPress functionality, so you can run the future-proof plugin or you can use filters and hooks to extend and adapt your data model. | ||
|
|
||
| To get started with the Create Content Model plugin, [download the latest release](https://github.com/Automattic/create-content-model-releases/raw/latest/create-content-model.zip) or [launch our WordPress Playground Blueprint](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/Automattic/create-content-model/trunk/blueprint.json). | ||
|
|
||
| https://github.com/user-attachments/assets/50f2b533-a412-4f40-ae21-17af0b90c39d | ||
|
|
||
| #### Create Data Model | ||
| ## Creating a content model | ||
|
|
||
| A content model is a custom post type that you can register and build directly in WordPress core. As you design it, you select which blocks are editable and can add custom fields. | ||
|
|
||
| Creating a new content model includes: | ||
|
|
||
| 1. Registering a new post type. | ||
| 2. Designing the frontend template for your new post type and selecting which blocks in the template are editable by adding new “Bindings.” | ||
| 3. Adding custom fields to your post to collect additional data. | ||
|
|
||
| *Note that custom taxonomy support is on the [roadmap](https://github.com/Automattic/create-content-model/issues/77).* | ||
|
|
||
| ### Register the post type | ||
|
|
||
| From the Content Models page: | ||
|
|
||
| 1. Click **Add New Model**. | ||
| 2. Name your content model. | ||
| 3. Manage the post type settings using the sidebar panel: Singular Label, Plural Label, Icon Name | ||
|
|
||
|  | ||
|
|
||
| ### Design the frontend template for your new post type | ||
| Once you’ve created the post type, you can start designing the template. | ||
|
|
||
| As you add blocks to the template, they will not be editable by default. You’ll need to select which blocks include dynamic (aka editable) data by selecting **Add Binding** in the block sidebar controls. | ||
|
|
||
| Once a block is “bound,” it will be editable in the future, and any data entered will be automatically stored as postmeta, meaning you can use that data in different templates or query loops, view it in the REST API, bulk manage it via the database, and much more. | ||
|
|
||
|  | ||
|
|
||
| Since we’re using core WordPress’ [Block Bindings API](https://make.wordpress.org/core/2024/03/06/new-feature-the-block-bindings-api/), the only blocks that are currently supported are the [Paragraph](https://wordpress.org/documentation/article/paragraph-block/), [Heading](https://wordpress.org/documentation/article/heading-block/), [Image](https://wordpress.org/documentation/article/image-block/), and [Buttons](https://wordpress.org/documentation/article/buttons-block/) blocks. | ||
|
|
||
| ### Rich content areas: the Group block | ||
| This tool also allows you to bind the [Group](https://wordpress.org/documentation/article/group-block/) block to a post meta field, which creates a “rich text” or WYSIWYG area in your template where multiple blocks can be used. A bound group block will store its contents in a post meta field, or you can map it directly to the `post_content` attribute. | ||
|
|
||
|  | ||
|
|
||
| ## Your data model and custom fields | ||
| All of your bound blocks will save their content to post meta fields, so you can redesign, remix, and filter your content model in the future and without losing the integrity of your data. Open the Post Meta sidebar panel to view. | ||
|
|
||
|  | ||
|
|
||
| Click the Manage Post Meta button to browse all of your block bindings and create your own custom fields that are available in the post editing screen. | ||
|
|
||
|  | ||
|
|
||
| Click **Publish** to see your new content model on your website. | ||
|
|
||
| ## Adding and managing content | ||
| Once your data model is published, it will show up as an additional post type beneath Posts and Pages in your WordPress dashboard. | ||
|
|
||
| Add new content just like you would add any other post content. You’ll notice that only the blocks you bound are editable, and the rest of the data model’s template is safe from being changed or edited. | ||
|
|
||
|  | ||
|
|
||
| * From the Content Models page, click Add New Model. | ||
| * Name the model. | ||
| * Add a block and a placeholder value. | ||
| * Use the Attribute Bindings UI in the Block Inspector panel to set up bindings. | ||
| * Save the data model, and the data model will show up in the WP Admin sidebar. | ||
| Any custom fields that you’ve added will also be available in the post sidebar: | ||
|
|
||
| #### Data Entry | ||
|  | ||
|
|
||
| * Click on the data model name in the WP Admin sidebar. | ||
| * Create a few instances of the data model. | ||
| Click the **Publish** button to publish your post and view it on the front end. | ||
|
|
||
| #### Usage in Query Loops | ||
| ## Updating the front-end layout | ||
| Create Content Model is designed to work with the block editor and block-based themes. If you’d like to make changes to the design of the single or archive templates for your custom post type, you can do that inside of the Site Editor, just like you would for any other post type. | ||
|
|
||
| * In a new Page/Post/Template, add a Query Loop Block. | ||
| * Select the Post Type for the Query Loop. | ||
| * Tweak the template to your liking. | ||
| ### Single post template | ||
| You can set up the single post layout in your custom post type template. Alternatively, you can create a new `single-CPTNAME.html` template and add block variations from the block inserter. | ||
|
|
||
| #### Export Workflow | ||
| ### Archives and the Query Loop block | ||
| Create a custom [Query Loop](https://wordpress.org/documentation/article/query-loop-block/) on a page, `archive-CPTNAME.html` template, or any other template (e.g. the theme’s home template). Pull in the posts from your data model, sort and filter them, and use the new block variations in the block inserter to pull individual pieces of data into your template. | ||
|
|
||
| * Click Content Models > Export. | ||
| * Click on "Download ZIP file" to get the standalone plugin. | ||
| * Install and activate the standalone plugin on a new site (or deactivate the main plugin on the current site and install the standalone plugin). | ||
| * The defined data model will show up in the WP Admin sidebar. | ||
| * You can start creating instances of the data model. | ||
|  | ||
|
|
||
| ## Plugin export workflow | ||
| Create Content Model is a development tool, but it’s not required to run on your site. If you’re done building your content model, you can “export” it as a standalone plugin: | ||
|
|
||
| ## Advanced usage | ||
| 1. Click Content Models → **Export**. | ||
| 2. Export the data model plugin by clicking the **Download ZIP fil**e button. | ||
| 3. Install your data model plugin on a new site (or deactivate the main plugin on the current site and import the new plugin). Remember to upload it as the .zip file. | ||
| 4. Optionally, add version control for your own content model plugin to track changes and deploy your plugin across multiple sites. | ||
|
|
||
| #### Manage block binding fields | ||
| * Use the Manage Fields UI to manage all post_meta fields. | ||
| * Use the special binding key `post_content` with a Group block to generate a bound rich text area. | ||
| * Save the data model. | ||
|
|
||
|
|
||
| #### Front-end layout | ||
|
|
||
| * Single post | ||
| * You can set up the the single post layout in the CPT template. | ||
| * Alternatively you can create a new MyCPTsingle.html template and add block variations from the block inserter. | ||
| * Query loop | ||
| * Create a custom query loop on a page or template (e.g. the theme’s home template) and add block variations from the block inserter. |