Merge branch 'master' of github.com:athlan/wordpress-custom-fields-permalink-plugin

Author: athlan

includes/class-customfieldspermalink.php

@@ -13,13 +13,6 @@ class CustomFieldsPermalink {
 	const PARAM_CUSTOMFIELD_KEY   = 'custom_field_key';
 	const PARAM_CUSTOMFIELD_VALUE = 'custom_field_value';
 
-	/**
-	 * Do check against meta value or not.
-	 *
-	 * @var bool
-	 */
-	private static $check_custom_field_value = false;
-
 	/**
 	 * Filters the permalink structure for a post before token replacement occurs..
 	 * The pre_post_link filter implementation.
@@ -78,7 +71,7 @@ private static function link_rewrite_fields( $permalink, $post ) {
 	 * @return string
 	 */
 	public static function link_rewrite_fields_extract( $post, $field_name ) {
-		$post_meta = get_post_meta( $post->ID );
+		$post_meta = self::get_post_meta( $post );
 
 		if ( ! isset( $post_meta[ $field_name ] ) ) {
 			return '';
@@ -120,24 +113,74 @@ public static function register_extra_query_vars( $public_query_vars ) {
 	public static function process_request( $query_vars ) {
 		// Additional parameters added to WordPress.
 		// Main Loop query.
-		if ( array_key_exists( self::PARAM_CUSTOMFIELD_KEY, $query_vars ) ) {
-			$query_vars['meta_key'] = $query_vars[ self::PARAM_CUSTOMFIELD_KEY ];
+		return $query_vars;
+	}
+
+	/**
+	 * Filters whether to short-circuit default header status handling.
+	 *
+	 * Raises 404 if post has been rewrited, but:
+	 * 1. Custom field key does not exists or
+	 * 2. Custom field value does not matches.
+	 *
+	 * @param bool     $preempt  Whether to short-circuit default header status handling. Default false.
+	 * @param WP_Query $wp_query WordPress Query object.
+	 *
+	 * @return bool Returning a non-false value from the filter will short-circuit the handling
+	 * and return early.
+	 *
+	 * @link https://developer.wordpress.org/reference/hooks/pre_handle_404/
+	 */
+	public static function pre_handle_404( $preempt, $wp_query ) {
+		// Analyse only if there is post parsed.
+		if ( ! is_single() ) {
+			return false;
+		}
+
+		$post = $wp_query->post;
+
+		// Analyse only if custom field used in query.
+		if ( ! array_key_exists( self::PARAM_CUSTOMFIELD_KEY, $wp_query->query_vars ) ) {
+			return false;
+		}
+
+		$raise_404 = false;
+
+		$post_meta = self::get_post_meta( $post );
 
-			// Remove temporary injected parameter.
-			unset( $query_vars[ self::PARAM_CUSTOMFIELD_KEY ] );
+		$query_meta_key = $wp_query->query_vars[ self::PARAM_CUSTOMFIELD_KEY ];
 
-			// Do not check field's value for this moment.
-			if ( true === self::$check_custom_field_value ) {
-				if ( array_key_exists( self::PARAM_CUSTOMFIELD_VALUE, $query_vars ) ) {
-					$query_vars['meta_value'] = $query_vars[ self::PARAM_CUSTOMFIELD_VALUE ];
+		if ( ! array_key_exists( $query_meta_key, $post_meta ) ) {
+			$raise_404 = true;
+		} else {
+			$query_meta_value = $wp_query->query_vars[ self::PARAM_CUSTOMFIELD_VALUE ];
 
-					// Remove temporary injected parameter.
-					unset( $query_vars[ self::PARAM_CUSTOMFIELD_VALUE ] );
+			// Look for at least one value match.
+			$value_matched = false;
+			foreach ( $post_meta[ $query_meta_key ] as $post_meta_value ) {
+				$post_meta_value_sanitized = sanitize_title( $post_meta_value );
+
+				if ( $query_meta_value == $post_meta_value_sanitized ) {
+					$value_matched = true;
+					break;
 				}
 			}
+
+			if ( ! $value_matched ) {
+				$raise_404 = true;
+			}
 		}
 
-		return $query_vars;
+		if ( $raise_404 ) {
+			$wp_query->set_404();
+			status_header( 404 );
+			nocache_headers();
+
+			// 404 already raised, break the circuit.
+			return true;
+		}
+
+		return false;
 	}
 
 	/**
@@ -181,4 +224,36 @@ public static function rewrite_rules_array_filter( $rules ) {
 
 		return $rules;
 	}
+
+	/**
+	 * Get post meta applying <code>wpcfp_get_post_metadata</code> filter.
+	 *
+	 * @param WP_Post $post The post.
+	 *
+	 * @return array
+	 */
+	private static function get_post_meta( $post ) {
+		$post_meta = get_post_meta( $post->ID );
+
+		/**
+		 * Filters of retrieved metadata of a post to link rewrite.
+		 *
+		 * @since 1.2.0
+		 *
+		 * @param array   $post_meta  The metadata returned from get_post_meta.
+		 * @param WP_Post $post       The post object.
+		 */
+		$filtered_post_meta = apply_filters( 'wpcfp_get_post_metadata', $post_meta, $post );
+
+		// Do some fixes after user generated values.
+		// If it's single value, wrap this in array, as WordPress internally does.
+		// @see get_post_meta() with $single = false.
+		foreach ( $filtered_post_meta as $key => &$value ) {
+			if ( ! is_array( $value ) ) {
+				$value = array( $value );
+			}
+		}
+
+		return $filtered_post_meta;
+	}
 }

readme.txt

@@ -50,6 +50,18 @@ We would be very grateful in any contribution. If you have a idea for the featur
 When the assumptions are ready, please
 <a href="https://github.com/athlan/wordpress-custom-fields-permalink-plugin/pulls">make a pull request</a> at GitHub.
 
+= How to generate missing custom post meta keys and values =
+
+In case of missing custom post field values you can generate them on-the-fly using <a href="https://github.com/athlan/wordpress-custom-fields-permalink-plugin/wiki/Plugin-hooks#generate_dynamic_metadata"><code>generate_dynamic_metadata</code></a> filter.
+
+Read <a href="https://github.com/athlan/wordpress-custom-fields-permalink-plugin/wiki/FAQ#how-to-generate-missing-custom-post-meta-keys-and-values">the example</a>.
+
+= How to generate calculated dynamic custom post meta keys and values =
+
+You can generate custom post fields dynamically coding some logic using  <a href="https://github.com/athlan/wordpress-custom-fields-permalink-plugin/wiki/Plugin-hooks#generate_dynamic_metadata"><code>generate_dynamic_metadata</code></a> filter.
+
+Read <a href="https://github.com/athlan/wordpress-custom-fields-permalink-plugin/wiki/FAQ#how-to-generate-calculated-dynamic-custom-post-meta-keys-and-values">the example</a>.
+
 == Screenshots ==
 
 1. Pemralink settings

test/suites/MetaKeyPermalinkStructure/PostWithDynamicallyCreatedMetaKey.php

@@ -10,6 +10,29 @@
  */
 class PostWithDynamicallyCreatedMetaKey extends BaseTestCase {
 
+	/**
+	 * Sample custom metadata filter that adds some metadata to the array.
+	 *
+	 * @param array   $post_meta  The metadata returned from get_post_meta.
+	 * @param WP_Post $post       The post object.
+	 *
+	 * @return array metadata
+	 */
+	function generate_dynamic_metadata( $post_meta = null, $post = null ) {
+		if ( ! array_key_exists( 'some_meta_key', $post_meta ) ) {
+			$post_meta['some_meta_key'] = 'Default value';
+		}
+
+		return $post_meta;
+	}
+
+	/**
+	 * Test step that hook wpcfp_get_post_metadata has been registered.
+	 */
+	private function given_hook_registered() {
+		add_filter( 'wpcfp_get_post_metadata', array( $this, 'generate_dynamic_metadata' ), 1, 2 );
+	}
+
 	/**
 	 * Test case.
 	 */
@@ -26,14 +49,16 @@ function test_generates_permalink_to_post_while_missing_meta_key() {
 		);
 		$created_post_id = $this->factory()->post->create( $post_params );
 
+		$this->given_hook_registered();
+
 		// when & then.
-		$this->permalink_asserter->has_permalink( $created_post_id, '/some-post-title/' );
+		$this->permalink_asserter->has_permalink( $created_post_id, '/default-value/some-post-title/' );
 	}
 
 	/**
 	 * Test case.
 	 */
-	function test_404_when_missing_meta_key() {
+	function test_go_to_post_when_dynamic_generated_meta_value_without_hook() {
 		// given.
 		$this->permalink_steps->given_permalink_structure( '/%field_some_meta_key%/%postname%/' );
 
@@ -47,7 +72,7 @@ function test_404_when_missing_meta_key() {
 		$created_post_id = $this->factory()->post->create( $post_params );
 
 		// when.
-		$this->go_to( '/inexisting-meta-value/some-post-title/' );
+		$this->go_to( '/default-value/some-post-title/' );
 
 		// then.
 		$this->navigation_asserter->then_not_displayed_post( $created_post_id )
@@ -58,22 +83,25 @@ function test_404_when_missing_meta_key() {
 	/**
 	 * Test case.
 	 */
-	function test_not_go_to_the_post_when_missing_meta_key_part_in_url() {
+	function test_go_to_post_when_dynamic_generated_meta_value_with_hook() {
 		// given.
 		$this->permalink_steps->given_permalink_structure( '/%field_some_meta_key%/%postname%/' );
 
 		$post_params     = array(
 			'post_title' => 'Some post title',
 			'meta_input' => array(
-				'some_meta_key' => 'Some meta value',
+				// There is missing meta key here
+				// 'some_meta_key' => 'Some meta value', .
 			),
 		);
 		$created_post_id = $this->factory()->post->create( $post_params );
 
+		$this->given_hook_registered();
+
 		// when.
-		$this->go_to( '/some-post-title/' );
+		$this->go_to( '/default-value/some-post-title/' );
 
 		// then.
-		$this->navigation_asserter->then_not_displayed_post( $created_post_id );
+		$this->navigation_asserter->then_displayed_post( $created_post_id );
 	}
 }

wordpress-custom-fields-permalink-plugin.php

@@ -21,3 +21,4 @@
 add_filter( 'rewrite_rules_array', array( 'CustomFieldsPermalink', 'rewrite_rules_array_filter' ) );
 add_filter( 'query_vars', array( 'CustomFieldsPermalink', 'register_extra_query_vars' ), 10, 1 );
 add_filter( 'request', array( 'CustomFieldsPermalink', 'process_request' ), 10, 1 );
+add_filter( 'pre_handle_404', array( 'CustomFieldsPermalink', 'pre_handle_404' ), 10, 2 );