Update docs
This commit is contained in:
parent
d66d708637
commit
dd6bdf730a
@ -21,8 +21,8 @@ This is a quick guide to get you started if you want to contribute to the theme,
|
|||||||
|
|
||||||
### Additional Resources
|
### Additional Resources
|
||||||
|
|
||||||
* [Theme actions](ACTIONS.md)
|
* [Theme action hooks](ACTIONS.md)
|
||||||
* [Theme filters](FILTERS.md)
|
* [Theme filter hooks](FILTERS.md)
|
||||||
* [Child theme example](https://github.com/Tetrakern/fictioneer-child-theme)
|
* [Child theme example](https://github.com/Tetrakern/fictioneer-child-theme)
|
||||||
* [Liminal child theme](https://github.com/Tetrakern/fictioneer-liminal)
|
* [Liminal child theme](https://github.com/Tetrakern/fictioneer-liminal)
|
||||||
|
|
||||||
@ -204,7 +204,7 @@ fcn_ajaxPost(
|
|||||||
|
|
||||||
## Hooked Actions & Filters
|
## Hooked Actions & Filters
|
||||||
|
|
||||||
Fictioneer customizes WordPress by using as many standard action and filter hooks as possible, keeping the theme compatible with plugins adhering to the same principles. However, the theme was not initially built for a public release and despite great efforts to refactor the code, some conflicts are unavoidable. Please make sure to also look at the theme’s custom [actions](ACTIONS.md) and [filters](FILTERS.md). Following is a list of (not) all theme actions and filters hooked to WordPress in a not particularly easy to read at fashion. Some of them are conditional.
|
Fictioneer customizes WordPress by using as many standard action and filter hooks as possible, keeping the theme compatible with plugins adhering to the same principles. However, the theme was not initially built for a public release and despite great efforts to refactor the code, some conflicts are unavoidable. Please make sure to also look at the theme’s custom [action hooks](ACTIONS.md) and [filter hooks](FILTERS.md). Following is a list of (not) all theme actions and filters hooked to WordPress in a not particularly easy to read at fashion. Some of them are conditional.
|
||||||
|
|
||||||
| WORDPRESS HOOK | FICTIONEER ACTIONS
|
| WORDPRESS HOOK | FICTIONEER ACTIONS
|
||||||
| ---: | :--- |
|
| ---: | :--- |
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
# Filters
|
# Filters
|
||||||
The following [filters hooks](https://developer.wordpress.org/reference/functions/add_filter/) can be used to customize the output of action hooks and other functions without having to modify said functions. Filters can be easily added or overwritten in child themes or plugins. See `includes/functions/hooks/`.
|
The following [filter hooks](https://developer.wordpress.org/reference/functions/add_filter/) can be used to customize the output of action hooks and other functions without having to modify said functions. Filters can be easily added or overwritten in child themes or plugins. See `includes/functions/hooks/`.
|
||||||
|
|
||||||
### Example: Add link to subscription options
|
### Example: Add link to subscription options
|
||||||
This is an example of how to add a link to the subscription popup menu via the `'fictioneer_filter_subscribe_buttons'` hook. The link will feature a [Font Awesome link icon](https://fontawesome.com/icons/link?s=solid&f=classic) and be added in first place. Note how the link is pulled from the author’s meta data, which you would need to add yourself as it does not exist outside this example.
|
This is an example of how to add a link to the subscription popup menu via the `'fictioneer_filter_subscribe_buttons'` hook. The link will feature a [Font Awesome link icon](https://fontawesome.com/icons/link?s=solid&f=classic) and be added in first place. Note how the link is pulled from the author’s meta data, which you would need to add yourself as it does not exist outside this example.
|
||||||
|
@ -17,7 +17,7 @@
|
|||||||
|
|
||||||
Fictioneer was originally developed for a closed group of authors and not intended for a public release. This is still reflected in the code, which takes several liberties not considered best practice. You will most likely never find it in official libraries for that reason, meaning installation and updates need to be done manually.
|
Fictioneer was originally developed for a closed group of authors and not intended for a public release. This is still reflected in the code, which takes several liberties not considered best practice. You will most likely never find it in official libraries for that reason, meaning installation and updates need to be done manually.
|
||||||
|
|
||||||
The theme is best suited for individuals and small collectives, not so much open community archives.
|
The theme is intended for individuals and small collectives.
|
||||||
|
|
||||||
Fictioneer is open source and completely free. However, maintaining and developing a theme of these proportions takes a considerable amount of time and effort. So if you enjoy Fictioneer and have the capacity, please consider supporting me on [Ko-fi](https://ko-fi.com/tetrakern). I also take on [commissions](https://fictioneer-theme.com/commissions/) for setup and customizations, *within reason.*
|
Fictioneer is open source and completely free. However, maintaining and developing a theme of these proportions takes a considerable amount of time and effort. So if you enjoy Fictioneer and have the capacity, please consider supporting me on [Ko-fi](https://ko-fi.com/tetrakern). I also take on [commissions](https://fictioneer-theme.com/commissions/) for setup and customizations, *within reason.*
|
||||||
|
|
||||||
@ -29,9 +29,11 @@ stories, chapters, collections, and recommendations • customizable web read
|
|||||||
|
|
||||||
[Child themes](https://developer.wordpress.org/themes/advanced-topics/child-themes/) are the best way to customize Fictioneer if the provided options prove insufficient. You do not even need much programming experience for this since there are many guides and code snippets to adjust WordPress to your needs. But note that Fictioneer is not a page builder, so changing the whole layout does require expertise. Plugins may or may not work here. For starters, look at the [base child theme](https://github.com/Tetrakern/fictioneer-child-theme) and the [Liminal child theme](https://github.com/Tetrakern/fictioneer-liminal).
|
[Child themes](https://developer.wordpress.org/themes/advanced-topics/child-themes/) are the best way to customize Fictioneer if the provided options prove insufficient. You do not even need much programming experience for this since there are many guides and code snippets to adjust WordPress to your needs. But note that Fictioneer is not a page builder, so changing the whole layout does require expertise. Plugins may or may not work here. For starters, look at the [base child theme](https://github.com/Tetrakern/fictioneer-child-theme) and the [Liminal child theme](https://github.com/Tetrakern/fictioneer-liminal).
|
||||||
|
|
||||||
|
You can find some example action and filter functions [here](https://github.com/Tetrakern/fictioneer-child-theme#action--filter-examples).
|
||||||
|
|
||||||
## Support the Development
|
## Support the Development
|
||||||
|
|
||||||
Fictioneer (up to 5.5) has been developed by one author, barring [credited](CREDITS.md) code snippets. This was an exhausting effort and is not sustainable, so any help going forward is appreciated. If you are interested, or want to fork your own version, take a look at the [development](DEVELOPMENT.md) guidelines, [actions](ACTIONS.md), and [filters](FILTERS.md). You can also join the [Discord](https://discord.gg/tVfDB7EbaP).
|
Fictioneer (up to 5.5) has been developed by one author, barring [credited](CREDITS.md) code snippets. This was an exhausting effort and is not sustainable, so any help going forward is appreciated. If you are interested, or want to fork your own version, take a look at the [development](DEVELOPMENT.md) guidelines, [action](ACTIONS.md) hooks, and [filter](FILTERS.md) hooks. You can also join the [Discord](https://discord.gg/tVfDB7EbaP).
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@ Author URI: https://github.com/Tetrakern
|
|||||||
Donate link: [Support me on Ko-Fi](https://ko-fi.com/tetrakern)
|
Donate link: [Support me on Ko-Fi](https://ko-fi.com/tetrakern)
|
||||||
Contributors: tetrakern
|
Contributors: tetrakern
|
||||||
Requires at least: 6.1.0
|
Requires at least: 6.1.0
|
||||||
Tested up to: 6.2.2
|
Tested up to: 6.3
|
||||||
Requires PHP: 7.4
|
Requires PHP: 7.4
|
||||||
Stable tag: 5.5.3
|
Stable tag: 5.5.3
|
||||||
License: GNU General Public License v3.0 or later
|
License: GNU General Public License v3.0 or later
|
||||||
|
@ -9,7 +9,7 @@ License: GNU General Public License v3.0 or later
|
|||||||
License URI: http://www.gnu.org/licenses/gpl.html
|
License URI: http://www.gnu.org/licenses/gpl.html
|
||||||
|
|
||||||
Requires at least: 6.1.0
|
Requires at least: 6.1.0
|
||||||
Tested up to: 6.2.2
|
Tested up to: 6.3
|
||||||
Requires PHP: 7.4
|
Requires PHP: 7.4
|
||||||
Version: 5.5.3
|
Version: 5.5.3
|
||||||
Text Domain: fictioneer
|
Text Domain: fictioneer
|
||||||
|
Loading…
x
Reference in New Issue
Block a user