Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2025-03-02 11:21:57 +01:00
Code Issues Projects Releases Wiki Activity

Docs: Improve JSDoc for wp-admin/js/user-suggest.js.

Browse Source 
Props timhavinga.
Fixes #43270.

Built from https://develop.svn.wordpress.org/trunk@42708


git-svn-id: http://core.svn.wordpress.org/trunk@42536 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
atimmer 2018-02-13 15:38:31 +00:00
parent 68a3e7745a
commit 87130f0e20
2 changed files with 34 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
wp-admin/js/user-suggest.js
View File

@ -1,4 +1,14 @@
/* global ajaxurl, current_site_id, isRtl */
/**
* Suggests users in a multisite environment.
*
* For input fields where the admin can select a user based on email or
* username, this script shows an autocompletion menu for these inputs. Should
* only be used in a multisite environment. Only users in the currently active
* site are shown.
*
* @since 3.4.0
*/
(function( $ ) {
var id = ( typeof current_site_id !== 'undefined' ) ? '&site_id=' + current_site_id : '';
@ -8,6 +18,29 @@
position.my = 'right top';
position.at = 'right bottom';
}
/**
* Adds an autocomplete function to input fields marked with the class
* 'wp-suggest-user'.
*
* A minimum of two characters is required to trigger
* the suggestions. The autocompletion menu is shown at the left bottom of the input
* field. On RTL installations, it is shown at the right top.
* Adds the class 'open' to the input field when the autocompletion menu
* is shown.
*
* Does a backend call to retrieve the users.
*
* Optional data-attributes:
* - data-autocomplete-type (add, search)
* The action that is going to be performed: search for existing users
* or add a new one. Default: add
* - data-autocomplete-field (user_login, user_email)
* The field that is returned as the value for the suggestion.
* Default: user_login
*
* @see wp-admin/includes/admin-actions.php:wp_ajax_autocomplete_user()
*/
$( '.wp-suggest-user' ).each( function(){
var $this = $( this ),
autocompleteType = ( typeof $this.data( 'autocompleteType' ) !== 'undefined' ) ? $this.data( 'autocompleteType' ) : 'add',

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.0-alpha-42707';
$wp_version = '5.0-alpha-42708';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.