Compare commits

..

17 Commits
0.23 ... master

Author SHA1 Message Date
abuyoyo
00ab82a35d 0.27
Some checks failed
Create Release / Create Release (push) Has been cancelled
2024-09-07 08:05:22 +03:00
abuyoyo
51cfce0071 0.27 - version bump + changelog 2024-09-07 08:04:22 +03:00
abuyoyo
416039449f composer.json - prepend-autoloader: false
Local vendor/autoload should not prepend if required locally.
Give precedence to main composer installation if available.
2024-09-07 00:44:37 +03:00
abuyoyo
e548158c15 0.26
Some checks failed
Create Release / Create Release (push) Has been cancelled
2024-09-01 08:04:08 +03:00
abuyoyo
41a42d3a2a 0.26 - version bump + changelog 2024-09-01 08:03:34 +03:00
abuyoyo
b6aca366b2 Mutation Observer replaces DOMNodeRemoved event 2024-09-01 07:48:58 +03:00
abuyoyo
7cc5b6de5a NoticeManager.bootstrap - refactor + modernize 2024-09-01 07:48:58 +03:00
abuyoyo
ca68f59a28 0.25
Some checks failed
Create Release / Create Release (push) Has been cancelled
2024-02-18 03:43:24 +02:00
abuyoyo
a3040b6c47 0.25 - version bump + changelog 2024-02-18 03:41:05 +02:00
abuyoyo
b99be56795 composer.lock + vendor/
- abuyoyo/metabox 0.8
- abuyoyo/adminmenupage 0.29
2024-02-18 03:34:30 +02:00
abuyoyo
3458b724be composer.json - update abuyoyo/adminmenupage ~0.29 2024-02-18 03:22:21 +02:00
abuyoyo
57fb24aa22 0.24
Some checks failed
Create Release / Create Release (push) Has been cancelled
2023-10-04 03:50:31 +03:00
abuyoyo
42db8f67df 0.24 - version bump + changelog 2023-10-04 02:40:21 +03:00
abuyoyo
1cd273bded composer.lock + vendor/ 2023-10-04 02:40:20 +03:00
abuyoyo
2c166a33a8 composer.json - update dependencies (PluginCore 0.27 supports plugin-update-checker v5|v4) 2023-10-04 02:40:20 +03:00
abuyoyo
1321d35bdf De-prioritize vendor/autoload.php 2023-10-04 02:40:20 +03:00
abuyoyo
7cf7b477bc PluginCore - set update_checker to true.
If Plugin-Update-Checker library (v4|v5) is available - enables updates from repo.
2023-10-04 01:29:04 +03:00
26 changed files with 702 additions and 226 deletions

View File

@ -1,5 +1,42 @@
# Notice Manager Changelog
## 0.27
Release date: Sep 7 2024
### Dependencies
- Composer config: `prepend-autoloader: false` - Give precedence to other composer installations if present.
## 0.26
Release date: Sep 1 2024
### Changed
- Use Mutation Observer instead of deprecated `DOMNodeRemoved` event.
### Added
- Add method `NoticeManager.bootstrap()` to initialize Notice manager.
## 0.25
Release date: Feb 18 2024
### Fixed
- Fix fatal error `Class "WPHelper\MetaBox" not found` due to dependency `abuyoyo/adminmenupage` < 0.29 not requiring dependency `abuyoyo/metabox`.
### Dependencies
- Library WPHelper\AdminPage (`abuyoyo/adminmenupage`) updated to 0.29. Requires `abuyoyo/metabox`.
## 0.24
Release date: Oct 4 2023
### Fixed
- Set `WPHelper\PluginCore` option `update_checker` to true. If library Plugin-Update-Checker is installed, allows updates from repo.
### Dependencies
- Library WPHelper\PluginCore (`abuyoyo/plugincore`) updated to 0.27. Supports both Plugin-Update-Checker v5 and v4.
## 0.23
### Fixed

View File

@ -2,7 +2,7 @@
"name": "abuyoyo/notice-manager",
"description": "Manage notices on WordPress admin pages. Adds 'Notices' screen-meta-link.",
"type": "wordpress-plugin",
"version": "0.23",
"version": "0.27",
"repositories": [
{
"type": "vcs",
@ -11,7 +11,10 @@
],
"require":{
"abuyoyo/screen-meta-links": "~0.13",
"abuyoyo/plugincore": "~0.26",
"abuyoyo/adminmenupage": "~0.25"
"abuyoyo/plugincore": "~0.27",
"abuyoyo/adminmenupage": "~0.29"
},
"config": {
"prepend-autoloader": false
}
}

70
composer.lock generated
View File

