inpsyde / plugin-templating-utils
Provides utility functions for templating functionality in plugins.
Installs: 20 892
Dependents: 0
Suggesters: 0
Security: 0
Stars: 14
Watchers: 5
Forks: 3
Open Issues: 0
Requires
- php: >=5.6
This package is auto-updated.
Last update: 2024-10-30 16:37:43 UTC
README
A Composer package that provides utility functions to templating functionality in plugins..
Functions
Inpsyde\plugin_file_base_dir()
Given a file a file inside a plugin directory, no matter how deep in the directory three, returns the absolute path to root directory of the plugin.
Inpsyde\plugin_template_part()
Similar to get_template_part() loads a template from a plugin directory.
The plugin folder where to search is obtained from first argument, that can be a file in the target plugin directory,
no matter how deep in the directory three.
Templates to be searched pass through 'plugin_template_part_templates' filter.
Inpsyde\find_plugin_template_part()
Similar to plugin_template_part() (also trigger same filter) it returns the path of found template instead of including it.
Inpsyde\plugin_file_path()
Similar to get_theme_file_path() returns the path of a file inside a plugin directory.
The target plugin is obtained from first argument, that can be a file in the target plugin directory,
no matter how deep in the directory three.
Returns empty string if the file does not exists.
Returned value passes through 'plugin_file_path' filter.
Inpsyde\plugin_file_uri()
Similar to get_theme_file_uri() returns the URL of a file inside a plugin directory.
The target plugin is obtained from first argument, that can be a file in the target plugin directory,
no matter how deep in the directory three.
Returns empty string if the file does not exists.
Returned value passes through 'plugin_file_uri' filter.
Inpsyde\plugin_template_part_fallback()
Like Inpsyde\plugin_template_part() but fallbacks to theme (or child theme) if file is not found in plugin.
Inpsyde\plugin_file_path_fallback()
Like Inpsyde\plugin_file_path() but fallbacks to theme (or child theme) if file is not found in plugin.
Inpsyde\plugin_file_uri_fallback()
Like Inpsyde\plugin_file_uri() but fallbacks to theme (or child theme) if file is not found in plugin.
Requirements
- PHP 5.6+
- Composer to install
Installation
Via Composer, package name is inpsyde/plugin-templating-utils.
License and Copyright
Copyright (c) 2017 Inpsyde GmbH.
"Plugin Templating Utils" code is licensed under MIT license.
The team at Inpsyde is engineering the Web since 2006.