get_sample_permalink_html
Filter HookDescription
Filters the sample permalink HTML markup.Hook Information
File Location |
wp-admin/includes/post.php
View on GitHub
|
Hook Type | Filter |
Line Number | 1624 |
Hook Parameters
Type | Name | Description |
---|---|---|
string
|
$return
|
Sample permalink HTML markup. |
int
|
$post_id
|
Post ID. |
string|null
|
$new_title
|
New sample permalink title. |
string|null
|
$new_slug
|
New sample permalink slug. |
WP_Post
|
$post
|
Post object. |
Usage Examples
Basic Usage
<?php
// Hook into get_sample_permalink_html
add_filter('get_sample_permalink_html', 'my_custom_filter', 10, 5);
function my_custom_filter($return, $post_id, $new_title, $new_slug, $post) {
// Your custom filtering logic here
return $return;
}
Source Code Context
wp-admin/includes/post.php:1624
- How this hook is used in WordPress core
<?php
1619 * @param int $post_id Post ID.
1620 * @param string|null $new_title New sample permalink title.
1621 * @param string|null $new_slug New sample permalink slug.
1622 * @param WP_Post $post Post object.
1623 */
1624 $return = apply_filters( 'get_sample_permalink_html', $return, $post->ID, $new_title, $new_slug, $post );
1625
1626 return $return;
1627 }
1628
1629 /**
PHP Documentation
<?php
/**
* Filters the sample permalink HTML markup.
*
* @since 2.9.0
* @since 4.4.0 Added `$post` parameter.
*
* @param string $return Sample permalink HTML markup.
* @param int $post_id Post ID.
* @param string|null $new_title New sample permalink title.
* @param string|null $new_slug New sample permalink slug.
* @param WP_Post $post Post object.
*/
Quick Info
- Hook Type: Filter
- Parameters: 5
- File: wp-admin/includes/post.php
Related Hooks
Related hooks will be displayed here in future updates.