PHPackages                             josantonius/wp-menu - 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. josantonius/wp-menu

AbandonedArchivedLibrary[Utility & Helpers](/categories/utility)

josantonius/wp-menu
===================

Add menu or submenu page in WordPress.

1.0.7(8y ago)563MITPHPPHP ^5.6 || ^7.0

Since May 23Pushed 3y ago2 watchersCompare

[ Source](https://github.com/josantonius/wp-menu)[ Packagist](https://packagist.org/packages/josantonius/wp-menu)[ GitHub Sponsors](https://github.com/Josantonius)[ RSS](/packages/josantonius-wp-menu/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (8)Dependencies (6)Versions (9)Used By (0)

PHP WordPress Menu
==================

[](#php-wordpress-menu)

[![Latest Stable Version](https://camo.githubusercontent.com/4f014fb616f041f05bce5519e7a98a8a185c3e05eb41e3c8adc0c76a36f51979/68747470733a2f2f706f7365722e707567782e6f72672f6a6f73616e746f6e6975732f77702d6d656e752f762f737461626c65)](https://packagist.org/packages/josantonius/wp-menu)[![License](https://camo.githubusercontent.com/c72b5eb007f2dec662155e790655ed44194660aee32590dff1aa164279b178d2/68747470733a2f2f706f7365722e707567782e6f72672f6a6f73616e746f6e6975732f77702d6d656e752f6c6963656e7365)](LICENSE)

[Versión en español](README-ES.md)

Add menu or submenu page in WordPress.

---

- [Requirements](#requirements)
- [Installation](#installation)
- [Available Methods](#available-methods)
- [Quick Start](#quick-start)
- [Usage](#usage)
- [Action Hooks](#action-hooks)
- [Tests](#tests)
- [Sponsor](#Sponsor)
- [License](#license)

---

Requirements
------------

[](#requirements)

This library is supported by **PHP versions 5.6** or higher and is compatible with **HHVM versions 3.0** or higher.

Installation
------------

[](#installation)

The preferred way to install this extension is through [Composer](http://getcomposer.org/download/).

To install **WP\_Menu library**, simply:

```
composer require josantonius/wp-menu

```

The previous command will only install the necessary files, if you prefer to **download the entire source code** you can use:

```
composer require josantonius/wp-menu --prefer-source

```

You can also **clone the complete repository** with Git:

```
git clone https://github.com/josantonius/wp-menu.git

```

Or **install it manually**:

[Download WP\_Menu.php](https://raw.githubusercontent.com/josantonius/wp-menu/master/src/class-wp-menu.php):

```
wget https://raw.githubusercontent.com/josantonius/wp-menu/master/src/class-wp-menu.php

```

Available Methods
-----------------

[](#available-methods)

Available methods in this library:

### - Add WordPress menu/submenu

[](#--add-wordpress-menusubmenu)

```
WP_Menu::add($type, $data, $function, $styles, $scripts);
```

AtttributeDescriptionTypeRequiredDefault$type'menu' or 'submenu'stringYes---

AtttributekeyDescriptionTypeRequiredDefault$dataSettingsarrayYesnameMenu/Submenu namestringYesslugMenu/Submenu slugstringYestitleMenu/Submenu titlestringNo$data\['name'\]capabilityCapability requiredstringNo'manage\_options'icon\_url**Only for menus** - The URL to the icon to be used for this menu. Pass a base64-encoded SVG using a data URI, which will be colored to match the color scheme. This should begin with 'data:image/svg+xml;base64,'. Pass the name of a Dashicons helper class to use a font icon, e.g. 'dashicons-chart-pie'. Pass 'none' to leave div.wp-menu-image empty so an icon can be added via CSS.stringNo''position**Only for menus** - The position in the menu order this one should appear.intNonullparent**Only for submenus** - The slug name for the parent menustringYes---

AtttributeDescriptionTypeRequiredDefault$functionFunction to be called to outputcallableNofalse---

AtttributeDescriptionTypeRequiredDefault$stylesFunction to be called to load page stylescallableNofalse---

AtttributeDescriptionTypeRequiredDefault$scriptsFunction to be called to load page scriptscallableNofalse**@return** (boolean)

Quick Start
-----------

[](#quick-start)

To use this library with **Composer**:

```
require __DIR__ . '/vendor/autoload.php';

use Josantonius\WP_Menu;
```

Or If you installed it **manually**, use it:

```
require_once __DIR__ . '/class-wp-menu.php';

use Josantonius\WP_Menu\WP_Menu;
```

Usage
-----

[](#usage)

### - Set menu params

[](#--set-menu-params)

```
$params = [
    'slug'       => 'searchinside-options',
    'name'       => __('Search Inside', 'search-iniside'),
    'title'      => __('Search Inside', 'search-iniside'),
    'capability' => 'manage_options',
    'icon_url'   => '//searchinside-menu-admin.png',
    'position'   => 25,
];
```

### - Add menu

[](#--add-menu)

**Add menu without associated method.**

```
WP_Menu::add(
    'menu',
    $params
);
```

**Add menu with associated method for output.**

```
WP_Menu::add(
    'menu',
    $params,
    [$this, 'run_page']
);
```

**Add menu with associated methods for output and styles.**

```
WP_Menu::add(
    'menu',
    $params,
    [$instance1, 'run_page'],
    [$instance3, 'load_styles']
);
```

**Add menu with associated methods for output, styles and scripts.**

```
WP_Menu::add(
    'menu',
    $params,
    [$instance1, 'run_page'],
    [$instance3, 'load_styles'],
    [$instance3, 'load_scripts']
);
```

**Add menu with associated methods for output and scripts.**

```
WP_Menu::add(
    'menu',
    $params,
    [$instance1, 'run_page'],
    false,
    [$instance3, 'load_scripts']
);
```

### - Set submenu params

[](#--set-submenu-params)

```
$params = [
    'slug'       => 'searchinside-options',
    'parent'     => 'searchinside-options',
    'name'       => __('Options', 'search-iniside'),
    'title'      => __('Options', 'search-iniside'),
    'capability' => 'manage_options',
];
```

### - Add submenu

[](#--add-submenu)

**Add submenu without associated method:**

```
WP_Menu::add(
    'submenu',
    $params
);
```

**Add submenu with associated method for output.**

```
WP_Menu::add(
    'submenu',
    $params,
    [$this, 'run_page']
);
```

**Add submenu with associated methods for output and styles.**

```
WP_Menu::add(
    'submenu',
    $params,
    [$instance1, 'run_page'],
    [$instance3, 'load_styles']
);
```

**Add submenu with associated methods for output, styles and scripts.**

```
WP_Menu::add(
    'submenu',
    $params,
    [$instance1, 'run_page'],
    [$instance3, 'load_styles'],
    [$instance3, 'load_scripts']
);
```

**Add submenu with associated method for output and scripts.**

```
WP_Menu::add(
    'submenu',
    $params,
    [$instance1, 'run_page'],
    false,
    [$instance3, 'load_scripts']
);
```

### - Advanced example

[](#--advanced-example)

```
class Sample_Class {

    public function __construct() {

        add_action( 'wp_menu_pre_add_menu_page', [ $this, 'before_add_menu' ] );
        add_action( 'wp_menu_after_add_menu_page', [ $this, 'after_add_menu' ] );
        add_action( 'wp_menu_pre_add_submenu_page', [ $this, 'before_add_submenu' ] );
        add_action( 'wp_menu_after_add_submenu_page', [ $this, 'after_add_submenu' ] );
    }

    public function run_page() {

        echo 'Response from run_page method';
    }

    public function add_styles() {

        echo 'Response from add_styles method';
    }

    public function add_scripts() {

        echo 'Response from add_scripts method';
    }

    public function before_add_menu() {

        echo 'Response from wp_menu_pre_add_menu_page action';
    }

    public function after_add_menu( $hook_suffix ) {

        echo 'Response from wp_menu_after_add_menu_page action';
        echo 'Hook suffix: ' . $hook_suffix;
    }

    public function before_add_submenu() {

        echo 'Response from wp_menu_pre_add_submenu_page action';
    }

    public function after_add_submenu( $hook_suffix ) {

        echo 'Response from wp_menu_after_add_submenu_page action';
        echo 'Hook suffix: ' . $hook_suffix;
    }
}

$sample_class = new Sample_Class();

/**
 * Add menu
 */
$params = [
    'slug'       => 'plugin-options',
    'name'       => __( 'Plugin Name', 'plugin-slug' ),
    'title'      => __( 'Plugin Title', 'plugin-slug' ),
    'capability' => 'manage_options',
    'icon_url'   => '//searchinside-menu-admin.png',
    'position'   => 25,
];

WP_Menu::add(
    'menu',
    $params,
    [ $sample_class, 'run_page' ],
    [ $sample_class, 'add_styles' ],
    [ $sample_class, 'add_scripts' ]
);

/**
 * Add submenu
 */
$params = [
    'slug'       => 'sub-plugin-options',
    'parent'     => 'plugin-options',
    'name'       => __( 'Plugin Name', 'plugin-slug' ),
    'title'      => __( 'Plugin Title', 'plugin-slug' ),
    'capability' => 'manage_options',
];

WP_Menu::add(
    'submenu',
    $params,
    [ $sample_class, 'run_page' ],
    [ $sample_class, 'add_styles' ],
    [ $sample_class, 'add_scripts' ]
);

# When do_action('admin_menu');

    // Response from wp_menu_pre_add_menu_page action
    // Response from wp_menu_pre_add_submenu_page action

    // Response from wp_menu_after_add_menu_page action
    // Response from wp_menu_after_add_submenu_page action

    // Hook suffix: load-toplevel_page_plugin-options
    // Hook suffix: plugin-name_page_sub-plugin-options

# When do_action('toplevel_page_plugin-options');

    // Executed only if access the page associated with this menu.

        // Response from run_page method

# When do_action('plugin-name_page_sub-plugin-options');

    // Executed only if access the page associated with this submenu.

        // Response from run_page method

# When do_action('load-toplevel_page_plugin-options');

    // Executed only if access the page associated with this menu.

        // Response from add_styles method
        // Response from add_scripts method

# When do_action('load-plugin-name_page_sub-plugin-options');

    // Executed only if access the page associated with this submenu.

        // Response from add_styles method
        // Response from add_scripts method
```

Action hooks
------------

[](#action-hooks)

ActionDescriptionParameterswp\_menu\_pre\_add\_menu\_pageBefore adding menu.wp\_menu\_after\_add\_menu\_pageAfter adding menu.**$page** Resulting page's hook\_suffix, or false.wp\_menu\_pre\_add\_submenu\_pageBefore adding submenu.wp\_menu\_after\_add\_submenu\_pageAfter adding submenu.**$page** Resulting page's hook\_suffix, or false.Tests
-----

[](#tests)

To run [tests](tests) you just need [composer](http://getcomposer.org/download/) and to execute the following:

```
git clone https://github.com/josantonius/wp-menu.git

cd WP_Menu

bash bin/install-wp-tests.sh wordpress_test root '' localhost latest

composer install

```

Run unit tests with [PHPUnit](https://phpunit.de/):

```
composer phpunit

```

Run [WordPress](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/) code standard tests with [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer):

```
composer phpcs

```

Run [PHP Mess Detector](https://phpmd.org/) tests to detect inconsistencies in code style:

```
composer phpmd

```

Run all previous tests:

```
composer tests

```

Sponsor
-------

[](#sponsor)

If this project helps you to reduce your development time, [you can sponsor me](https://github.com/josantonius#sponsor) to support my open source work 😊

License
-------

[](#license)

This repository is licensed under the [MIT License](LICENSE).

Copyright © 2017-2022, [Josantonius](https://github.com/josantonius#contact)

###  Health Score

29

—

LowBetter than 59% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~39 days

Recently: every ~55 days

Total

8

Last Release

3000d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/4b221283501ec8a9cbaefaf27821a91ae8ddd33bddf1fccc6c6815b7ad216ff1?d=identicon)[Josantonius](/maintainers/Josantonius)

---

Top Contributors

[![josantonius](https://avatars.githubusercontent.com/u/18104336?v=4)](https://github.com/josantonius "josantonius (30 commits)")

---

Tags

phpwordpress-librarywordpress-menuwordpress-submenuphpwordpresshhvmmenusubmenu

###  Code Quality

TestsPHPUnit

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/josantonius-wp-menu/health.svg)

```
[![Health](https://phpackages.com/badges/josantonius-wp-menu/health.svg)](https://phpackages.com/packages/josantonius-wp-menu)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)