WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_the_password_form()

get_the_password_form( int|WP_Post $post ): string

In this article

Back to top

Retrieves protected post password form content.

Parameters

$postint|WP_Postoptional
Post ID or WP_Post object. Default is global $post.

Return

string HTML content for password form for password protected post.

Source

function get_the_password_form( $post = 0 ) {
	$post   = get_post( $post );
	$label  = 'pwbox-' . ( empty( $post->ID ) ? rand() : $post->ID );
	$output = '<form action="' . esc_url( site_url( 'wp-login.php?action=postpass', 'login_post' ) ) . '" class="post-password-form" method="post">
	<p>' . __( 'This content is password protected. To view it please enter your password below:' ) . '</p>
	<p><label for="' . $label . '">' . __( 'Password:' ) . ' <input name="post_password" id="' . $label . '" type="password" spellcheck="false" size="20" /></label> <input type="submit" name="Submit" value="' . esc_attr_x( 'Enter', 'post password form' ) . '" /></p></form>
	';

	/**
	 * Filters the HTML output for the protected post password form.
	 *
	 * If modifying the password field, please note that the WordPress database schema
	 * limits the password field to 255 characters regardless of the value of the
	 * `minlength` or `maxlength` attributes or other validation that may be added to
	 * the input.
	 *
	 * @since 2.7.0
	 * @since 5.8.0 Added the `$post` parameter.
	 *
	 * @param string  $output The password form HTML output.
	 * @param WP_Post $post   Post object.
	 */
	return apply_filters( 'the_password_form', $output, $post );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘the_password_form’, string $output, WP_Post $post )

Filters the HTML output for the protected post password form.

UsesDescription
site_url()wp-includes/link-template.php

Retrieves the URL for the current site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.

esc_url()wp-includes/formatting.php

Checks and cleans a URL.

apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

Show 2 moreShow less
Used byDescription
get_the_content()wp-includes/post-template.php

Retrieves the post content.

Changelog

VersionDescription
1.0.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Laurent MILLET
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    Example:

    add_filter( 'the_password_form', 'wporg_password_form' );
function wporg_password_form() {
    global $post;
    $label = 'pwbox-' . ( empty( $post->ID ) ? rand() : $post->ID );
    $output = '<form action="' . esc_url( site_url( 'wp-login.php?action=postpass', 'login_post' ) ) . '" class="post-password-form" method="post">
    ' . esc_html__( 'New Text for my protected post', 'text-domain' ) . '
    <label class="pass-label" for="' . $label . '">' . esc_html__( 'Password:', 'text-domain' ) . ' </label><input name="post_password" id="' . $label . '" type="password" size="20" style="background: #ffffff; border:1px solid #999; color:#333333; padding:10px;" size="20" /><input type="submit" name="Submit" class="button" value="' . esc_attr__( 'Submit', 'text-domain' ) . '" />
    </form><p class="text-below">' . esc_html__( 'Additional text to be placed below', 'text-domain' ) . '</p>
    ';
    return $output;
}

    And you can use css like :

    .text-below {
	color : red;
	font-size:14px;
	margin:0;
	padding:10px
}

    and hide or modifiy label :

    .pass-label {
display : none;
}

    And adapt the button too : :

    .button {
    background-color: #000;
    color:#fff;
    border: 0;
    margin: 0;
    height: 33px;
    padding: 0 6px 6px 6px;
    font-size: 15px;
}

You must log in before being able to contribute a note or feedback.