[],
'center' => [],
'bottom' => [],
];
/**
* Returns class instance.
*
* @since 1.0.0
*
* @return AdminMenu
*/
public static function get_instance() {
if ( is_null( self::$_instance ) ) {
self::$_instance = new self();
}
return self::$_instance;
}
/**
* Initializes the class.
*
* @since 1.0.0
*
* @return void
*/
public function init() {
static $initialized;
if ( $initialized ) {
return;
}
add_action( 'admin_menu', [ $this, 'add_admin_menu' ], 100 );
add_action( 'network_admin_menu', [ $this, 'add_admin_menu' ], 100 );
$initialized = true;
}
/**
* Determines whether the GravityKit menu should be initialized.
*
* @since 1.2.20
*
* @return bool
*/
public static function should_initialize() {
$should_initialize = false;
foreach (Core::get_instance()->get_registered_plugins() as $plugin) {
if ( ! ( $plugin['no_admin_menu'] ?? false ) ) {
$should_initialize = true;
break;
}
}
/**
* Controls whether the GravityKit top-level menu should be initialized.
*
* @filter `gk/foundation/admin-menu/initialize`
*
* @since 1.2.20
*
* @param bool $should_initialize
*/
return apply_filters( 'gk/foundation/admin-menu/initialize', $should_initialize );
}
/**
* Configures GravityKit top-level menu and submenu items in WP admin.
*
* @since 1.0.0
*
* @global array $menu
* @global array $submenu
*
* @return void
*/
public function add_admin_menu() {
global $menu, $submenu;
if ( ! self::should_initialize() ) {
return;
}
// Make sure we're not adding a duplicate top-level menu.
if ( strpos( wp_json_encode( $menu ?: [] ) ?: '', self::WP_ADMIN_MENU_SLUG ) !== false ) {
return;
}
$_get_divider = function () {
// Divider is added to the menu title; because WP wraps it in , we need to first close the tag, then add the divider.
return '
';
};
$total_badge_count = 0;
$submenus = self::get_submenus();
$filtered_submenus = [];
$user_first_met_capability = false;
// Filter submenus by removing those for which the user doesn't have the required capability.
foreach ( $submenus as $submenu_data ) {
if ( empty( $submenu_data ) ) {
continue;
}
foreach ( array_values( $submenu_data ) as $index => $submenu_item ) {
if ( ! current_user_can( $submenu_item['capability'] ) ) {
continue;
} elseif ( ! $user_first_met_capability ) {
$user_first_met_capability = $submenu_item['capability'];
}
/**
* Displays counter next to the submenu title.
*
* @filter `gk/foundation/admin-menu/submenu/{$submenu_id}/counter`
*
* @since 1.0.0
*
* @param int $badge_count
*/
$badge_count = (int) apply_filters( "gk/foundation/admin-menu/submenu/{$submenu_item['id']}/counter", 0 );
if ( Arr::get( $submenu, 'hide' ) ) {
$badge_count = 0;
}
if ( $badge_count > 0 ) {
$total_badge_count += $badge_count;
}
$submenu_item_id = Arr::get( $submenu_item, 'id' );
$filtered_submenu = [
'id' => $submenu_item_id,
'slug' => self::WP_ADMIN_MENU_SLUG,
'page_title' => Arr::get( $submenu_item, 'page_title' ),
'menu_title' => Arr::get( $submenu_item, 'menu_title' ) . $this->get_badge_counter_markup( $submenu_item_id, $badge_count ),
'capability' => Arr::get( $submenu_item, 'capability' ),
'callback' => Arr::get( $submenu_item, 'callback' ),
'hide' => Arr::get( $submenu_item, 'hide' ),
'hide_admin_notices' => Arr::get( $submenu_item, 'hide_admin_notices' ),
];
if ( ( count( $submenu_data ) - 1 ) === $index ) {
$filtered_submenu['divider'] = $_get_divider();
}
$filtered_submenus[] = $filtered_submenu;
}
}
if ( empty( $filtered_submenus ) ) {
return;
}
// Add top-level menu.
$page_title = esc_html__( 'GravityKit', 'gk-gravityexport' );
$menu_title = esc_html__( 'GravityKit', 'gk-gravityexport' );
$menu_temp_position = (float) base_convert( substr( md5( self::WP_ADMIN_MENU_SLUG ), -4 ), 16, 10 ) * 0.00001; // Taken from WP's add_menu_page() code.
$gk_settings = SettingsFramework::get_instance()->get_plugin_settings( Core::ID );
$saved_menu_position = self::get_menu_position_by_id( $gk_settings['top_level_menu_position'] ?? '' );
// If saved menu position doesn't exist, fall back to Media (or GF position if GF is active).
if ( null === $saved_menu_position ) {
$saved_menu_position = class_exists( 'GFForms' ) ? apply_filters( 'gform_menu_position', '16.9' ) : self::get_menu_position_by_id( 'upload.php' );
}
/**
* Controls the position after which the top-level GravityKit admin menu will be added.
*
* @filter gk/foundation/admin-menu/position
*
* @since 1.0.0
*
* @param int|string|null $menu_position Default: position of the Gravity Forms menu (16.9) or Media.
*/
$menu_position = apply_filters(
'gk/foundation/admin-menu/position',
$saved_menu_position
);
add_menu_page(
$page_title,
$menu_title,
$user_first_met_capability, // Use the first submenu capability that the user has met to display the main GravityKit menu.
self::WP_ADMIN_MENU_SLUG,
function() {},
'data:image/svg+xml;base64,' . base64_encode( '' ), // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
$menu_temp_position
);
$menu_item = $menu[ (string) $menu_temp_position ];
unset( $menu[ (string) $menu_temp_position ] );
$menu = $this->insert_menu_item_after_position( $menu, $menu_item, $menu_position ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
/**
* Displays counter next to the top-menu title.
*
* @filter `gk/foundation/admin-menu/counter`
*
* @since 1.0.0
*
* @param int $total_badge_count
*/
$total_badge_count = (int) apply_filters( 'gk/foundation/admin-menu/counter', $total_badge_count );
foreach ( $menu as &$menu_item ) {
if ( self::WP_ADMIN_MENU_SLUG === $menu_item[2] ) {
$menu_item[0] .= $this->get_badge_counter_markup( self::WP_ADMIN_MENU_SLUG, $total_badge_count );
}
}
$top_level_menu_action = SettingsFramework::get_instance()->get_plugin_setting( Core::ID, 'top_level_menu_action', 'submenu' );
$top_level_menu_action_submenu = Arr::first(
$filtered_submenus,
function ( $submenu ) use ( $top_level_menu_action ) {
return $submenu['id'] === $top_level_menu_action;
}
);
if ( $top_level_menu_action_submenu && Arr::get( $filtered_submenus, '0.id' ) !== $top_level_menu_action ) {
// Add and hide a first submenu item that will be used as an action for the top-level menu GravityKit menu.
// An alternative is to use the `parent_file` filter, but that would still show the first submenu item's ID in the URL.
add_submenu_page(
self::WP_ADMIN_MENU_SLUG,
'',
'',
$user_first_met_capability,
$top_level_menu_action
);
add_filter(
'gk/foundation/inline-styles',
function ( $styles ) {
$styles[] = [
'style' => '#toplevel_page_' . self::WP_ADMIN_MENU_SLUG . ' ul.wp-submenu li:nth-child(2) {
display: none;
}',
];
return $styles;
}
);
// When the user hovers over the top-level menu item, replace the menu title with the first submenu item's title.
// phpcs:disable PHPCompatibility.Syntax.NewFlexibleHeredocNowdoc.ClosingMarkerNoNewLine, WordPress.Arrays.CommaAfterArrayItem.NoComma
add_filter(
'gk/foundation/inline-scripts',
function ( $styles ) use ( $top_level_menu_action ) {
$styles[] = [
'script' => << {
const menuLinkEl = document.querySelector( 'a.toplevel_page__gk_admin_menu' );
const menuNameEl = menuLinkEl.querySelector( 'div.wp-menu-name' );
const menuActionEl = document.querySelector( '#{$top_level_menu_action}-badge' )?.parentNode;
if ( !menuLinkEl || !menuNameEl || !menuActionEl ) {
return;
}
menuNameEl.dataset.originalContent = menuNameEl.innerHTML;
const restoreOriginalContent = () => {
menuNameEl.innerHTML = menuNameEl.dataset.originalContent;
};
const showMenuActionContent = () => {
menuNameEl.innerHTML = menuActionEl.innerHTML;
};
menuLinkEl.addEventListener( 'mouseover', showMenuActionContent );
menuLinkEl.addEventListener( 'mouseout', restoreOriginalContent );
menuLinkEl.addEventListener( 'focus', showMenuActionContent );
menuLinkEl.addEventListener( 'blur', restoreOriginalContent );
} );
JS
,
];
return $styles;
}
);
} // phpcs:enable PHPCompatibility.Syntax.NewFlexibleHeredocNowdoc.ClosingMarkerNoNewLine, WordPress.Arrays.CommaAfterArrayItem.NoComma
// Add submenus.
foreach ( $filtered_submenus as $index => $filtered_submenu ) {
add_submenu_page(
$filtered_submenu['slug'],
$filtered_submenu['page_title'],
$filtered_submenu['menu_title'],
$filtered_submenu['capability'],
$filtered_submenu['id'],
$filtered_submenu['callback']
);
if ( isset( $filtered_submenu['hide_admin_notices'] ) ) {
add_action(
'in_admin_header',
function () use ( $filtered_submenu ) {
if ( Arr::get( $_REQUEST, 'page' ) !== $filtered_submenu['id'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
return;
}
remove_all_actions( 'user_admin_notices' );
remove_all_actions( 'admin_notices' );
},
999
);
}
// Add divider unless it's the last submenu item that we've added.
if ( ! isset( $filtered_submenu['divider'] ) || ( count( $filtered_submenus ) - 1 ) === $index ) {
continue;
}
$added_submenu_to_update = array_pop( $submenu[ self::WP_ADMIN_MENU_SLUG ] );
$added_submenu_to_update[0] .= $filtered_submenu['divider'];
$submenu[ self::WP_ADMIN_MENU_SLUG ][] = $added_submenu_to_update; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
}
// On a multisite the first submenu item equals the top-level menu.
// Let's indiscriminately remove all submenu items that have the top-level menu's slug.
foreach ( $submenu[ self::WP_ADMIN_MENU_SLUG ] as $key => $submenu_item ) {
if ( self::WP_ADMIN_MENU_SLUG === $submenu_item[2] ) {
unset( $submenu[ self::WP_ADMIN_MENU_SLUG ][ $key ] );
}
}
add_filter(
'gk/foundation/inline-styles',
function ( $styles ) use ( $filtered_submenus ) {
// Top-level menu item SVG icon style.
$styles[] = [
'style' => '#toplevel_page_' . self::WP_ADMIN_MENU_SLUG . ' div.wp-menu-image.svg { background-size: 1.5em auto; }',
];
// Styles for submenus that should be hidden.
$hide_styles = [];
foreach ( $filtered_submenus as $submenu ) {
if ( $submenu['hide'] ) {
$hide_styles[] = '#toplevel_page_' . self::WP_ADMIN_MENU_SLUG . ' ul.wp-submenu li a[href*="' . $submenu['id'] . '"]';
}
}
if ( empty( $hide_styles ) ) {
return $styles;
}
$styles[] = [ 'style' => join( ',', $hide_styles ) . ' { display: none !important; }' ];
return $styles;
}
);
}
/**
* Adds a submenu to the GravityKit top-level menu in WP admin.
*
* @since 1.0.0
*
* @param array $submenu The submenu data.
* @param string $position The position of the submenu. Default: 'top'.
*
* @return void
*/
public static function add_submenu_item( $submenu, $position = 'top' ) {
if ( ! isset( $submenu['id'] ) ) {
return;
}
$submenus = self::get_submenus();
$submenus[ $position ] = Arr::get( $submenus, $position, [] );
if ( ! isset( $submenu['order'] ) ) {
$order = array_column( $submenus[ $position ], 'order' );
if ( empty( $order ) ) {
$submenu['order'] = 1;
} else {
$submenu['order'] = max( $order ) + 100;
}
}
$submenus[ $position ][ $submenu['id'] ] = $submenu;
$order = array_column( $submenus[ $position ], 'order' );
array_multisort( $submenus[ $position ], SORT_NUMERIC, $order );
self::$_submenus = $submenus;
}
/**
* Returns submenus optionally modified by a filter.
*
* @since 1.0.0
*
* @return array
*/
public static function get_submenus() {
/**
* Modifies the submenus object.
*
* @filter `gk/foundation/admin-menu/submenus`
*
* @since 1.0.0
*
* @param array $submenus Submenus.
*/
return apply_filters( 'gk/foundation/admin-menu/submenus', self::$_submenus );
}
/**
* Removes a submenu from the GravityKit top-level menu in WP admin and if the top-level menu is empty, removes it as well.
*
* @since 1.0.0
*
* @global array $submenu
*
* @param string $id The submenu ID.
*
* @return void
*/
public static function remove_submenu_item( $id ) {
global $submenu;
if ( ! isset( $submenu[ self::WP_ADMIN_MENU_SLUG ] ) ) {
return;
}
foreach ( $submenu[ self::WP_ADMIN_MENU_SLUG ] as $index => $submenu_item ) {
if ( $submenu_item[2] === $id ) {
unset( $submenu[ self::WP_ADMIN_MENU_SLUG ][ $index ] );
}
}
if ( ! empty( $submenu[ self::WP_ADMIN_MENU_SLUG ] ) ) {
return;
}
self::remove_admin_menu();
}
/**
* Removes the GravityKit top-level menu from WP admin.
*
* @since 1.0.0
*
* @global array $menu
*
* @return void
*/
public static function remove_admin_menu() {
global $menu;
foreach ( $menu as $index => $menu_item ) {
if ( self::WP_ADMIN_MENU_SLUG === $menu_item[2] ) {
unset( $menu[ $index ] );
}
}
}
/**
* Returns the markup for the badge counter.
*
* @since 1.0.0
*
* @param string $menu_id Menu ID.
* @param int|string $badge_count Badge count.
*
* @return string
*/
public function get_badge_counter_markup( $menu_id, $badge_count ) {
$badge_count = (int) $badge_count;
return '';
}
/**
* Returns WP admin menu items sorted alphabetically.
*
* @since 1.2.14
*
* @return array
*/
public static function get_menus() {
global $menu;
$menu_items = [];
if ( empty( $menu ) ) {
return $menu_items;
}
foreach ( $menu as $position => $item ) {
if ( empty( $item[0] ) || strpos( $item[2], self::WP_ADMIN_MENU_SLUG ) !== false ) {
continue;
}
$menu_items[] = [
'id' => $item[2],
'title' => preg_match( '/^(.*?)(?=<(?:a|b|code|div|em|h[1-6]|i|p|span|ul))/i', $item[0], $matches ) ? trim( $matches[1] ) : $item[0], // Titles can contain HTML markup with update count/etc., so this is a crude way of removing everything up to first most probable tag.
'title_original' => $item[0],
'position' => $position,
];
}
usort(
$menu_items,
function ( $a, $b ) {
return strcasecmp( $a['title'], $b['title'] );
}
);
return $menu_items;
}
/**
* Returns the position of a WP admin menu item by its ID.
*
* @since 1.2.14
*
* @param string $id The menu item ID.
*
* @return int|string|null
*/
public static function get_menu_position_by_id( $id ) {
global $menu;
foreach ( $menu as $position => $menu_item ) {
if ( ( $menu_item[2] ?? '' ) === $id ) {
return $position;
}
}
return null;
}
/**
* Inserts a new menu item after a specified position:
* - If the position doesn't exist, the new menu item is added at the end.
* - If the position is an integer, a new float is created.
* - If the position is a float, the new menu item is added after it and subsequent floats are renumbered.
*
* The renumbering logic is not aggressive and only renumbers floats that are directly after the specified position, or creates a new float if the position is an integer.
*
* @since 1.2.14
*
* @param array $menus The menu items.
* @param mixed $new_menu The new menu item.
* @param int|string $after_position The position after which the new menu item should be inserted.
*
* @return array|mixed The updated menu items.
*/
public function insert_menu_item_after_position( array $menus, $new_menu, $after_position ) {
uksort( $menus, 'strnatcmp' );
if ( ! isset( $menus[ (string) $after_position ] ) ) {
$menus[ (string) $after_position ] = $new_menu;
return $menus;
}
$positions_to_renumber = array_filter(
$menus,
function ( $key ) use ( $after_position ) {
return (bool) preg_match( '/^' . (int) $after_position . '(\..*)?$/', $key );
},
ARRAY_FILTER_USE_KEY
);
$menus = array_diff_key( $menus, $positions_to_renumber );
$index = 0;
foreach ( $positions_to_renumber as $current_position => $value ) {
if ( CoreHelpers::version_compare( (string) $after_position, (string) $current_position ) === 0 ) {
$menus[ (string) $current_position ] = $value;
$new_key = array_keys( $positions_to_renumber )[ $index + 1 ] ?? $current_position + 0.01;
$menus[ (string) $new_key ] = $new_menu;
continue;
}
if ( ! preg_match( '/\./', $current_position ) ) {
$current_position = (int) $current_position;
} elseif ( CoreHelpers::version_compare( (string) $after_position, (string) $current_position ) < 0 ) {
$current_position = $current_position + 0.01;
}
$menus[ (string) $current_position ] = $value;
$index++;
}
uksort( $menus, 'strnatcmp' );
return $menus;
}
}