typisttech/wp-admin-tabs

Create tabbed navigation for WordPress admin dashboard, the OOP way

Sunday, April 8, 2018
by TangRufus
Repository
2 Watchers
3 Stars
4,623 Installations

PHP
1 Dependents
1 Suggesters
0 Forks
2 Open issues
8 Versions
19 % Grown

The README.md

WP Admin Tabs

, _(*1)

Create tabbed navigation for WordPress admin dashboard, the OOP way., _(*2)

, _(*3)

Install
Usage
Frequently Asked Questions
Support
- Why don't you hire me?
- Want to help in other way? Want to be a sponsor?
Developing
Running the Tests
Feedback
Change log
Security
Contributing
Credits
License

Install

Installation should be done via composer, details of how to install composer can be found at https://getcomposer.org/., _(*4)

``` bash $ composer require typisttech/wp-admin-tabs, _(*5)


You should put all `WP Admin Tabs` classes under your own namespace to avoid class name conflicts.

- [imposter-plugin](https://github.com/Typisttech/imposter-plugin)
- [mozart](https://github.com/coenjacobs/mozart)

## Usage

### Example

![Screenshot example](./assets/screenshot-example.png)

```php
$adminTabCollection = new AdminTabCollection();
$adminTabCollection->add(
    new AdminTab('Blog', 'https://typist.tech'),
    new AdminTab('Plugins', admin_url('plugins.php')),
    new AdminTab('Users', admin_url('users.php')),
    new AdminTab('Tab A', admin_url('users.php')),
    new AdminTab('Tab B', admin_url('users.php')),
);

// This echos the tabs:
$adminTabCollection->render();

// This returns the HTML string of the tabs:
$html = $adminTabCollection->toHtml();

AdminTab

`__construct(string $menuTitle, string $url)`

AdminTab constructor., _(*6)

@param string $menuTitle The menu title of this tab.
@param string $url The url of this tab.

new AdminTab('Blog', 'https://typist.tech');

new AdminTab('Blog', admin_url('plugins.php'));

AdminTabCollection

`add(AdminTab ...$adminTabs)`

Add admin tabs., _(*7)

@param AdminTab[] ...$adminTabs Admin tabs to be added.

$adminTabCollection = new AdminTabCollection();

// Add single admin tab.
$adminTabCollection->add(
    new AdminTab('Users', admin_url('users.php'))
);

// Add multiple admin tabs.
$adminTabCollection->add(
    new AdminTab('Blog', 'https://typist.tech'),
    new AdminTab('Plugins', admin_url('plugins.php'))
);

`render()`

Render the tabs with echo., _(*8)

$adminTabCollection = new AdminTabCollection();
$adminTabCollection->add(
    new AdminTab('Blog', 'https://typist.tech'),
    new AdminTab('Plugins', admin_url('plugins.php')),
    new AdminTab('Users', admin_url('users.php'))
);

$adminTabCollection->render();

`toHtml(): string`

Converts the tabs to HTML string without echo., _(*9)

$adminTabCollection = new AdminTabCollection();
$adminTabCollection->add(
    new AdminTab('Blog', 'https://typist.tech'),
    new AdminTab('Plugins', admin_url('plugins.php')),
    new AdminTab('Users', admin_url('users.php'))
);

$adminTabCollection->toHtml();

Frequently Asked Questions

Is this a plugin?

No, this is a package that should be part of your plugin., _(*10)

What to do when wp.org plugin team tell me to clean up the `vendor` folder?

Re-install packages via the following command. This package exports only necessary files to dist., _(*11)

$ composer install --no-dev --prefer-dist --optimize-autoloader

Can two different plugins use this package at the same time?

Yes, if put all WP Admin Tabs classes under your own namespace to avoid class name conflicts., _(*12)

Do you have real life examples that use this package?

Here you go:, _(*13)

Add your own plugin here, _(*14)

It looks awesome. Where can I find some more goodies like this?

Articles on Typist Tech's blog
Tang Rufus' WordPress plugins on wp.org
More projects on Typist Tech's GitHub profile
Stay tuned on Typist Tech's newsletter
Follow Tang Rufus' Twitter account
Hire Tang Rufus to build your next awesome site

Support

Love wp-admin-tabs? Help me maintain it, a donation here can help with it., _(*15)

Why don't you hire me?

Ready to take freelance WordPress jobs. Contact me via the contact form here or, via email info@typist.tech, _(*16)

Contact: Tang Rufus, _(*17)

Developing

To setup a developer workable version you should run these commands:, _(*18)

$ composer create-project --keep-vcs --no-install typisttech/wp-admin-tabs:dev-master
$ cd wp-admin-tabs
$ composer install

Running the Tests

WP Admin Tabs run tests on Codeception and relies wp-browser to provide WordPress integration. Before testing, you have to install WordPress locally and add a codeception.yml file. See *.suite.example.yml for Local by Flywheel configuration examples., _(*19)

Actually run the tests:, _(*20)

bash $ composer test, _(*21)

We also test all PHP files against PSR-2: Coding Style Guide and part of the WordPress coding standard., _(*22)

Check the code style with $ composer check-style., _(*23)

Feedback

Please provide feedback! We want to make this package useful in as many projects as possible. Please submit an issue and point out what you do and don't like, or fork the project and make suggestions. No issue is too small., _(*24)