Skip to content

Commit 38e3e7c

Browse files
authored
Merge pull request #519 from wpengine/previews-update-doc-links
docs(previews): update wp-admin doc links, add actions-and-filters doc
2 parents b95f669 + 0dff8ff commit 38e3e7c

File tree

3 files changed

+15
-18
lines changed

3 files changed

+15
-18
lines changed

.changeset/little-buses-slide.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@wpengine/hwp-previews-wordpress-plugin": patch
3+
---
4+
5+
Changed documentation links on wp-admin

plugins/hwp-previews/ACTIONS_AND_FILTERS.md renamed to docs/plugins/hwp-previews/explanation/actions-and-filters/index.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
1-
# Actions & Filters
2-
3-
## Table of Contents
4-
5-
- [PHP Actions](#php-actions)
6-
- [PHP Filters](#php-filters)
7-
- [Examples](#examples)
8-
- [Actions](#actions)
9-
- [Filters](#filters)
10-
- [Contributing](#contributing)
11-
1+
---
2+
title: "Actions and Filters"
3+
description: "Learn about the available PHP actions and filters in HWP Previews plugin for customizing plugin behavior, settings, and integrations."
124
---
135

146
This document lists the available PHP actions and filters provided by the HWP Previews plugin, along with explanations and usage examples. These hooks allow you to customize plugin behavior, settings, and integration with other plugins or your theme.
157

16-
---
178

189
## PHP Actions
1910

@@ -25,7 +16,6 @@ This document lists the available PHP actions and filters provided by the HWP Pr
2516
| `hwp_previews_settings_init` | Fired after the settings page is initialized. |
2617
| `hwp_previews_settings_form_manager_init` | Fired after the settings form manager is initialized. |
2718

28-
---
2919

3020
## PHP Filters
3121

@@ -39,7 +29,6 @@ This document lists the available PHP actions and filters provided by the HWP Pr
3929
| `hwp_previews_filter_available_post_types` | Filter the available post types for previews (affects settings UI and preview logic). |
4030
| `hwp_previews_filter_available_post_statuses` | Filter the available post statuses for previews. |
4131

42-
---
4332

4433
## Examples
4534

plugins/hwp-previews/src/Templates/admin.php

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,15 @@
7272
<div class="inside hwp-previews-docs">
7373

7474
<ul>
75-
<li><a href="https://github.com/wpengine/hwptoolkit/tree/main/plugins/hwp-previews#getting-started" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Getting Started', 'hwp-previews' ); ?></a></li>
76-
<li><a href="https://github.com/wpengine/hwptoolkit/tree/main/plugins/hwp-previews#front-end-integration" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Front-End Integration', 'hwp-previews' ); ?></a></li>
75+
<li><a href="https://github.com/wpengine/hwptoolkit/tree/main/plugins/hwp-previews#hwp-previews" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Getting Started', 'hwp-previews' ); ?></a></li>
76+
<li><a href="https://github.com/wpengine/hwptoolkit/blob/main/docs/plugins/hwp-previews/how-to/configure-previews/index.md" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Configure Previews', 'hwp-previews' ); ?></a></li>
77+
<li><a href="https://github.com/wpengine/hwptoolkit/blob/main/docs/plugins/hwp-previews/explanation/core-concepts/index.md" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Core Concepts', 'hwp-previews' ); ?></a></li>
7778
<?php if ( $hwp_previews_faust_integration->get_faust_enabled() ) : ?>
78-
<li><a href="/wpengine/hwptoolkit/tree/main/plugins/hwp-previews#using-with-faustjs" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Using With Faust.js', 'hwp-previews' ); ?></a></li>
79+
<li><a href="/wpengine/hwptoolkit/blob/main/docs/plugins/hwp-previews/how-to/integrate-with-faust/index.md" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Using With Faust.js', 'hwp-previews' ); ?></a></li>
7980
<?php endif; ?>
80-
<li><a href="https://github.com/wpengine/hwptoolkit/blob/main/plugins/hwp-previews/ACTIONS_AND_FILTERS.md" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Actions and Filters', 'hwp-previews' ); ?></a></li>
81+
<li><a href="https://github.com/wpengine/hwptoolkit/blob/main/docs/plugins/hwp-previews/explanation/actions-and-filters/index.md" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Actions and Filters', 'hwp-previews' ); ?></a></li>
82+
<li><a href="https://github.com/wpengine/hwptoolkit/blob/main/docs/plugins/hwp-previews/tutorial/previews-with-wpgraphql/index.md" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Build Previews with Next.js and WPGraphQL', 'hwp-previews' ); ?></a></li>
83+
<li><a href="https://github.com/wpengine/hwptoolkit/blob/main/docs/plugins/hwp-previews/tutorial/previews-with-rest/index.md" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Build Previews with Next.js and REST API', 'hwp-previews' ); ?></a></li>
8184
</ul>
8285
<p><?php esc_html_e( 'HWP Previews is part of the HWP Toolkit, our comprehensive suite of tools and examples for headless WordPress.', 'hwp-previews' ); ?></p>
8386
<p><a class="button-secondary" href="https://github.com/wpengine/hwptoolkit" target="_blank" rel="noopener noreferrer">HWP Toolkit on GitHub</a></p>

0 commit comments

Comments
 (0)