PHPackages                             upstatement/ups-editorial-wp-plugin - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. upstatement/ups-editorial-wp-plugin

ActiveWordpress-plugin[Utility & Helpers](/categories/utility)

upstatement/ups-editorial-wp-plugin
===================================

WordPress plugin for extending the WordPress editorial experience.

1.0.0(3y ago)6251[1 issues](https://github.com/Upstatement/ups-editorial-wp-plugin/issues)MITJavaScriptPHP >=7.4

Since Feb 23Pushed 3y ago11 watchersCompare

[ Source](https://github.com/Upstatement/ups-editorial-wp-plugin)[ Packagist](https://packagist.org/packages/upstatement/ups-editorial-wp-plugin)[ RSS](/packages/upstatement-ups-editorial-wp-plugin/feed)WikiDiscussions main Synced today

READMEChangelog (1)Dependencies (4)Versions (3)Used By (0)

Upstatement Editorial
=====================

[](#upstatement-editorial)

A WordPress plugin for enhancing the editorial experience, including some common customizations for the [Gutenberg](https://wordpress.org/gutenberg/) editor.

Table of Contents
-----------------

[](#table-of-contents)

- [What This Plugin Does](#what-this-plugin-does)
    - [Blocks](#blocks)
    - [Editor Plugins](#editor-plugins)
    - [Core Enhancements](#core-enhancements)
- [Theme Configuration](#theme-configuration)
- [Theme API](#theme-api)
- [Troubleshooting](#troubleshooting)
- [Local Development](#local-development)
- [Resources](#resources)

What This Plugin Does
---------------------

[](#what-this-plugin-does)

The purpose of this plugin is to tailor the Gutenberg editor experience to be better suited to editors using their WordPress theme and to add functionality common to many websites. Features added as a part of this plugin fall into three categories: block modifications, editor plugins, and core enhancements. This plugin also exposes some global functions that can be used in theme templates.

### Blocks

[](#blocks)

#### Extended Blocks

[](#extended-blocks)

The following blocks are extended typically at the registration hook (`blocks.registerBlockType`) to limit the number of available options for an editor. Some blocks also hook into the edit lifecycle (via the `editor.BlockEdit` hook) to add additional classes and structure to the editor markup so as to be able to control certain aspects of the block's settings with css.

- [Cover](./src/blocks/extends/cover/index.js)
- [File](./src/blocks/extends/file/index.js)
- [Gallery](./src/blocks/extends/gallery/index.js)
- [Image Layout](./src/blocks/extends/image-layout/index.js)
- [Related Articles](./src/blocks/extends/related-articles/index.js)
- [Table](./src/blocks/extends/table/index.js)
- [Video](./src/blocks/extends/video/index.js)

> Note that you can continue to extend core block functionality in your theme by using WordPress's [blocks.registerBlockType](https://developer.wordpress.org/block-editor/developers/filters/block-filters/#blocks-registerblocktype) and [editor.BlockEdit](https://developer.wordpress.org/block-editor/developers/filters/block-filters/#editor-blockedit) filters.

### Editor Plugins

[](#editor-plugins)

Our main Gutenberg "plugin" adds two panels to the main sidebar of posts: the Article Topper & Authors panels.

#### Article Topper Panel

[](#article-topper-panel)

The article topper panel controls article post metadata concerned with the article topper. This includes:

- `Topper type`: The look and feel of the topper, be it text-only or a site-width featured image
- `Navigation theme`: When paired with dark background image toppers, an already dark-themed nav can appear invisible. This option allows for lighter navigation themes
- `Overline`: Choose a primary category for your article to allow for better recirculation amongst common themes

#### Authors Panel

[](#authors-panel)

The Authors panel allows editors to assign multiple authors to the author byline. This process starts with the `Authors` section under `Posts`, where you can create author profiles.

These authors also serve as taxonomies for your articles, so archive pages full of an author's own content are auto-generated on your behalf.

### Core Enhancements

[](#core-enhancements)

- Adds a `Credit` field to attachment posts.

### Template functions

[](#template-functions)

This plugin exposes a few functions that can be used to retrieve relevant values handled by the plugin. See the [Theme API](#theme-api) section for information about the available functions.

Theme configuration
-------------------

[](#theme-configuration)

By default, all features of this plugin are enabled once the plugin is activated. However, you are able to configure the plugin's functionality (including disabling certain features) via a configuration file that can be added to your theme.

To set up a configuration file, add a `ups-editorial.php` file to your theme's root that returns an array containing the relevant configuration options:

```