wp_force_plain_post_permalink() – Function

Determine whether post should always use a plain permalink structure.

Parameters

$postWP_Post|int|nulloptional: Post ID or post object. Defaults to global $post.
Default:null
$samplebool|nulloptional: Whether to force consideration based on sample links.
If omitted, a sample link is generated if a post object is passed with the filter property set to 'sample'.
Default:null

Return

bool Whether to use a plain permalink structure.

Source

function wp_force_plain_post_permalink( $post = null, $sample = null ) {
	if (
		null === $sample &&
		is_object( $post ) &&
		isset( $post->filter ) &&
		'sample' === $post->filter
	) {
		$sample = true;
	} else {
		$post   = get_post( $post );
		$sample = null !== $sample ? $sample : false;
	}

	if ( ! $post ) {
		return true;
	}

	$post_status_obj = get_post_status_object( get_post_status( $post ) );
	$post_type_obj   = get_post_type_object( get_post_type( $post ) );

	if ( ! $post_status_obj || ! $post_type_obj ) {
		return true;
	}

	if (
		// Publicly viewable links never have plain permalinks.
		is_post_status_viewable( $post_status_obj ) ||
		(
			// Private posts don't have plain permalinks if the user can read them.
			$post_status_obj->private &&
			current_user_can( 'read_post', $post->ID )
		) ||
		// Protected posts don't have plain links if getting a sample URL.
		( $post_status_obj->protected && $sample )
	) {
		return false;
	}

	return true;
}

View all references View on Trac View on GitHub

Uses	Description
is_post_status_viewable()`wp-includes/post.php`	Determines whether a post status is considered “viewable”.
get_post_status_object()`wp-includes/post.php`	Retrieves a post status object by name.
get_post_status()`wp-includes/post.php`	Retrieves the post status based on the post ID.
get_post_type()`wp-includes/post.php`	Retrieves the post type of the current post or of a given post.
current_user_can()`wp-includes/capabilities.php`	Returns whether the current user has the specified capability.
get_post()`wp-includes/post.php`	Retrieves post data given a post ID or post object.
get_post_type_object()`wp-includes/post.php`	Retrieves a post type object by name.

Show 3 more Show less

Used by	Description
get_permalink()`wp-includes/link-template.php`	Retrieves the full permalink for the current post or post ID.
get_post_permalink()`wp-includes/link-template.php`	Retrieves the permalink for a post of a custom post type.
_get_page_link()`wp-includes/link-template.php`	Retrieves the page permalink.
get_attachment_link()`wp-includes/link-template.php`	Retrieves the permalink for an attachment.

Changelog

Version	Description
5.7.0	Introduced.

User Contributed Notes

Rodrigo Vieira Eufrasio da Silva 1 year ago

// Get the current post
$current_post = get_post();

// Checks if the post should use a simple permalink structure
$force_plain_permalink = wp_force_plain_post_permalink( $current_post );

// Use the result to customize the permalink output
if ( $force_plain_permalink ) {
    echo trailingslashit( esc_url( get_permalink( $current_post ) ) ); // Add a slash at the end for a simple permalink structure
} else {
    echo esc_url( get_permalink( $current_post ) ); // Uses the standard permalink structure
}

wp_force_plain_post_permalink( WP_Post|int|null $post = null, bool|null $sample = null ): bool

In this article

Parameters

Return

Source

Changelog

User Contributed Notes

wp_force_plain_post_permalink( WP_Post|int|null $post = null, bool|null $sample = null ): bool

In this article

Parameters

Return

Source

Related

Changelog

User Contributed Notes