alleyinteractive / wp-newsletter-builder
Interface to manage email newsletters
Installs: 437
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 20
Forks: 1
Open Issues: 25
Type:wordpress-plugin
Requires
- php: ^8.1
- alleyinteractive/composer-wordpress-autoloader: ^1.0
- campaignmonitor/createsend-php: ^7.0
- sendgrid/sendgrid: ^8.1
- tijsverkoyen/css-to-inline-styles: ^2.2
Requires (Dev)
- dev-develop
- v0.4.2
- v0.4.1
- v0.4.0
- v0.3.35
- v0.3.34
- v0.3.33
- v0.3.32
- v0.3.31
- v0.3.30
- v0.3.29
- v0.3.28
- v0.3.27
- v0.3.26
- v0.3.25
- v0.3.24
- v0.3.23
- v0.3.22
- v0.3.21
- v0.3.20
- v0.3.19
- v0.3.18
- v0.3.17
- v0.3.16
- v0.3.15
- v0.3.14
- v0.3.13
- v0.3.12
- v0.3.11
- v0.3.10
- v0.3.9
- v0.3.8
- v0.3.7
- v0.3.6
- v0.3.5
- v0.3.4
- v0.3.3
- v0.3.2
- v0.3.1
- v0.3.0
- v0.2.0
- v0.1.0
- dev-dependabot/npm_and_yarn/uuid-11.0.3
- dev-dependabot/npm_and_yarn/dompurify-3.2.0
- dev-dependabot/npm_and_yarn/wp-types-4.67.0
- dev-dependabot/npm_and_yarn/alleyinteractive/block-editor-tools-0.11.0
- dev-dependabot/npm_and_yarn/babel/preset-env-7.26.0
- dev-develop-built
- dev-feature/issue-97/remove-fieldmanager-dependency
- dev-feature/LEDE-2632/update-sendgrid-account-redirect
- dev-debug-built
- dev-fix/issue-122/disable-editor-styles-newsletter-screen
- dev-feature/issue-19/breaking-news-meta-box-classic
- dev-feature/issue-17/add-url-override-post-block
- dev-hotfix/email-settings-on-template
- dev-hotfix/remove-singleton
- dev-hotfix/node-version
- dev-release/v0.1.0-4
- dev-release/v0.1.0-3
This package is auto-updated.
Last update: 2024-11-16 14:26:57 UTC
README
Contributors: alleyinteractive
Tags: alleyinteractive, wp-newsletter-builder
Stable tag: 0.3.35
Requires at least: 6.2
Tested up to: 6.4.1
Requires PHP: 8.0
License: GPL v2 or later
Interface to manage email newsletters. Creates a Custom Post Type.
Installation
You can install the package via composer:
composer require alleyinteractive/wp-newsletter-builder
Usage
Activate the plugin in WordPress and use it like so:
$plugin = WP_Newsletter_Builder\WP_Newsletter_Builder\WP_Newsletter_Builder(); $plugin->perform_magic();
Enabling an Email Provider
The plugin supports multiple email providers. To enable an email provider, add the following code as a plugin or function in your theme wp-newsletter-builder-PROVIDER.php
:
This decision was made so that only developers can switch email providers (but it may be that we want to create a settings page for this in the future.)
<?php /** * Plugin Name: PROVIDER for WP Newsletter Builder * Description: Plugin to enable PROVIDER as an email provider for WP Newsletter Builder. * Version: 0.1.0 * Author: Alley * * Text Domain: newsletter-testing * Domain Path: /languages/ * * @package newsletter-testing */ add_filter( 'wp_newsletter_builder_selected_provider', fn( $provider ) => 'WP_Newsletter_Builder\Email_Providers\PROVIDER' );
Filtering Post Types Available in the Post Picker
The plugin allows filtering of post types available in the Gutenberg post picker. The post picker appears in the wp-newsletter-builder/post
block as a single post picker and in the wp-newsletter-builder/section
block as a multiple post picker.
For example, to allow a custom podcast
post type to appear in the post picker, along with the default post
post type:
add_filter( 'wp_newsletter_builder_allowed_post_types', function( array $allowed_post_types ) { $allowed_post_types[] = 'podcast'; return $allowed_post_types; } );
Testing
Run npm run test
to run Jest tests against JavaScript files. Run
npm run test:watch
to keep the test runner open and watching for changes.
Run npm run lint
to run ESLint against all JavaScript files. Linting will also
happen when running development or production builds.
Run composer test
to run tests against PHPUnit and the PHP code in the plugin.
The entries
directory and entry points
All directories created in the entries
directory can serve as entry points and will be compiled with @wordpress/scripts into the build
directory with an accompanied index.asset.php
asset map.
Enqueuing Entry Points
You can also include an index.php
file in the entry point directory for enqueueing or registering a script. This file will then be moved to the build directory and will be auto-loaded with the load_scripts()
function in the functions.php
file. Alternatively, if a script is to be enqueued elsewhere there are helper functions in the src/assets.php
file for getting the assets.
Scaffold a block with create-block
Use the create-block
command to create custom blocks with @wordpress/create-block
and follow the prompts to generate all the block assets in the blocks/
directory.
Block registration, script creation, etc will be scaffolded from the bin/create-block/templates/block/
templates. Run npm run build
to compile and build the custom block. Blocks are enqueued using the load_scripts()
function in src/assets.php
.
Updating WP Dependencies
Update the WordPress dependency packages used in the project to their latest version.
To update @wordpress
dependencies to their latest version use the packages-update command:
npx wp-scripts packages-update
This script provides the following custom options:
--dist-tag
– allows specifying a custom dist-tag when updating npm packages. Defaults tolatest
. This is especially useful when using@wordpress/dependency-extraction-webpack-plugin
. It lets installing the npm dependencies at versions used by the given WordPress major version for local testing, etc. Example:
npx wp-scripts packages-update --dist-tag=wp-WPVERSION`
Where WPVERSION
is the version of WordPress you are targeting. The version
must include both the major and minor version (e.g., 6.1
). For example:
npx wp-scripts packages-update --dist-tag=wp-6.1`
Changelog
Please see CHANGELOG for more information on what has changed recently.
Credits
This project is actively maintained by Alley Interactive. Like what you see? Come work with us.
- [Alley Interactive](https://github.com/Alley Interactive)
- All Contributors
License
The GNU General Public License (GPL) license. Please see License File for more information.