josantonius/wp-notice

This package is abandoned and no longer maintained. No replacement package was suggested.

Display notices in WordPress administration panel.

1.0.2 2018-01-07 19:27 UTC

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.3 || ^2.8
• phpmd/phpmd: ^2.6
• phpunit/phpunit: ^5.7 || ^6.0
• squizlabs/php_codesniffer: ^3.2.2
• wp-coding-standards/wpcs: ^0.14

MIT

• Josantonius

• admin
• php
• error
• wordpress
• warning
• success
• hhvm
• notices

README

Versión en español

Display notices in WordPress administration panel.

• Requirements
• Installation
• Available Methods
• Quick Start
• Usage
• 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_Notice library, simply:

composer require josantonius/wp-notice

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-notice --prefer-source

You can also clone the complete repository with Git:

git clone https://github.com/josantonius/wp-notice.git

Or install it manually:

Download WP_Notice.php:

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

Available Methods

Available methods in this library:

- Generate success notice

WP_Notice::success($message, $dismissable);

Atttribute	Description	Type	Required	Default
$message	Notice message.	string	Yes
$dismissable	Dimissable notice.	boolean	No	true

@return (boolean true)

- Generate warning notice

WP_Notice::warning($message, $dismissable);

Atttribute	Description	Type	Required	Default
$message	Notice message.	string	Yes
$dismissable	Dimissable notice.	boolean	No	true

@return (boolean true)

- Generate error notice

WP_Notice::error($message, $dismissable);

Atttribute	Description	Type	Required	Default
$message	Notice message.	string	Yes
$dismissable	Dimissable notice.	boolean	No	true

@return (boolean true)

Quick Start

To use this library with Composer:

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

use Josantonius\WP_Notice;

Or If you installed it manually, use it:

require_once __DIR__ . '/class-wp-notice.php';

use Josantonius\WP_Notice\WP_Notice;

Usage

Example of use for this library:

- Generate success notice

WP_Notice::success('Success example');
WP_Notice::success('Success not dismissable', false);

- Generate warning notice

WP_Notice::warning('Warning example');
WP_Notice::warning('Warning not dismissable', false);

- Generate error notice

$error = new \WP_Error('error', 'Example of error creation from WP_Error');

WP_Notice::error($error);
WP_Notice::error('Example of error creation without going through WP_Error');
WP_Notice::error('Error not dismissable', false);

Tests

To run tests you just need composer and to execute the following:

git clone https://github.com/josantonius/wp-notice.git

cd WP_Notice

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 😊

License

This repository is licensed under the MIT License.

Copyright © 2017-2022, Josantonius