wp_xmlrpc_server::login( string $username, string $password )

Log user in.

Contents

Description Description

Parameters Parameters

$username

(string) (Required) User's username.

$password

(string) (Required) User's password.

Top ↑

Return Return

(WP_User|bool) WP_User object if authentication passed, false otherwise

Top ↑

Source Source

File: wp-includes/class-wp-xmlrpc-server.php 

	public function login( $username, $password ) {
		/*
		 * Respect old get_option() filters left for back-compat when the 'enable_xmlrpc'
		 * option was deprecated in 3.5.0. Use the 'xmlrpc_enabled' hook instead.
		 */
		$enabled = apply_filters( 'pre_option_enable_xmlrpc', false );
		if ( false === $enabled ) {
			$enabled = apply_filters( 'option_enable_xmlrpc', true );
		}

		/**
		 * Filters whether XML-RPC methods requiring authentication are enabled.
		 *
		 * Contrary to the way it's named, this filter does not control whether XML-RPC is *fully*
		 * enabled, rather, it only controls whether XML-RPC methods requiring authentication - such
		 * as for publishing purposes - are enabled.
		 *
		 * Further, the filter does not control whether pingbacks or other custom endpoints that don't
		 * require authentication are enabled. This behavior is expected, and due to how parity was matched
		 * with the `enable_xmlrpc` UI option the filter replaced when it was introduced in 3.5.
		 *
		 * To disable XML-RPC methods that require authentication, use:
		 *
		 *     add_filter( 'xmlrpc_enabled', '__return_false' );
		 *
		 * For more granular control over all XML-RPC methods and requests, see the {@see 'xmlrpc_methods'}
		 * and {@see 'xmlrpc_element_limit'} hooks.
		 *
		 * @since 3.5.0
		 *
		 * @param bool $enabled Whether XML-RPC is enabled. Default true.
		 */
		$enabled = apply_filters( 'xmlrpc_enabled', $enabled );

		if ( ! $enabled ) {
			$this->error = new IXR_Error( 405, sprintf( __( 'XML-RPC services are disabled on this site.' ) ) );
			return false;
		}

		if ( $this->auth_failed ) {
			$user = new WP_Error( 'login_prevented' );
		} else {
			$user = wp_authenticate( $username, $password );
		}

		if ( is_wp_error( $user ) ) {
			$this->error = new IXR_Error( 403, __( 'Incorrect username or password.' ) );

			// Flag that authentication has failed once on this wp_xmlrpc_server instance
			$this->auth_failed = true;

			/**
			 * Filters the XML-RPC user login error message.
			 *
			 * @since 3.5.0
			 *
			 * @param string   $error The XML-RPC error message.
			 * @param WP_Error $user  WP_Error object.
			 */
			$this->error = apply_filters( 'xmlrpc_login_error', $this->error, $user );
			return false;
		}

		wp_set_current_user( $user->ID );
		return $user;
	}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.8.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/pluggable.php: wp_authenticate()

Authenticate a user, confirming the login credentials are valid.
wp-includes/pluggable.php: wp_set_current_user()

Changes the current user by ID or name.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/class-wp-xmlrpc-server.php: xmlrpc_enabled

Filters whether XML-RPC methods requiring authentication are enabled.
wp-includes/class-wp-xmlrpc-server.php: xmlrpc_login_error

Filters the XML-RPC user login error message.
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.
wp-includes/class-wp-error.php: WP_Error::__construct()

Initialize the error.
Show 3 more uses Hide more uses

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mt_getPostCategories()

Retrieve post categories.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mt_setPostCategories()

Sets categories for a post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mt_publishPost()

Sets a post’s publish status to ‘publish’.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_editPost()

Edit a post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_getPost()

Retrieve post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_getRecentPosts()

Retrieve list of recent posts.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_getCategories()

Retrieve the list of categories on a given blog.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_newMediaObject()

Uploads a file, following your settings.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mt_getRecentPostTitles()

Retrieve the post titles of recent posts.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mt_getCategoryList()

Retrieve list of all categories on blog.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::blogger_getUserInfo()

Retrieve user’s data.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::blogger_getPost()

Retrieve post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::blogger_getRecentPosts()

Retrieve list of recent posts.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::blogger_newPost()

Creates new post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::blogger_editPost()

Edit a post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::blogger_deletePost()

Remove a post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_newPost()

Create a new post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getOptions()

Retrieve blog options.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_setOptions()

Update blog options.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getMediaItem()

Retrieve a media item by ID
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getMediaLibrary()

Retrieves a collection of media library items (or attachments)
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPostFormats()

Retrieves a list of post formats used by the site.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPostType()

Retrieves a post type
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPostTypes()

Retrieves a post types
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getRevisions()

Retrieve revisions for a specific post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_restoreRevision()

Restore a post revision
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::blogger_getUsersBlogs()

Retrieve blogs that user owns.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getComments()

Retrieve comments.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_deleteComment()

Delete a comment.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_editComment()

Edit comment.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_newComment()

Create new comment.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getCommentStatusList()

Retrieve all of the comment status.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getCommentCount()

Retrieve comment count.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPostStatusList()

Retrieve post statuses.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPageStatusList()

Retrieve page statuses.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPageTemplates()

Retrieve page templates.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPages()

Retrieve Pages.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_newPage()

Create new page.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_deletePage()

Delete page.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_editPage()

Edit page.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPageList()

Retrieve page list.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getAuthors()

Retrieve authors list.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getTags()

Get list of all tags
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_newCategory()

Create new category.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_deleteCategory()

Remove category.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_suggestCategories()

Retrieve category list.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getComment()

Retrieve comment.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPosts()

Retrieve posts.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_newTerm()

Create a new term.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_editTerm()

Edit a term.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_deleteTerm()

Delete a term.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getTerm()

Retrieve a term.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getTerms()

Retrieve all terms for a taxonomy.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getTaxonomy()

Retrieve a taxonomy.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getTaxonomies()

Retrieve all taxonomies.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getUser()

Retrieve a user.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getUsers()

Retrieve users.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getProfile()

Retrieve information about the requesting user.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_editProfile()

Edit user’s profile.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPage()

Retrieve page.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_newPost()

Create a new post for any registered post type.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_editPost()

Edit a post for any registered post type.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_deletePost()

Delete a post for any registered post type.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPost()

Retrieve a post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getUsersBlogs()

Retrieve the blogs of the user.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::login_pass_ok()

Check user’s credentials. Deprecated.
Show 61 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

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