get_preview_post_link( int|WP_Post $post = null, array $query_args = array(), string $preview_link = '' ): string|null

Description

Parameters

$postint|WP_Postoptional

Post ID or WP_Post object. Defaults to global $post.Default: null

$query_argsarrayoptional

Array of additional query args to be appended to the link. Default empty array.Default: array()

$preview_linkstringoptional

Base preview link to be used if it should differ from the post permalink. Default empty.Default: ''

Return

string|null

URL used for the post preview, or null if the post does not exist.

Hooks fired · 1

One hook fires while get_preview_post_link() runs, in this order:

1. 1
   apply_filters( preview_post_link )filterline 1434 (+26 into the body)

   Filters the URL used for a post preview.

Uses · 7

• get_post()Retrieves post data given a post ID or post object.
• get_post_type_object()Retrieves a post type object by name.
• is_post_type_viewable()Determines whether a post type is considered "viewable".
• set_url_scheme()Sets the scheme for a URL.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• add_query_arg()Retrieves a modified URL query string.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 9

• WP_Posts_List_Table::handle_row_actions()Generates and displays row action links.
• WP_REST_Autosaves_Controller::prepare_item_for_response()Prepares the revision for the REST response.
• _admin_notice_post_locked()Outputs the HTML for the notice to say that someone else is editing or has taken over editing of this post.
• _wp_link_page()Helper function for wp_link_pages().
• get_sample_permalink_html()Returns the HTML of the sample permalink slug editor.
• post_preview()Saves a draft or manually autosaves for the purpose of showing a post preview.
• post_submit_meta_box()Displays post submit form fields.
• wp_admin_bar_edit_menu()Provides an edit link for posts and terms.
• wp_ajax_get_permalink()Handles retrieving a permalink via AJAX.

Source

View on Trac ↗View on GitHub ↗

1408function get_preview_post_link( $post = null, $query_args = array(), $preview_link = '' ) {1409	$post = get_post( $post );1410 1411	if ( ! $post ) {1412		return null;1413	}1414 1415	$post_type_object = get_post_type_object( $post->post_type );1416	if ( is_post_type_viewable( $post_type_object ) ) {1417		if ( ! $preview_link ) {1418			$preview_link = set_url_scheme( get_permalink( $post ) );1419		}1420 1421		$query_args['preview'] = 'true';1422		$preview_link          = add_query_arg( $query_args, $preview_link );1423	}1424 1425	/**1426	 * Filters the URL used for a post preview.1427	 *1428	 * @since 2.0.51429	 * @since 4.0.0 Added the `$post` parameter.1430	 *1431	 * @param string  $preview_link URL used for the post preview.1432	 * @param WP_Post $post         Post object.1433	 */1434	return apply_filters( 'preview_post_link', $preview_link, $post );1435}

History

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/link-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.