Template Override Filter?
-
Thanks for the useful plugin!
I have specific requirements for the tooltips that would really require modified markup. But, it doesn’t seem possible to override the templates. Would it be possible to add a filter to allow developers to override the templates?
-
Thanks for you quick and thoughtful reply!
Best would probably be adding a custom folder and calling it first.
Yes, this is the way many other plugins handle it. Essentially, if it finds a template matching a specific name, in a specific location it would use that rather than that in the plugin’s folder.
The filter would be to modify the location of the templates. This would be if I wanted to, say, have templates in a core-functionality plugin rather than the theme.
As an example:
Easy Digital Downloads lets you filter the template directory location
edd_templates_dir: https://github.com/easydigitaldownloads/easy-digital-downloads/blob/5cb0bec92e2f8b2e65a567e9a27810e29c9448ed/includes/template-functions.php#L768-L778ref: https://pippinsplugins.com/template-file-loaders-plugins/
If our development version can be updated accordingly, I’ll let you know for the experimental feature to be testable. If it proves efficient, it will be in our upcoming 2.3.0.
I’d be happy to help testing. ??
I’m ignoring how to add such a filter, but hopefully https://stackoverflow.com/questions/50766761/how-to-create-child-plugin-for-wordpress contains what you are looking for.
Interesting, I’ve never seen this before. Thanks!
Sorry I didn’t see that you already pointed me to a precise section in the code. The old Firefox (v58) I’m using most of the time doesn’t handle the section anchor, so it opened at the top, and I didn’t read the URL first, because this forum displays all links in light blue as if we were not supposed to read the link text first. Only after deleting the end line number did it jump to the start line.
I don’t seem to get this to work in Footnotes, at least not right now, all the code that this line relies upon; as hinted in the blog post, it takes adding an entire file.
Also there is an urgent need to complete Footnotes’ settings and core functionality. Then we’re having an issue with AMP, brought up a few hours later, and I can’t even seem to get the point. If that proves effective, we’re up to re-engineer and refactor even the very templates that you are coding on top of.
Please accept my apologies for being sort of overwhelmed with all the issues we’re facing, the more as for Footnotes sake I needed to put on stand-by another project that does not deserve to be procrastinated, and will need to be rolled out soon.
Thanks anyway for bringing up this customization issue. Hopefully we can leave as a patch the current low-end implementation documented in templates/note-for-developers.txt like this:
note-for-developers.txt 2020-12-19T0609+0100 Last modified: 2020-12-19T0706+0100 Footnotes plugin for WordPress, v2.3.0 and later Support for custom templates ￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣￣ Since v2.3.0, Footnotes can process custom templates. To use custom templates, please make a sibling of the "footnotes" folder called "footnotes-custom" containing just the content of templates/public/ with the same structure. Existing homonymous templates on the path wp-content/plugins/footnotes-custom/templates/public/ are loaded instead of their counterparts in wp-content/plugins/footnotes/templates/public/. The new location does not need to contain all templates. E.g. for custom tooltips, you need only one or both of these: footnotes-custom └── templates └── public ├── footnote.html └── tooltip.htmlOf course that reflects my little understanding, and I hope that at some point there will be something better.
If you agree I’ll add credits in the readme and code, as I’m attempting to do for all contributors to this 2.x overhaul.
Thank you!
-
This reply was modified 4 years, 2 months ago by
. Reason: completed “as if we were not supposed to read first.”
-
This reply was modified 4 years, 2 months ago by
-
This reply was modified 4 years, 2 months ago by
-
This reply was modified 4 years, 2 months ago by
Hi @pewgeuges
I updated the plugin with a prioritized template stack (child theme, parent theme, custom location, plugin).
Since I didn’t see a way to contribute using SVN, I created a git repo based on the latest file (#post-13854708).
Source is here:
https://github.com/misfist/footnotes/releases/tag/2.4.0d2View diff:
https://github.com/misfist/footnotes/compare/2.4.0d0…2.4.0d2Has not been thoroughly tested yet.
Hi there!
I’ve updated the code and it’s working for me.
https://github.com/misfist/footnotes/releases/tag/2.4.0d3
See Diff:
https://github.com/misfist/footnotes/compare/2.4.0…2.4.0d3the part that I’m still having trouble with is the filter in the comment, where you hint how to change the template directory name in the theme (child or parent) where the templates would be stored. I didn’t get it to work
The two filters allow you to change the directory paths.
$template_directory = apply_filters( 'mci_footnotes_template_directory', 'footnotes/templates/' ); $custom_directory = apply_filters( 'mci_footnotes_custom_template_directory', 'footnotes-custom/' );They’re used like this:
/** * Change location within theme * e.g. add within your theme's functions.php file * * @param string $template_directory * @return string $template_directory */ function quincy_mci_footnotes_template_directory( $template_directory ) { $template_directory = 'template-parts/footnotes/templates/'; // Change the path within my theme to ./template-parts/footnotes/templates/, relative to theme. return $template_directory; } add_filter( 'mci_footnotes_template_directory', 'quincy_mci_footnotes_template_directory' );/** * Change location of custom directory * e.g. add within your custom plugin * * @param string $custom_directory * @return string $custom_directory */ function quincy_mci_footnotes_custom_template_directory( $custom_directory ) { $custom_directory = 'footnotes-test/'; // Change the custom directory to ./footnotes-test/, relative to the plugins directory. return $custom_directory; } add_filter( 'mci_footnotes_custom_template_directory', 'quincy_mci_footnotes_custom_template_directory' );Hope this makes sense.
Hi,
Thanks a lot, that seems crystal clear to me. I’d like to add it in a comment block in class/template.php if you are fine with that. It will make a good documentation. Another good place is the note-for-developers.txt included in the plugin’s templates folder. Or in both locations.
I’ve fetched the code from GitHub. Thank you!
Your contribution the improved file class/template.php is now part of v2.5.0 released in urgency because it also fixes Footnotes’ bug on category pages. Now that the solution was found and the way open, getting Footnotes to work on category pages with fully-fledged articles introducing the category was top priority. At the expense of many things like adding the hook in the dashboard, editing the comment blocks adding the documentation you provided in #post-13864301, as well as other things on the to-do list. Other bugfixes included in 2.5.0 are related to the validation feature.
Thank you for helping improve the Footnotes plugin!
-
This reply was modified 4 years, 2 months ago by
- The topic ‘Template Override Filter?’ is closed to new replies.
