Download the PHP package typisttech/wp-kses-view without Composer
On this page you can find all versions of the php package typisttech/wp-kses-view. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download typisttech/wp-kses-view
More information about typisttech/wp-kses-view
Files in typisttech/wp-kses-view
Package wp-kses-view
Short Description Safely rendering for WordPress, the OOP way
License GPL-2.0-or-later
Homepage https://typist.tech/projects/wp-kses-view
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package wp-kses-view
WP Kses View
Safely rendering for WordPress, the OOP way.
- Install
- Usage
- Static Example
- Render with
ContextExample - View
__construct(string $template, array $allowedHtml)render($context = null)toHtml($context = null): string- Template
- Helpers
- Frequently Asked Questions
- Why some HTML tags are stripped out?
- Is this a plugin?
- What to do when wp.org plugin team tell me to clean up the
vendorfolder? - Can two different plugins use this package at the same time?
- Do you have real life examples that use this package?
- It looks awesome. Where can I find some more goodies like this?
- 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/.
You should put all WP Kses View classes under your own namespace to avoid class name conflicts.
Usage
Static Example
Note that <script> has been sanitized.
Render with Context Example
View
__construct(string $template, array $allowedHtml)
View constructor.
- @param string $template Filename of the template to render.
- @param array $allowedHtml List of allowed HTML elements.
$allowedHtml will later be passed to wp_kses.
wp_kses_allowed_html('post') is a good start if you not sure which HTML tags to use.
render($context = null)
Echo the view safely with optional context object.
- @param mixed $context Optional. Context object for which to render the view.
toHtml($context = null): string
Convert the view to safe HTML.
- @param mixed $context Optional. Context object for which to render the view.
If you pass in a context object, you can reference it in your template as $context.
Think $context as the M in MVC pattern.
Template
A template can be anything, not limited to .php files. Common use cases are:
.php.html.js
If you pass in a context object, you can reference it in your template as $context.
Think templates are .erb files under app/view directory in a Rails app.
Helpers
This package provides Factory, ViewAwareTrait and NullView to reduce boilerplate code for common use cases.
Check their well-documented source code and their tests to learn more.
Frequently Asked Questions
Why some HTML tags are stripped out?
This is the heart of this package, removing dangerous HTML tags during rendering.
To allow a HTML tag:
- Add the tag when instantiating a
viewobject.
Check wp_kses's document to learn more.
When in doubt, wp_kses_allowed_html('post') is a good start.
Is this a plugin?
No, this is a package that should be part of your plugin.
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.
Can two different plugins use this package at the same time?
Yes, if put all WP Kses View classes under your own namespace to avoid class name conflicts.
Do you have real life examples that use this package?
Here you go:
Add your own plugin here
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-kses-view? Help me maintain it, a donation here can help with it.
Why don't you hire me?
Ready to take freelance WordPress jobs. Contact me via the contact form here or, via email [email protected]
Want to help in other way? Want to be a sponsor?
Contact: Tang Rufus
Developing
To setup a developer workable version you should run these commands:
Running the Tests
TODO: Re-add tests.
See: https://github.com/TypistTech/wp-kses-view/commit/45f95d3f1f062c51ddbd8a5da7d6e8317fccff97
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.
Change log
Please see CHANGELOG for more information on what has changed recently.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Contributing
Please see CODE_OF_CONDUCT for details.
Credits
WP Kses View is a Typist Tech project and maintained by Tang Rufus, freelance developer for hire.
Full list of contributors can be found here.
License
WP Kses View is licensed under the GPLv2 (or later) from the Free Software Foundation. Please see License File for more information.
