Download the PHP package josantonius/wp-register without Composer
On this page you can find all versions of the php package josantonius/wp-register. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package wp-register
PHP WordPress Register
Versión en español
Register, minify and unify CSS and JavaScript resources in WordPress.
- 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_Register library, simply:
composer require josantonius/wp-register
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-register --prefer-source
You can also clone the complete repository with Git:
git clone https://github.com/josantonius/wp-register.git
Or install it manually:
wget https://raw.githubusercontent.com/josantonius/wp-register/master/src/class-wp-register.php
Available Methods
Available methods in this library:
- Add scripts or styles
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$type | 'script' or 'style' | string | Yes |
Attribute | key | Description | Type | Required | Default |
---|---|---|---|---|---|
$data | Settings | array | Yes | ||
name | Unique ID | string | Yes | ||
url | Url to file | string | Yes | ||
place | 'admin' or 'front' | string | No | 'front' | |
deps | Dependences | array | No | [] | |
version | Version | string | No | false | |
footer | Only for scripts - Attach in footer | boolean | No | true | |
params | Only for scripts - Params available in JS | array | Yes | [] | |
media | Only for styles - Media | string | No | '' |
@return (boolean)
- Sets whether to merge the content of files into a single file
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$id | Action hook name | string | Yes | |
$params | Path urls | mixed | Yes | |
$minify | Minimize file content | boolean | No | false |
@return (boolean true)
- Check if a particular style or script has been added to be enqueued
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$type | 'script' or 'style' | string | Yes | |
$name | Script or style ID | string | Yes |
@return (boolean)
- Remove before script or style have been registered
Attribute | Description | Type | Required | Default |
---|---|---|---|---|
$type | 'script' or 'style' | string | Yes | |
$name | Script or style ID | string | Yes |
@return (boolean true)
Quick Start
To use this library with Composer:
Or If you installed it manually, use it:
Usage
Example of use for this library:
- Add script
Additionally, a nonce is created for each script using its name. In this example, it will be accessible from JavaScript using NavigationScript.nonce
.
wp_verify_nonce($nonce, 'NavigationScript');
In the case of scripts created from plugins, the path of the plugin directory is saved as a parameter. In this example, it will be accessible from JavaScript using NavigationScript.pluginUrl
.
- Add style
- Unify
- Unify and minify
- Unify specifying different url paths for styles and scripts
- Unify and minify specifying different url paths for styles and scripts
- Check if a particular style or script has been added to be registered
- Remove before script or style have been enqueued
Tests
To run composer and to execute the following:
git clone https://github.com/josantonius/wp-register.git
cd WP_Register
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