@ -4,22 +4,25 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
"content-hash": "a4fa2edfc5b4021a3dc78312c01fbfd0",
"content-hash": "b1a74cf1316f5dd317f70efeb60d9f4d",
"packages": [
{
"name": "abuyoyo/adminmenupage",
"version": "0.27",
"version": "0.29",
"source": {
"type": "git",
"url": "https://github.com/abuyoyo/AdminMenuPage.git",
"reference": "5ab293cbac3613a680bf2bd741214b1ca782f33b"
"reference": "4cd47d5217ca25ed17af76f5fdbab3cab3b37ef8"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/abuyoyo/AdminMenuPage/zipball/5ab293cbac3613a680bf2bd741214b1ca782f33b",
"reference": "5ab293cbac3613a680bf2bd741214b1ca782f33b",
"url": "https://api.github.com/repos/abuyoyo/AdminMenuPage/zipball/4cd47d5217ca25ed17af76f5fdbab3cab3b37ef8",
"reference": "4cd47d5217ca25ed17af76f5fdbab3cab3b37ef8",
"shasum": ""
},
"require": {
"abuyoyo/metabox": "~0.8"
},
"suggest": {
"abuyoyo/plugincore": "~0.26",
"cmb2/cmb2": "~2.9"
@ -40,27 +43,58 @@
"description": "WordPress admin menu page helper class",
"support": {
"issues": "https://github.com/abuyoyo/AdminMenuPage/issues",
"source": "https://github.com/abuyoyo/AdminMenuPage/tree/0.27"
"source": "https://github.com/abuyoyo/AdminMenuPage/tree/0.29"
},
"time": "2023-06-20T00:00:00+00:00"
"time": "2023-10-05T00:00:00+00:00"
},
{
"name": "abuyoyo/plugincore",
"version": "0.26",
"name": "abuyoyo/metabox",
"version": "0.8",
"source": {
"type": "git",
"url": "https://github.com/abuyoyo/PluginCore.git",
"reference": "77f7d5451bdff4bda6c9766847b215bdeaca96d6"
"url": "https://github.com/abuyoyo/MetaBox.git",
"reference": "98cb4c30db4c366c0d273985eb9c31ffa1cd78f9"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/abuyoyo/PluginCore/zipball/77f7d5451bdff4bda6c9766847b215bdeaca96d6",
"reference": "77f7d5451bdff4bda6c9766847b215bdeaca96d6",
"url": "https://api.github.com/repos/abuyoyo/MetaBox/zipball/98cb4c30db4c366c0d273985eb9c31ffa1cd78f9",
"reference": "98cb4c30db4c366c0d273985eb9c31ffa1cd78f9",
"shasum": ""
},
"type": "library",
"autoload": {
"psr-4": {
"WPHelper\\": ""
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"BSD-3-Clause"
],
"description": "WordPress metabox helper class",
"support": {
"issues": "https://github.com/abuyoyo/MetaBox/issues",
"source": "https://github.com/abuyoyo/MetaBox/tree/0.8"
},
"time": "2023-07-18T19:14:03+00:00"
},
{
"name": "abuyoyo/plugincore",
"version": "0.27",
"source": {
"type": "git",
"url": "https://github.com/abuyoyo/PluginCore.git",
"reference": "d730a674cbe2dc92e60ace8e25a2e0e3fdeee3e6"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/abuyoyo/PluginCore/zipball/d730a674cbe2dc92e60ace8e25a2e0e3fdeee3e6",
"reference": "d730a674cbe2dc92e60ace8e25a2e0e3fdeee3e6",
"shasum": ""
},
"suggest": {
"abuyoyo/adminmenupage": "~0.25",
"yahnis-elsts/plugin-update-checker": "~4.12"
"abuyoyo/adminmenupage": "~0.27",
"yahnis-elsts/plugin-update-checker": "~5.2"
},
"type": "library",
"autoload": {
@ -75,9 +109,9 @@
"description": "WordPress plugin core helper class",
"support": {
"issues": "https://github.com/abuyoyo/PluginCore/issues",
"source": "https://github.com/abuyoyo/PluginCore/tree/0.26"
"source": "https://github.com/abuyoyo/PluginCore/tree/0.27"
},
"time": "2022-06-09T00:00:00+00:00"
"time": "2022-10-03T00:00:00+00:00"
},
{
"name": "abuyoyo/screen-meta-links",
@ -112,7 +146,7 @@
"minimum-stability": "stable",
"stability-flags": [],
"prefer-stable": false,
"prefer-lowest": false,
"prefer-lowest": true,
"platform": [],
"platform-dev": [],
"plugin-api-version": "2.3.0"

View File

@ -2,27 +2,26 @@
* NoticeManager class/module
*
*/
var NoticeManager = (function ($, document) {
let options = window.notice_manager_options
const NoticeManager = function ($) {
let selectors_notice = [
const selectors_notice = [
"div.notice",
"div.updated",
]
let selectors_warning = [
const selectors_warning = [
"div.notice-warning",
"div.update-nag",
]
let selectors_error = [
const selectors_error = [
"div.error",
"div.notice-error",
]
let selectors_all = selectors_notice.concat(selectors_warning, selectors_error)
const selectors_all = selectors_notice.concat(selectors_warning, selectors_error)
let selectors_skip = [
const selectors_skip = [
".inline",
".below-h2",
".theme-info .notice",
@ -30,136 +29,133 @@ var NoticeManager = (function ($, document) {
]
// wait function used with autoCollapse
let wait = function (ms) {
const wait = function (ms) {
var dfd = $.Deferred()
setTimeout(dfd.resolve, ms) //callback, timeout till callback
return dfd.promise()
}
const options = window.notice_manager_options
let notices
let button
let panel
let haveClosed // set to true on first close/collect
let dismissNoticesButton
// bootstrap
// some of these need to run BEFORE document.ready - don't know why really
button = $("#meta-link-notices")
panel = $("#meta-link-notices-wrap")
haveClosed = false
dismissNoticesButton = $("#meta-link-notices-wrap button.notice-dismiss")
dismissNoticesButton.on("click", () => {
screenMeta.close(panel, button)
if (! haveClosed){
NoticeManager.collectNotices()
}
NoticeManager.addCounter()
})
//original wp focus on click function
button.on("focus.scroll-into-view", (e) => {
if (e.target.scrollIntoView) e.target.scrollIntoView(false)
})
// scroll page to top when closing notice panel
// function used to work with $(this)
// using e.target instead
// not sure if this should perhaps be e.currentTarget
button.on("click", (e) => {
if ($(e.target).hasClass("screen-meta-active")) {
if (haveClosed) {
NoticeManager.addCounter()
}
// $(window).scrollTop(true)
} else {
NoticeManager.removeCounter()
// wait (500).then(function(){ //still jumpy sometimes - but scrolls to correct position 400 ~ 600
// $(window).scrollTop(true)
// })
}
})
/**
* document.on.ready
*/
$(() => {
console.log("NoticeManager.on.ready")
console.log("options")
console.log(options)
// bootstrap notices
// get all notices that are not explicitly marked as `.inline` or `.below-h2`
// we add .update-nag.inline for WordPress Update notice
notices = $( selectors_all.join(', ') )
.not(selectors_skip.join(', '))
.add("div.update-nag")
/**
* Remove panel if there are no notices on this page
*/
if (options.screen_panel) {
NoticeManager.maybeRemoveNoticesPanel()
}
if (options.screen_panel && options.auto_collect) {
NoticeManager.collectNotices()
} else {
if (options.above_title) {
NoticeManager.moveAboveTitle()
}
}
/**
* auto-open notices panel
*/
if (button.length && ! options.distraction_free) {
panel.toggle()
button.addClass("screen-meta-active")
screenMeta.open(panel, button)
}
/**
* auto-close notices panel after short delay
* only auto-close if we have collected notices previously
* only auto-close if no error messages
*/
if (options.auto_collapse && ! options.distraction_free) {
wait(4000).then(() => {
if (haveClosed && NoticeManager.getNoticesTopPriority() != 'error') {
screenMeta.close(panel, button)
NoticeManager.addCounter()
}
})
}
if (options.distraction_free) {
NoticeManager.addCounterWhenClosed()
}
}) // end document.on.ready
// prevent jumpy scrollRestoration on reload page
// fixed below on 'beforeunload'
// if (history.scrollRestoration) {
// history.scrollRestoration = 'manual'
//}
/**
* Set history.scrollTop to prevent jump on page refresh when scrollRestoration = auto
*/
$(window).on("beforeunload", () => {
history.pushState(
{ scrollTop: document.body.scrollTop },
document.title,
document.location.pathname
)
})
let haveClosed // set to true on first close/collect
let panelObserver
return {
bootstrap: () => {
// Init selectors
button = $("#meta-link-notices")
panel = $("#meta-link-notices-wrap")
dismissNoticesButton = $("#meta-link-notices-wrap button.notice-dismiss")
// bootstrap notices
// get all notices that are not explicitly marked as `.inline` or `.below-h2`
// we add .update-nag.inline for WordPress Update notice
notices = $(selectors_all.join(', '))
.not(selectors_skip.join(', '))
.add("div.update-nag")
// Set state
haveClosed = false
dismissNoticesButton.on("click", () => {
screenMeta.close(panel, button)
if (!haveClosed) {
NoticeManager.collectNotices()
}
NoticeManager.addCounter()
})
//original wp focus on click function
button.on("focus.scroll-into-view", (e) => {
if (e.target.scrollIntoView) e.target.scrollIntoView(false)
})
// scroll page to top when closing notice panel
// function used to work with $(this)
// using e.target instead
// not sure if this should perhaps be e.currentTarget
button.on("click", (e) => {
if ($(e.target).hasClass("screen-meta-active")) {
if (haveClosed) {
NoticeManager.addCounter()
}
// $(window).scrollTop(true)
} else {
NoticeManager.removeCounter()
// wait (500).then(function(){ //still jumpy sometimes - but scrolls to correct position 400 ~ 600
// $(window).scrollTop(true)
// })
}
})
// prevent jumpy scrollRestoration on reload page
// fixed below on 'beforeunload'
// if (history.scrollRestoration) {
// history.scrollRestoration = 'manual'
//}
/**
* Set history.scrollTop to prevent jump on page refresh when scrollRestoration = auto
*/
$(window).on('beforeunload', () => history.pushState(
{ scrollTop: document.body.scrollTop },
document.title,
document.location.pathname
)
)
/**
* Remove panel if there are no notices on this page
*/
if (options.screen_panel) {
NoticeManager.maybeRemoveNoticesPanel()
}
if (options.screen_panel && options.auto_collect) {
NoticeManager.collectNotices()
} else {
if (options.above_title) {
NoticeManager.moveAboveTitle()
}
}
/**
* auto-open notices panel
*/
if (button.length && !options.distraction_free) {
panel.toggle()
button.addClass("screen-meta-active")
screenMeta.open(panel, button)
}
/**
* auto-close notices panel after short delay
* only auto-close if we have collected notices previously
* only auto-close if no error messages
*/
if (options.auto_collapse && !options.distraction_free) {
wait(4000).then(() => {
if (haveClosed && NoticeManager.getNoticesTopPriority() != 'error') {
screenMeta.close(panel, button)
NoticeManager.addCounter()
}
})
}
if (options.distraction_free) {
NoticeManager.addCounterWhenClosed()
}
},
getNotices: () => notices,
getNoticesTopPriority: () => {
@ -197,20 +193,18 @@ var NoticeManager = (function ($, document) {
* When dismissible notices are dismissed, check if any notices are left on page.
* If no notices are left - remove Notice Panel entirely
*/
$(document).on(
"DOMNodeRemoved",
"#meta-link-notices-wrap div.notice",
() => {
notices = panel
.find(selectors_all.join(", "))
.filter(":visible")
NoticeManager.maybeRemoveNoticesPanel()
}
)
panelObserver = new MutationObserver(() => {
notices = panel
.find(selectors_all.join(", "))
.filter(":visible")
NoticeManager.maybeRemoveNoticesPanel()
});
panelObserver.observe(panel.get(0), { childList: true, subtree: true }); // only run once
},
addCounter: () => {
if (!button.children('.plugin-count').length){
if (!button.children('.plugin-count').length) {
button.append(
$("<span/>").text(notices.filter(":visible").length).attr({
class: "plugin-count",
@ -223,7 +217,7 @@ var NoticeManager = (function ($, document) {
* cannot rely on filter(:visible)
*/
addCounterWhenClosed: () => {
if (!button.children('.plugin-count').length){
if (!button.children('.plugin-count').length) {
button.append(
$("<span/>").text(notices.length).attr({
class: "plugin-count",
@ -247,7 +241,7 @@ var NoticeManager = (function ($, document) {
$("#meta-link-notices-link-wrap").detach()
$("#meta-link-notices-wrap").detach()
if ($("#screen-meta-links").children().length == 0){
if ($("#screen-meta-links").children().length == 0) {
$("#screen-meta-links").detach()
}
}
@ -262,4 +256,6 @@ var NoticeManager = (function ($, document) {
notices.insertBefore(".wrap:first")
},
}
}(jQuery,document) )
}(jQuery);
jQuery(NoticeManager.bootstrap);

View File

@ -2,7 +2,7 @@
/**
* Plugin Name: Notice Manager
* Description: Manage notices on WordPress admin pages. Adds 'Notices' screen-meta-link panel to collect notices from page.
* Version: 0.23
* Version: 0.27
* Author: abuyoyo
* Author URI: https://github.com/abuyoyo/
* Plugin URI: https://github.com/abuyoyo/notice-manager
@ -10,10 +10,24 @@
*/
defined( 'ABSPATH' ) || die( 'No soup for you!' );
use WPHelper\PluginCore;
/**
* Dependencies
* Allow all other auto-loaders to fail before including our own.
*/
if (
! class_exists( 'WPHelper\PluginCore' )
||
! class_exists( 'WPHelper\AdminPage' )
||
! function_exists( 'wph_add_screen_meta_panel' )
)
{
if ( file_exists( __DIR__ . '/vendor/autoload.php' ) ){
require_once __DIR__ . '/vendor/autoload.php';
}
}
if ( file_exists( __DIR__ . '/vendor/autoload.php' ) )
require_once __DIR__ . '/vendor/autoload.php';
use WPHelper\PluginCore;
/**
* Bootstrap plugin and admin page (Tools > Notice Manager)
@ -69,12 +83,13 @@ new PluginCore(
'type' => 'checkbox',
'description' => 'Notice Panel is closed on page load. Requires auto_collect.'
],
]
]
]
]
]
]
],
],
],
],
],
'update_checker' => true, // If Plugin Update Checker library is available - allow updates/auto-updates.
],
);
require_once 'src/NoticeManager.php';

View File

@ -1,6 +1,22 @@
# Changelog
WPHelper\AdminMenuPage
## 0.29
Release date: Oct 5 2023
### Fixed
- `composer.json` - Require `abuyoyo/metabox`. WPHelper\Metabox has been a required library since 0.25.
### Dependencies
- lib: WPHelper\Metabox (`abuyoyo/metabox`) ~0.8.
## 0.28
Release date: Oct 4 2023
### Added
- Option `parent` accepts `tools` as shorthand for `tools.php`.
- Add link to Install Plugin page in "CMB2 plugin missing" template.
## 0.27
Release date: Sep 10 2023
@ -28,7 +44,7 @@ Release date: Jun 9 2023
- Fix several PHP undefined variable warnings.
### Internal
- Setting pages/wrap temlate uses WordPress Core `do_meta_boxes` to render `side` meta boxes div.
- Setting pages/wrap template uses WordPress Core `do_meta_boxes` to render `side` meta boxes div.
- Add variables to `AdminPage::options()` array.
- Multiple code refactoring and template restructuring.

View File

@ -2,9 +2,12 @@
"name": "abuyoyo/adminmenupage",
"description": "WordPress admin menu page helper class",
"type": "library",
"version": "0.27",
"time": "2023-06-20",
"version": "0.29",
"time": "2023-10-05",
"license": "BSD-3-Clause",
"require": {
"abuyoyo/metabox": "~0.8"
},
"suggest": {
"abuyoyo/plugincore": "~0.26",
"cmb2/cmb2": "~2.9"

View File

@ -348,6 +348,10 @@ class AdminPage
case 'options-general.php':
$this->parent = 'options-general.php';
break;
case 'tools':
case 'tools.php':
$this->parent = 'tools.php';
break;
default:
$this->parent = $parent;
break;

View File

@ -34,7 +34,7 @@ class SettingsPage{
*
* @var string $page
*/
protected $page;
public $page;
/**
* option_name key used in wp_options table
@ -343,7 +343,7 @@ class SettingsPage{
$new_options[$id] = sanitize_email( $option );
break;
case 'url':
$new_options[$id] = sanitize_url( $option );
$new_options[$id] = esc_url_raw( $option );
break;
default:
break;

View File

@ -7,8 +7,9 @@
?>
<form method="post" action="options.php">
<?php
/** @var WPHelper\AdminPage $this */
settings_fields( $this->settings_page->option_group );// Print hidden setting fields
do_settings_sections( $this->get_slug() );// Print title, info callback and form-table
do_settings_sections( $this->settings_page->page );// Print title, info callback and form-table
submit_button();
?>
</form>

View File

@ -32,5 +32,6 @@
* @since 0.26
*/
if ( defined('WPH_DEBUG') && WPH_DEBUG ) {
/** @var WPHelper\PluginInfoMetaBox $this */
$this->wph_debug();
}

View File

@ -4,6 +4,6 @@
<div class="card">
<h3>CMB2 Plugin Missing</h3>
<p>CMB2 plugin is required to display this page.
<br>Download and activate CMB2 plugin.
<br>Please install and activate <a href="<?php echo admin_url('plugin-install.php?s=cmb2&tab=search') ?>">CMB2 plugin</a>.
</div>
</div>

View File

@ -0,0 +1,38 @@
# Create Github Release
# v1.0
# Create Github release on tag push
# - Use tag name as release title
# - Use CHANGELOG.md log entry as body
on:
push:
# Sequence of patterns matched against refs/tags
tags:
- '*' # Match any tag
name: Create Release
jobs:
build:
name: Create Release
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Get Changelog Entry
id: changelog_reader
uses: mindsers/changelog-reader-action@v1.1.0
with:
version: ${{ github.ref }}
path: ./CHANGELOG.md
- name: Create Release
id: create_release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ github.ref }}
release_name: ${{ github.ref }}
body: ${{ steps.changelog_reader.outputs.log_entry }} # This pulls from the GET CHANGELOG ENTRY step above, referencing it's ID to get its outputs object, which include a `log_entry`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
draft: false
prerelease: false

26
vendor/abuyoyo/metabox/CHANGELOG.md vendored Normal file
View File

@ -0,0 +1,26 @@
# Changelog
WPHelper\MetaBox
## 0.8
### Fixed
- Fix `Metabox::render()` callback arguments. Callback is passed `$data_object` and `$box`.
## 0.7
### Fixed
- Validate `is_callable(render_cb)` before `call_user_func` call.
## 0.6
### Added
- Accept callable `render_cb` as well as readable `render_tpl` as render template.
## 0.5
### Added
- Basic Metabox API.

220
vendor/abuyoyo/metabox/MetaBox.php vendored Normal file
View File

@ -0,0 +1,220 @@
<?php
namespace WPHelper;
use function wp_parse_args;
use function add_action;
use function add_meta_box;
/**
* MetaBox
*
* Object-Oriented WordPress meta box creator.
*
* @author abuyoyo
* @version 0.8
*/
class MetaBox
{
/**
* Screen context where the meta box should display.
*
* @var string
*/
private $context;
/**
* The ID of the meta box.
*
* @var string
*/
private $id;
/**
* The display priority of the meta box.
*
* @var string
*/
private $priority;
/**
* Screens where this meta box will appear.
*
* @var string[]
*/
private $screens;
/**
* Path to the template used to display the content of the meta box.
*
* @var string filename
*/
private $render_tpl;
/**
* Path to the template used to display the content of the meta box.
*
* @var callable
*/
private $render_cb;
/**
* The title of the meta box.
*
* @var string
*/
private $title;
/**
* Hook where this meta box will be added.
*
* @var string
*/
private $hook;
/**
* Array of $args to be sent to callback function's second parameter
*
* @var array
*/
private $args;
/**
* Constructor.
*
* @param string $id
* @param string $template
* @param string $title
* @param string $context
* @param string $priority
* @param string[] $screens
*/
public function __construct($options)
{
// should throw error if required fields (id, title) not given
// template is actually optional
$defaults = [
'context' => 'advanced',
'priority' => 'default',
'screens' => [],
'args' => null,
'hook' => 'add_meta_boxes',
];
$options = wp_parse_args( $options, $defaults );
extract($options);
$this->context = $context;
$this->id = $id;
$this->priority = $priority;
$this->screens = $screens;
$this->render_tpl = isset( $template ) ? rtrim( $template, '/' ) : '';
$this->render_cb = $render ?? '';
$this->title = $title;
$this->hook = $hook;
$this->args = $args;
}
/**
* Add metabox at given hook.
*
* @return void
*/
public function add()
{
add_action( $this->hook, [ $this, 'wp_add_metabox' ] );
}
public function wp_add_metabox(){
add_meta_box(
$this->id,
$this->title,
[ $this, 'render' ], // $this->render_tpl | $this->render_cb
$this->screens,
$this->context,
$this->priority,
$this->args
);
}
/**
* Get the callable that will render the content of the meta box.
*
* @return callable
*/
public function get_callback()
{
return [ $this, 'render' ];
}
/**
* Get the screen context where the meta box should display.
*
* @return string
*/
public function get_context()
{
return $this->context;
}
/**
* Get the ID of the meta box.
*
* @return string
*/
public function get_id()
{
return $this->id;
}
/**
* Get the display priority of the meta box.
*
* @return string
*/
public function get_priority()
{
return $this->priority;
}
/**
* Get the screen(s) where the meta box will appear.
*
* @return array|string|WP_Screen
*/
public function get_screens()
{
return $this->screens;
}
/**
* Get the title of the meta box.
*
* @return string
*/
public function get_title()
{
return $this->title;
}
/**
* Render the content of the meta box using a PHP template.
* Callback passed to to add_meta_box()
*
* @see do_meta_boxes()
*
* @param mixed $data_object Object that's the focus of the current screen. eg. WP_Post|WP_Comment
* @param array $box Meta-box data [id, title, callback, args] (@see global $wp_meta_boxes)
*/
public function render( $data_object, $box )
{
if ( ! is_readable( $this->render_tpl ) && ! is_callable( $this->render_cb ) ){
return;
}
if ( is_callable( $this->render_cb ) ){
call_user_func( $this->render_cb, $data_object, $box );
} else if ( isset( $this->render_tpl ) ){
include $this->render_tpl;
}
}
}

1
vendor/abuyoyo/metabox/README.md vendored Normal file
View File

@ -0,0 +1 @@
# WPHelper\MetaBox

12
vendor/abuyoyo/metabox/composer.json vendored Normal file
View File

@ -0,0 +1,12 @@
{
"name": "abuyoyo/metabox",
"description": "WordPress metabox helper class",
"type": "library",
"version": "0.8",
"license": "BSD-3-Clause",
"autoload": {
"psr-4": {
"WPHelper\\" : ""
}
}
}

View File

@ -1,5 +1,11 @@
# WPHelper\PluginCore Changelog
## 0.27
Release Date: Oct 3, 2023
### Added
- Support Plugin Update Checker v5 as well as v4. Create class alias `WPHelper\PucFactory` for `YahnisElsts\PluginUpdateChecker\v5\PucFactory` if available. Fallback to `Puc_v4_Factory`.
## 0.26
Release Date: Jun 9, 2023

View File

@ -1,14 +1,12 @@
<?php
namespace WPHelper;
use Puc_v4_Factory as PucFactory;
defined( 'ABSPATH' ) || die( 'No soup for you!' );
if ( ! class_exists( 'WPHelper/PluginCore' ) ):
// require dependency get_plugin_data()
if( ! function_exists('get_plugin_data') ) {
if( ! function_exists( 'get_plugin_data' ) ) {
require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
}
@ -19,7 +17,7 @@ if( ! function_exists('get_plugin_data') ) {
*
* (@see README.md)
*
* @version 0.26
* @version 0.27
*/
class PluginCore {
@ -581,12 +579,30 @@ class PluginCore {
*
* @since 0.9 init_update_checker()
* @since 0.21 build_update_checker()
* @since 0.27 Create class alias WPHelper\PucFactory - support plugin-update-checker v4 & v5
*
* @uses PucFactory::buildUpdateChecker
*/
private function build_update_checker() {
if ( ! class_exists( PucFactory::class ) )
/**
* Create class alias WPHelper\PucFactory
* Support YahnisElsts\PluginUpdateChecker v4 | v5
*
* @since 0.27
*/
if ( ! class_exists( 'WPHelper\PucFactory' ) ) {
if ( class_exists( 'YahnisElsts\PluginUpdateChecker\v5\PucFactory' ) ) {
$actual_puc = 'YahnisElsts\PluginUpdateChecker\v5\PucFactory';
} else if ( class_exists( 'Puc_v4_Factory' ) ) {
$actual_puc = 'Puc_v4_Factory';
}
if ( ! empty( $actual_puc ) ) {
class_alias( $actual_puc, 'WPHelper\PucFactory' );
}
}
if ( ! class_exists( 'WPHelper\PucFactory' ) )
return;
$update_checker = PucFactory::buildUpdateChecker(

View File

@ -2,12 +2,12 @@
"name": "abuyoyo/plugincore",
"description": "WordPress plugin core helper class",
"type": "library",
"version": "0.26",
"time": "2022-06-09",
"version": "0.27",
"time": "2022-10-03",
"license": "BSD-3-Clause",
"suggest": {
"yahnis-elsts/plugin-update-checker": "~4.12",
"abuyoyo/adminmenupage": "~0.25"
"yahnis-elsts/plugin-update-checker": "~5.2",
"abuyoyo/adminmenupage": "~0.27"
},
"autoload": {
"psr-4": {

2
vendor/autoload.php vendored
View File

@ -22,4 +22,4 @@ if (PHP_VERSION_ID < 50600) {
require_once __DIR__ . '/composer/autoload_real.php';
return ComposerAutoloaderInit99e41faf4c8cd1b54927a50ca0e7ee5c::getLoader();
return ComposerAutoloaderInita13a895834453aad32a897cc456c73ff::getLoader();

View File

@ -6,5 +6,5 @@ $vendorDir = dirname(__DIR__);
$baseDir = dirname($vendorDir);
return array(
'WPHelper\\' => array($vendorDir . '/abuyoyo/adminmenupage/src', $vendorDir . '/abuyoyo/plugincore'),
'WPHelper\\' => array($vendorDir . '/abuyoyo/adminmenupage/src', $vendorDir . '/abuyoyo/metabox', $vendorDir . '/abuyoyo/plugincore'),
);

View File

@ -2,7 +2,7 @@
// autoload_real.php @generated by Composer
class ComposerAutoloaderInit99e41faf4c8cd1b54927a50ca0e7ee5c
class ComposerAutoloaderInita13a895834453aad32a897cc456c73ff
{
private static $loader;
@ -22,16 +22,16 @@ class ComposerAutoloaderInit99e41faf4c8cd1b54927a50ca0e7ee5c
return self::$loader;
}
spl_autoload_register(array('ComposerAutoloaderInit99e41faf4c8cd1b54927a50ca0e7ee5c', 'loadClassLoader'), true, true);
spl_autoload_register(array('ComposerAutoloaderInita13a895834453aad32a897cc456c73ff', 'loadClassLoader'), true, true);
self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(__DIR__));
spl_autoload_unregister(array('ComposerAutoloaderInit99e41faf4c8cd1b54927a50ca0e7ee5c', 'loadClassLoader'));
spl_autoload_unregister(array('ComposerAutoloaderInita13a895834453aad32a897cc456c73ff', 'loadClassLoader'));
require __DIR__ . '/autoload_static.php';
call_user_func(\Composer\Autoload\ComposerStaticInit99e41faf4c8cd1b54927a50ca0e7ee5c::getInitializer($loader));
call_user_func(\Composer\Autoload\ComposerStaticInita13a895834453aad32a897cc456c73ff::getInitializer($loader));
$loader->register(true);
$filesToLoad = \Composer\Autoload\ComposerStaticInit99e41faf4c8cd1b54927a50ca0e7ee5c::$files;
$filesToLoad = \Composer\Autoload\ComposerStaticInita13a895834453aad32a897cc456c73ff::$files;
$requireFile = \Closure::bind(static function ($fileIdentifier, $file) {
if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
$GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;

View File

@ -4,7 +4,7 @@
namespace Composer\Autoload;
class ComposerStaticInit99e41faf4c8cd1b54927a50ca0e7ee5c
class ComposerStaticInita13a895834453aad32a897cc456c73ff
{
public static $files = array (
'8653524d908cf23a56335c6d210d6627' => __DIR__ . '/..' . '/abuyoyo/adminmenupage/wph_admin_page.php',
@ -22,7 +22,8 @@ class ComposerStaticInit99e41faf4c8cd1b54927a50ca0e7ee5c
'WPHelper\\' =>
array (
0 => __DIR__ . '/..' . '/abuyoyo/adminmenupage/src',
1 => __DIR__ . '/..' . '/abuyoyo/plugincore',
1 => __DIR__ . '/..' . '/abuyoyo/metabox',
2 => __DIR__ . '/..' . '/abuyoyo/plugincore',
),
);
@ -33,9 +34,9 @@ class ComposerStaticInit99e41faf4c8cd1b54927a50ca0e7ee5c
public static function getInitializer(ClassLoader $loader)
{
return \Closure::bind(function () use ($loader) {
$loader->prefixLengthsPsr4 = ComposerStaticInit99e41faf4c8cd1b54927a50ca0e7ee5c::$prefixLengthsPsr4;
$loader->prefixDirsPsr4 = ComposerStaticInit99e41faf4c8cd1b54927a50ca0e7ee5c::$prefixDirsPsr4;
$loader->classMap = ComposerStaticInit99e41faf4c8cd1b54927a50ca0e7ee5c::$classMap;
$loader->prefixLengthsPsr4 = ComposerStaticInita13a895834453aad32a897cc456c73ff::$prefixLengthsPsr4;
$loader->prefixDirsPsr4 = ComposerStaticInita13a895834453aad32a897cc456c73ff::$prefixDirsPsr4;
$loader->classMap = ComposerStaticInita13a895834453aad32a897cc456c73ff::$classMap;
}, null, ClassLoader::class);
}

View File

@ -2,26 +2,29 @@
"packages": [
{
"name": "abuyoyo/adminmenupage",
"version": "0.27",
"version_normalized": "0.27.0.0",
"version": "0.29",
"version_normalized": "0.29.0.0",
"source": {
"type": "git",
"url": "https://github.com/abuyoyo/AdminMenuPage.git",
"reference": "5ab293cbac3613a680bf2bd741214b1ca782f33b"
"reference": "4cd47d5217ca25ed17af76f5fdbab3cab3b37ef8"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/abuyoyo/AdminMenuPage/zipball/5ab293cbac3613a680bf2bd741214b1ca782f33b",
"reference": "5ab293cbac3613a680bf2bd741214b1ca782f33b",
"url": "https://api.github.com/repos/abuyoyo/AdminMenuPage/zipball/4cd47d5217ca25ed17af76f5fdbab3cab3b37ef8",
"reference": "4cd47d5217ca25ed17af76f5fdbab3cab3b37ef8",
"shasum": ""
},
"require": {
"abuyoyo/metabox": "~0.8"
},
"suggest": {
"abuyoyo/plugincore": "~0.26",
"cmb2/cmb2": "~2.9"
},
"time": "2023-06-20T00:00:00+00:00",
"time": "2023-10-05T00:00:00+00:00",
"type": "library",
"installation-source": "source",
"installation-source": "dist",
"autoload": {
"files": [
"wph_admin_page.php"
@ -37,30 +40,64 @@
"description": "WordPress admin menu page helper class",
"support": {
"issues": "https://github.com/abuyoyo/AdminMenuPage/issues",
"source": "https://github.com/abuyoyo/AdminMenuPage/tree/0.27"
"source": "https://github.com/abuyoyo/AdminMenuPage/tree/0.29"
},
"install-path": "../abuyoyo/adminmenupage"
},
{
"name": "abuyoyo/plugincore",
"version": "0.26",
"version_normalized": "0.26.0.0",
"name": "abuyoyo/metabox",
"version": "0.8",
"version_normalized": "0.8.0.0",
"source": {
"type": "git",
"url": "https://github.com/abuyoyo/PluginCore.git",
"reference": "77f7d5451bdff4bda6c9766847b215bdeaca96d6"
"url": "https://github.com/abuyoyo/MetaBox.git",
"reference": "98cb4c30db4c366c0d273985eb9c31ffa1cd78f9"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/abuyoyo/PluginCore/zipball/77f7d5451bdff4bda6c9766847b215bdeaca96d6",
"reference": "77f7d5451bdff4bda6c9766847b215bdeaca96d6",
"url": "https://api.github.com/repos/abuyoyo/MetaBox/zipball/98cb4c30db4c366c0d273985eb9c31ffa1cd78f9",
"reference": "98cb4c30db4c366c0d273985eb9c31ffa1cd78f9",
"shasum": ""
},
"time": "2023-07-18T19:14:03+00:00",
"type": "library",
"installation-source": "dist",
"autoload": {
"psr-4": {
"WPHelper\\": ""
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"BSD-3-Clause"
],
"description": "WordPress metabox helper class",
"support": {
"issues": "https://github.com/abuyoyo/MetaBox/issues",
"source": "https://github.com/abuyoyo/MetaBox/tree/0.8"
},
"install-path": "../abuyoyo/metabox"
},
{
"name": "abuyoyo/plugincore",
"version": "0.27",
"version_normalized": "0.27.0.0",
"source": {
"type": "git",
"url": "https://github.com/abuyoyo/PluginCore.git",
"reference": "d730a674cbe2dc92e60ace8e25a2e0e3fdeee3e6"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/abuyoyo/PluginCore/zipball/d730a674cbe2dc92e60ace8e25a2e0e3fdeee3e6",
"reference": "d730a674cbe2dc92e60ace8e25a2e0e3fdeee3e6",
"shasum": ""
},
"suggest": {
"abuyoyo/adminmenupage": "~0.25",
"yahnis-elsts/plugin-update-checker": "~4.12"
"abuyoyo/adminmenupage": "~0.27",
"yahnis-elsts/plugin-update-checker": "~5.2"
},
"time": "2022-06-09T00:00:00+00:00",
"time": "2022-10-03T00:00:00+00:00",
"type": "library",
"installation-source": "dist",
"autoload": {
@ -75,7 +112,7 @@
"description": "WordPress plugin core helper class",
"support": {
"issues": "https://github.com/abuyoyo/PluginCore/issues",
"source": "https://github.com/abuyoyo/PluginCore/tree/0.26"
"source": "https://github.com/abuyoyo/PluginCore/tree/0.27"
},
"install-path": "../abuyoyo/plugincore"
},

View File

@ -1,8 +1,8 @@
<?php return array(
'root' => array(
'name' => 'abuyoyo/notice-manager',
'pretty_version' => '0.23',
'version' => '0.23.0.0',
'pretty_version' => '0.25',
'version' => '0.25.0.0',
'reference' => NULL,
'type' => 'wordpress-plugin',
'install_path' => __DIR__ . '/../../',
@ -11,17 +11,26 @@
),
'versions' => array(
'abuyoyo/adminmenupage' => array(
'pretty_version' => '0.27',
'version' => '0.27.0.0',
'reference' => '5ab293cbac3613a680bf2bd741214b1ca782f33b',
'pretty_version' => '0.29',
'version' => '0.29.0.0',
'reference' => '4cd47d5217ca25ed17af76f5fdbab3cab3b37ef8',
'type' => 'library',
'install_path' => __DIR__ . '/../abuyoyo/adminmenupage',
'aliases' => array(),
'dev_requirement' => false,
),
'abuyoyo/metabox' => array(
'pretty_version' => '0.8',
'version' => '0.8.0.0',
'reference' => '98cb4c30db4c366c0d273985eb9c31ffa1cd78f9',
'type' => 'library',
'install_path' => __DIR__ . '/../abuyoyo/metabox',
'aliases' => array(),
'dev_requirement' => false,
),
'abuyoyo/notice-manager' => array(
'pretty_version' => '0.23',
'version' => '0.23.0.0',
'pretty_version' => '0.25',
'version' => '0.25.0.0',
'reference' => NULL,
'type' => 'wordpress-plugin',
'install_path' => __DIR__ . '/../../',
@ -29,9 +38,9 @@
'dev_requirement' => false,
),
'abuyoyo/plugincore' => array(
'pretty_version' => '0.26',
'version' => '0.26.0.0',
'reference' => '77f7d5451bdff4bda6c9766847b215bdeaca96d6',
'pretty_version' => '0.27',
'version' => '0.27.0.0',
'reference' => 'd730a674cbe2dc92e60ace8e25a2e0e3fdeee3e6',
'type' => 'library',
'install_path' => __DIR__ . '/../abuyoyo/plugincore',
'aliases' => array(),