Download the PHP package josantonius/wp-menu without Composer
On this page you can find all versions of the php package josantonius/wp-menu. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package wp-menu
PHP WordPress Menu
Versión en español
Add menu or submenu page in WordPress.
- Requirements
- Installation
- Available Methods
- Quick Start
- Usage
- Action Hooks
- Tests
- Sponsor
- License
Requirements
This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.
Installation
The preferred way to install this extension is through Composer.
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:
wget https://raw.githubusercontent.com/josantonius/wp-menu/master/src/class-wp-menu.php
Available Methods
Available methods in this library:
- Add WordPress menu/submenu
Atttribute | Description | Type | Required | Default |
---|---|---|---|---|
$type | 'menu' or 'submenu' | string | Yes |
Atttribute | key | Description | Type | Required | Default |
---|---|---|---|---|---|
$data | Settings | array | Yes | ||
name | Menu/Submenu name | string | Yes | ||
slug | Menu/Submenu slug | string | Yes | ||
title | Menu/Submenu title | string | No | $data['name'] | |
capability | Capability required | string | No | '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. | string | No | '' | |
position | Only for menus - The position in the menu order this one should appear. | int | No | null | |
parent | Only for submenus - The slug name for the parent menu | string | Yes |
Atttribute | Description | Type | Required | Default |
---|---|---|---|---|
$function | Function to be called to output | callable | No | false |
Atttribute | Description | Type | Required | Default |
---|---|---|---|---|
$styles | Function to be called to load page styles | callable | No | false |
Atttribute | Description | Type | Required | Default |
---|---|---|---|---|
$scripts | Function to be called to load page scripts | callable | No | false |
@return (boolean)
Quick Start
To use this library with Composer:
Or If you installed it manually, use it:
Usage
- Set menu params
- Add menu
Add menu without associated method.
Add menu with associated method for output.
Add menu with associated methods for output and styles.
Add menu with associated methods for output, styles and scripts.
Add menu with associated methods for output and scripts.
- Set submenu params
- Add submenu
Add submenu without associated method:
Add submenu with associated method for output.
Add submenu with associated methods for output and styles.
Add submenu with associated methods for output, styles and scripts.
Add submenu with associated method for output and scripts.
- Advanced example
Action hooks
Action | Description | Parameters |
---|---|---|
wp_menu_pre_add_menu_page | Before adding menu. | |
wp_menu_after_add_menu_page | After adding menu. | $page Resulting page's hook_suffix, or false. |
wp_menu_pre_add_submenu_page | Before adding submenu. | |
wp_menu_after_add_submenu_page | After adding submenu. | $page Resulting page's hook_suffix, or false. |
Tests
To run composer 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:
composer phpunit
Run WordPress code standard tests with PHPCS:
composer phpcs
Run PHP Mess Detector tests to detect inconsistencies in code style:
composer phpmd
Run all previous tests:
composer tests
Sponsor
If this project helps you to reduce your development time, you can sponsor me to support my open source work :blush:
License
This repository is licensed under the MIT License.
Copyright © 2017-2022, Josantonius