• Stars
    star
    166
  • Rank 219,676 (Top 5 %)
  • Language
    PHP
  • License
    GNU General Publi...
  • Created about 3 years ago
  • Updated 27 days ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Content modeling plugin for WordPress

Atlas Content Modeler

Atlas Content Modeler by WP Engine

A WordPress plugin to create custom post types and fields for headless WordPress sites.

Download the latest plugin zip file.


Screenshot showing the Atlas Content Modeler post type creation application.


For developers

Developers get a modern content modeling system with WPGraphQL and REST support.

For publishers

Publishers get friendly and familiar content entry pages.

Requirements

  • WordPress 5.7 or higher.
  • PHP 7.2 or higher.
  • We recommend that you set Permalinks to a value other than “Plain” in your WordPress dashboard at Settings → Permalinks.

Setup

  1. Download the latest copy of the Atlas Content Modeler plugin here.
  2. Install and activate the plugin in your WordPress admin area at Plugins → Add New by clicking “Upload Plugin”.
  3. We recommend that developers also install and activate the WPGraphQL plugin to be able to fetch model entries with GraphQL.

Once installed, Atlas Content Modeler and WPGraphQL check for updates and display prompts to install new versions.

Quick start

Atlas Content Modeler has a three-step workflow:

  1. Developers create a content model and its fields.
  2. Publishers add entries for that model.
  3. Developers fetch entry data with WPGraphQL or REST to display in their website or application.

Create a content model

  1. Click “Content Modeler” in your WordPress admin sidebar.
  2. Click “Get Started” to add your first model.
  3. Type “Cat” as the singular name, “Cats” as the plural name and set “API Visibility” to “Public”. Optionally type a description.
  4. Click “Create”.

You will see “The Cats model was created”. Now you're ready to add your first field.

Add fields to your model

  1. Click the “Text” button to add a text field.
  2. Type “Name” into the name field so that publishers will be able to give their cats a name.
  3. Tick “Use this field as the entry title”.
  4. Click “Create”.

Let's add one more field so that publishers can add an image of their cats.

  1. Click the purple “+” button below the Name field you just added.
  2. Click the “Media” button.
  3. Type “Photo” into the name field.
  4. Click “Create”.

Nice work! You defined your first model and added two fields. It's time to add your first cat entry.

Add entries

  1. Click the “Cats” menu item in the WordPress admin sidebar.
  2. Click “Add New”.
  3. Give your cat a name and add a photo.
  4. Click “Publish”.

You defined a cat model and added your first cat entry. That's everything you need to be able to fetch cats using a GraphQL or REST request.

Fetch content

Atlas Content Modeler is designed for headless WordPress, where a developer creates an app or website to display custom content. Developers can fetch content with GraphQL or REST:

Fetch content with GraphQL

Install and activate the WPGraphQL plugin to follow along with this example.

  1. Click “Content Modeler” in your WordPress admin sidebar.
  2. Click the options button (three dots) on the right of the “Cats” row in the list of models.
  3. Click “Open in GraphiQL”. GraphiQL will load with a pre-filled query for your cats data.
  4. Click the Play button at the top of GraphiQL. The response will include the name and image information for the cat you added.

Fetch content with REST

Visit https://example.com/wp-json/wp/v2/cats in your browser, replacing https://example.com with your WordPress URL.

You will see model data for your cats. Atlas Content Model fields appear in the acm_fields property:

[
	{
		"acm_fields": {
			"name": "Garfield",
			"photo": {}
		}
	}
]

Authenticate requests for private models

Models with a “Private” API Visibility need authenticated GraphQL and REST requests. Learn about authentication options from the WPGraphQL documentation.

Change the API Visibility of a model at any time by choosing “Edit” from the model options.

Requests sent in a GraphiQL session in the WordPress admin area are authenticated by default. This makes GraphiQL a good place to experiment with queries for private model data.

Next steps

More Repositories

1

faustjs

Faust.js™ - The Headless WordPress Framework
TypeScript
1,308
star
2

frost

The ultimate WordPress block theme for website designers and developers.
PHP
509
star
3

github-action-wpe-site-deploy

A GitHub Action to deploy code directly to WP Engine.
Shell
151
star
4

phpcompat

WordPress Plugin: PHP Compatibility Checker
PHP
115
star
5

wp-graphql-content-blocks

Plugin that extends WPGraphQL to support querying (Gutenberg) Blocks as data
PHP
82
star
6

geoip

WordPress Plugin: WP Engine GeoTarget
PHP
46
star
7

php-docker

RD - PHP docker base images
Roff
45
star
8

headless-docs

***Deprecated ***WP Engine Headless Documentation for Developers
MDX
37
star
9

wpe-search-DEPRECATED

A WordPress plugin for integrating ElasticSearch with WP Engine, based off of ElasticPress
PHP
32
star
10

wpengine-coding-standards

WP Engine Coding Standards for WordPress
Shell
28
star
11

atlas-blueprint-portfolio

A portfolio template for Atlas Blueprints
JavaScript
26
star
12

block-pattern-explorer

An experimental plugin to preview and insert block patterns in WordPress.
JavaScript
19
star
13

base-images-public

Simple Docker Images
Dockerfile
15
star
14

faust-scaffold

Lightweight scaffolding for your next headless WordPress app!
JavaScript
14
star
15

wp-graphql-filter-query

Adds taxonomy filtering and aggregation support to WP GraphQL
PHP
10
star
16

example-sage-theme

Modern theme development with WP Engine
PHP
8
star
17

atlas-blueprint-basic

A basic template for Atlas Blueprints
JavaScript
7
star
18

faust-scaffold-ts

Faust Scaffold Blueprint in TypeScript
TypeScript
7
star
19

newrelic-docker-DEPRECATED

New Relic Daemon Docker Image
6
star
20

atlas-commerce-blueprint

An eCommerce template for Atlas Blueprints
JavaScript
6
star
21

homebrew-wpe-cli

A Homebrew formula for wpe-cli
Ruby
6
star
22

hackathon-catation

Hackathon 2020 project: IPFS photo sharing
Go
4
star
23

atlas-shopify-blueprint

Atlas Shopify Blueprint
JavaScript
4
star
24

site-deploy

Base image to build VCS integrations enabling customers to deploy their site to WP Engine
Shell
3
star
25

faust-atlas-hello-world

"Hello World" example project using Faust.js for Atlas
TypeScript
3
star
26

wpe-graphql-cache

An integration with wp-graphql and WPE to purge graphql requests cached in Varnish.
PHP
2
star
27

atlas-blueprint-blog

A blog template for Atlas Blueprints
JavaScript
2
star
28

acm-content-connect

Fork of the 10up WordPress library that enables direct relationships for posts to posts.
PHP
1
star