class-external-permalinks.php — Admin and Site Enhancements (ASE) 8.6.2

admin-site-enhancements / classes / class-external-permalinks.php

admin-site-enhancements / classes Last commit date

class-external-permalinks.php

207 lines

1	<?php
2
3	namespace ASENHA\Classes;
4
5	/**
6	* Class for External Permalinks module
7	*
8	* @since 6.9.5
9	*/
10	class External_Permalinks {
11	/**
12	* Check if External Permalinks is enabled for the given post type.
13	*
14	* In the free version, this always behaves like 'only-on'. In the pro
15	* version, this can be 'only-on', 'except-on' or 'all-post-types'.
16	*
17	* @param string $post_type_slug Post type slug.
18	* @param array $options Plugin options.
19	* @return bool True when enabled for the post type.
20	*/
21	private function is_enabled_for_post_type( $post_type_slug, $options = array() ) {
22	if ( empty( $post_type_slug ) ) {
23	return false;
24	}
25	$enabled_for = ( isset( $options['enable_external_permalinks_for'] ) && is_array( $options['enable_external_permalinks_for'] ) ? $options['enable_external_permalinks_for'] : array() );
26	// Only operate on applicable post types (public, excluding attachment).
27	$applicable_post_types = array_keys( $enabled_for );
28	$applicable_post_types = array_values( array_diff( $applicable_post_types, array('attachment') ) );
29	if ( empty( $applicable_post_types ) \|\| !in_array( $post_type_slug, $applicable_post_types, true ) ) {
30	return false;
31	}
32	$type = 'only-on';
33	$selected_post_types = array();
34	foreach ( $enabled_for as $slug => $is_enabled ) {
35	if ( 'attachment' === $slug ) {
36	continue;
37	}
38	if ( $is_enabled ) {
39	$selected_post_types[] = $slug;
40	}
41	}
42	// Default to 'only-on'.
43	return in_array( $post_type_slug, $selected_post_types, true );
44	}
45
46	/**
47	* Add external permalink meta box for enabled post types
48	*
49	* @since 3.9.0
50	*/
51	public function add_external_permalink_meta_box( $post_type, $post ) {
52	$options = get_option( ASENHA_SLUG_U, array() );
53	if ( !$this->is_enabled_for_post_type( $post_type, $options ) ) {
54	return;
55	}
56	// Skip adding meta box for post types where Gutenberg is enabled
57	// if (
58	// function_exists( 'use_block_editor_for_post_type' )
59	// && use_block_editor_for_post_type( $post_type )
60	// ) {
61	// return;
62	// }
63	add_meta_box(
64	'asenha-external-permalink',
65	// ID of meta box
66	'External Permalink',
67	// Title of meta box
68	[$this, 'output_external_permalink_meta_box'],
69	// Callback function
70	$post_type,
71	// The screen on which the meta box should be output to
72	'normal',
73	// context
74	'high'
75	);
76	}
77
78	/**
79	* Render External Permalink meta box
80	*
81	* @since 3.9.0
82	*/
83	public function output_external_permalink_meta_box( $post ) {
84	?>
85	<div class="external-permalink-input">
86	<input name="<?php
87	echo esc_attr( 'external_permalink' );
88	?>" class="large-text" id="<?php
89	echo esc_attr( 'external_permalink' );
90	?>" type="text" value="<?php
91	echo esc_url( get_post_meta( $post->ID, '_links_to', true ) );
92	?>" placeholder="https://" />
93	<div class="external-permalink-input-description">Keep empty to use the default WordPress permalink. External permalink will open in a new browser tab.</div>
94	<?php
95	wp_nonce_field(
96	'external_permalink_' . $post->ID,
97	'external_permalink_nonce',
98	false,
99	true
100	);
101	?>
102	</div>
103	<?php
104	}
105
106	/**
107	* Save external permalink input
108	*
109	* @since 3.9.0
110	*/
111	public function save_external_permalink( $post_id ) {
112	// Only proceed if nonce is verified
113	if ( isset( $_POST['external_permalink_nonce'] ) && wp_verify_nonce( $_POST['external_permalink_nonce'], 'external_permalink_' . $post_id ) ) {
114	$options = get_option( ASENHA_SLUG_U, array() );
115	$post_type = get_post_type( $post_id );
116	if ( !$this->is_enabled_for_post_type( $post_type, $options ) ) {
117	return;
118	}
119	// Get the value of external permalink from input field
120	$external_permalink = ( isset( $_POST['external_permalink'] ) ? esc_url_raw( trim( $_POST['external_permalink'] ) ) : '' );
121	// Update or delete external permalink post meta
122	if ( !empty( $external_permalink ) ) {
123	update_post_meta( $post_id, '_links_to', $external_permalink );
124	} else {
125	delete_post_meta( $post_id, '_links_to' );
126	}
127	}
128	}
129
130	/**
131	* Change WordPress default permalink into external permalink for pages
132	*
133	* @since 3.9.0
134	*/
135	public function use_external_permalink_for_pages( $permalink, $post_id ) {
136	$request_uri = sanitize_text_field( $_SERVER['REQUEST_URI'] );
137	// e.g. /wp-admin/index.php?page=page-slug
138	if ( false === strpos( $request_uri, 'mfn-live-builder' ) ) {
139	// When not in BeTheme template builder, that has the 'action=mfn-live-builder' parameter in the URL
140	$options = get_option( ASENHA_SLUG_U, array() );
141	$post_type = get_post_type( $post_id );
142	if ( !$this->is_enabled_for_post_type( $post_type, $options ) ) {
143	return $permalink;
144	}
145	$external_permalink = get_post_meta( $post_id, '_links_to', true );
146	if ( !empty( $external_permalink ) ) {
147	$permalink = $external_permalink;
148	}
149	}
150	return $permalink;
151	}
152
153	/**
154	* Change WordPress default permalink into external permalink for posts and custom post types
155	*
156	* @since 3.9.0
157	*/
158	public function use_external_permalink_for_posts( $permalink, $post ) {
159	$request_uri = sanitize_text_field( $_SERVER['REQUEST_URI'] );
160	// e.g. /wp-admin/index.php?page=page-slug
161	if ( false === strpos( $request_uri, 'mfn-live-builder' ) ) {
162	// When not in BeTheme template builder, that has the 'action=mfn-live-builder' parameter in the URL
163	$options = get_option( ASENHA_SLUG_U, array() );
164	$post_type = ( is_object( $post ) && isset( $post->post_type ) ? $post->post_type : '' );
165	if ( !$this->is_enabled_for_post_type( $post_type, $options ) ) {
166	return $permalink;
167	}
168	$external_permalink = get_post_meta( $post->ID, '_links_to', true );
169	if ( !empty( $external_permalink ) ) {
170	$permalink = $external_permalink;
171	if ( !is_admin() ) {
172	$permalink = $permalink . '#new_tab';
173	}
174	}
175	}
176	return $permalink;
177	}
178
179	/**
180	* Redirect page/post to external permalink if it's loaded directly from the WP default permalink
181	*
182	* @since 3.9.0
183	*/
184	public function redirect_to_external_permalink() {
185	// If not on/loading the single page/post URL, do nothing
186	if ( !is_singular() ) {
187	return;
188	}
189	global $post;
190	if ( !is_null( $post ) && is_object( $post ) && is_a( $post, 'WP_Post' ) ) {
191	$options = get_option( ASENHA_SLUG_U, array() );
192	if ( empty( $post->post_type ) \|\| !$this->is_enabled_for_post_type( $post->post_type, $options ) ) {
193	return;
194	}
195	if ( property_exists( $post, 'ID' ) ) {
196	$external_permalink = get_post_meta( $post->ID, '_links_to', true );
197	if ( !empty( $external_permalink ) ) {
198	wp_redirect( $external_permalink, 302 );
199	// temporary redirect
200	exit;
201	}
202	}
203	}
204	}
205
206	}
207