2017 © Pedro Peláez
 

library wp_notice

Display notices in WordPress administration panel.

image

josantonius/wp_notice

Display notices in WordPress administration panel.

  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 4 Versions
  • 0 % Grown

The README.md

PHP WordPress Notice

Latest Stable Version License, (*1)

Versión en español, (*2)

Display notices in WordPress administration panel., (*3)

Requirements

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

Installation

The preferred way to install this extension is through Composer., (*5)

To install WP_Notice library, simply:, (*6)

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:, (*7)

composer require josantonius/wp-notice --prefer-source

You can also clone the complete repository with Git:, (*8)

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

Or install it manually:, (*9)

Download WP_Notice.php:, (*10)

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

Available Methods

Available methods in this library:, (*11)

- 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), (*12)

- 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), (*13)

- 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), (*14)

Quick Start

To use this library with Composer:, (*15)

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

use Josantonius\WP_Notice;

Or If you installed it manually, use it:, (*16)

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

use Josantonius\WP_Notice\WP_Notice;

Usage

Example of use for this library:, (*17)

- 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);

image, (*18)

Tests

To run tests you just need composer and to execute the following:, (*19)

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:, (*20)

composer phpunit

Run WordPress code standard tests with PHPCS:, (*21)

composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:, (*22)

composer phpmd

Run all previous tests:, (*23)

composer tests

If this project helps you to reduce your development time, you can sponsor me to support my open source work :blush:, (*24)

License

This repository is licensed under the MIT License., (*25)

Copyright © 2017-2022, Josantonius, (*26)

The Versions

25/02 2018

dev-master

9999999-dev

Display notices in WordPress administration panel.

  Sources   Download

MIT

The Requires

  • php ^5.6 || ^7.0

 

The Development Requires

by Avatar Josantonius

wordpress php admin hhvm error warning success notices

07/01 2018

1.0.2

1.0.2.0

Display notices in WordPress administration panel.

  Sources   Download

MIT

The Development Requires

by Avatar Josantonius

wordpress php admin hhvm error warning success notices

14/10 2017

1.0.1

1.0.1.0

Display notices in WordPress administration panel.

  Sources   Download

MIT

The Requires

  • php ^5.6 || ^7.0

 

by Avatar Josantonius

wordpress php admin hhvm error warning success notices

18/07 2017

1.0.0

1.0.0.0

Display notices in WordPress administration panel.

  Sources   Download

MIT

The Requires

  • php ^5.6 || ^7.0

 

by Avatar Josantonius

wordpress php admin hhvm error warning success notices