266 lines
15 KiB
PHP
266 lines
15 KiB
PHP
<?php
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) exit;
|
|
|
|
class ACUI_Doc{
|
|
|
|
static function get_sections(){
|
|
$sections = array(
|
|
array(
|
|
'id' => 'example',
|
|
'title' => __( 'Example', 'import-users-from-csv-with-meta' ),
|
|
'content' => self::section_example(),
|
|
),
|
|
array(
|
|
'id' => 'columns',
|
|
'title' => __( 'Columns position', 'import-users-from-csv-with-meta' ),
|
|
'content' => self::section_columns(),
|
|
),
|
|
array(
|
|
'id' => 'id',
|
|
'title' => __( 'id (column id)', 'import-users-from-csv-with-meta' ),
|
|
'content' => self::section_id(),
|
|
),
|
|
array(
|
|
'id' => 'passwords',
|
|
'title' => __( 'Passwords (column password and user_pass)', 'import-users-from-csv-with-meta' ),
|
|
'content' => self::section_passwords(),
|
|
),
|
|
array(
|
|
'id' => 'roles',
|
|
'title' => __( 'Roles (column role)', 'import-users-from-csv-with-meta' ),
|
|
'content' => self::section_roles(),
|
|
),
|
|
array(
|
|
'id' => 'serialized',
|
|
'title' => __( 'Serialized data', 'import-users-from-csv-with-meta' ),
|
|
'content' => self::section_serialized(),
|
|
),
|
|
array(
|
|
'id' => 'lists',
|
|
'title' => __( 'Lists', 'import-users-from-csv-with-meta' ),
|
|
'content' => self::section_lists(),
|
|
),
|
|
array(
|
|
'id' => 'arrays',
|
|
'title' => __( 'Arrays with string keys', 'import-users-from-csv-with-meta' ),
|
|
'content' => self::section_arrays(),
|
|
),
|
|
array(
|
|
'id' => 'force_user_reset_password',
|
|
'title' => __( 'Force users to reset their passwords', 'import-users-from-csv-with-meta' ),
|
|
'content' => self::section_force_reset_password(),
|
|
),
|
|
array(
|
|
'id' => 'wp_profile',
|
|
'title' => __( 'WordPress default profile data', 'import-users-from-csv-with-meta' ),
|
|
'content' => self::section_wp_profile(),
|
|
),
|
|
array(
|
|
'id' => 'cron',
|
|
'title' => __( 'Cron', 'import-users-from-csv-with-meta' ),
|
|
'content' => self::section_cron(),
|
|
),
|
|
);
|
|
|
|
$sections = apply_filters( 'acui_documentation_sections', $sections );
|
|
|
|
// backward compat: addons that used do_action('acui_documentation_after_plugins_activated')
|
|
// to output raw <tr> rows should migrate to the acui_documentation_sections filter.
|
|
// We keep the action alive inside a dedicated row so nothing breaks.
|
|
if( has_action( 'acui_documentation_after_plugins_activated' ) ){
|
|
ob_start();
|
|
do_action( 'acui_documentation_after_plugins_activated' );
|
|
$legacy_html = ob_get_clean();
|
|
if( $legacy_html ){
|
|
$sections[] = array(
|
|
'id' => '_legacy_addons',
|
|
'title' => '',
|
|
'content' => $legacy_html,
|
|
);
|
|
}
|
|
}
|
|
|
|
$sections[] = array(
|
|
'id' => 'hooks',
|
|
'title' => __( 'Hooks', 'import-users-from-csv-with-meta' ),
|
|
'content' => self::section_hooks(),
|
|
);
|
|
$sections[] = array(
|
|
'id' => 'support',
|
|
'title' => __( 'Any question about it?', 'import-users-from-csv-with-meta' ),
|
|
'content' => self::section_support(),
|
|
);
|
|
|
|
return $sections;
|
|
}
|
|
|
|
static function get_section( $id ){
|
|
foreach( self::get_sections() as $section ){
|
|
if( $section['id'] === $id )
|
|
return $section;
|
|
}
|
|
return null;
|
|
}
|
|
|
|
static function message(){
|
|
?>
|
|
<h3><?php _e( 'Documentation', 'import-users-from-csv-with-meta' ); ?></h3>
|
|
<table class="form-table">
|
|
<tbody>
|
|
<?php foreach( self::get_sections() as $section ): ?>
|
|
<tr valign="top" id="<?php echo esc_attr( $section['id'] ); ?>">
|
|
<th scope="row"><?php echo $section['title']; ?></th>
|
|
<td><?php echo $section['content']; ?></td>
|
|
</tr>
|
|
<?php endforeach; ?>
|
|
</tbody>
|
|
</table>
|
|
<br/>
|
|
<div style="width:775px;margin:0 auto"><img src="<?php echo esc_url( plugins_url( 'csv_example.png', dirname( __FILE__ ) ) ); ?>"/></div>
|
|
|
|
<script>
|
|
jQuery( document ).ready( function( $ ){
|
|
$( '#delete_all_metadata_forcing_password_change' ).click( function(){
|
|
var r = confirm( '<?php _e( 'Are you sure?', 'import-users-from-csv-with-meta' ); ?>' );
|
|
|
|
if( !r )
|
|
return;
|
|
|
|
var data = {
|
|
'action': 'acui_force_reset_password_delete_metas',
|
|
'security': '<?php echo wp_create_nonce( "codection-security" ); ?>'
|
|
};
|
|
|
|
$.post( ajaxurl, data, function( response ) {
|
|
if( response == "ERROR" )
|
|
alert( "<?php _e( 'Problems executing task: ', 'import-users-from-csv-with-meta' ); ?>" + response );
|
|
else
|
|
alert( "<?php _e( 'Task successfully executed: ', 'import-users-from-csv-with-meta' ); ?> " + response + " <?php _e( ' rows deleted', 'import-users-from-csv-with-meta' ); ?>" );
|
|
});
|
|
} );
|
|
} )
|
|
</script>
|
|
<?php
|
|
}
|
|
|
|
// -------------------------------------------------------------------------
|
|
// Sections
|
|
// -------------------------------------------------------------------------
|
|
|
|
static function section_columns(){
|
|
return
|
|
'<small><em>' . __( "You can name these first two columns whatever you want; only the order matters. In the rest of the columns, the order doesn't matter, but what you name them is what matters.", 'import-users-from-csv-with-meta' ) . '</em></small>'
|
|
. '<ol>'
|
|
. '<li>' . __( 'Username: you can leave it empty and the username will be generated randomly', 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li>' . __( 'Email:', 'import-users-from-csv-with-meta' ) . ' ' . apply_filters( 'acui_documentation_email_message', sprintf( __( 'required, although you can use <a href="%s">this addon to allow users to be imported without an associated email address</a>.', 'import-users-from-csv-with-meta' ), 'https://import-wp.com/allow-no-email-addon/' ) ) . '</li>'
|
|
. '</ol>'
|
|
. '<small><em>' . __( '(The next columns are totally customizable and you can use whatever you want. All rows must contains the same columns)', 'import-users-from-csv-with-meta' ) . '</em></small>'
|
|
. '<small><em>' . __( '(User profile will be adapted to the kind of data you have selected)', 'import-users-from-csv-with-meta' ) . '</em></small>'
|
|
. '<small><em>' . __( '(If you want to disable the extra profile information, please deactivate this plugin after making the import)', 'import-users-from-csv-with-meta' ) . '</em></small>';
|
|
}
|
|
|
|
static function section_id(){
|
|
return
|
|
__( "You can use a column called id in order to make inserts or updates of an user using the ID used by WordPress in the wp_users table. We have two different cases:", 'import-users-from-csv-with-meta' )
|
|
. '<ul style="list-style:disc outside none; margin-left:2em;">'
|
|
. '<li>' . __( "If ID <strong>doesn't exist in your user table</strong>: WordPress core does not allow us to insert it, so it will throw an error of type: invalid_user_id", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li>' . __( "If ID <strong>exists</strong>: the plugin checks if username is the same, if yes, it will update the data, if not, it ignores the cell to avoid problems.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '</ul>';
|
|
}
|
|
|
|
static function section_passwords(){
|
|
return
|
|
__( "A string that contains user passwords. We have different options for this case:", 'import-users-from-csv-with-meta' )
|
|
. '<ul style="list-style:disc outside none; margin-left:2em;">'
|
|
. '<li>' . __( "If you <strong>create a password column</strong>: if cell is empty, password won't be updated; if cell has a value, it will be used.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li>' . __( "If you <strong>create a column called user_pass</strong>, it will be a hashed password that will be inserted directly in the database. This is the best option to move users with their passwords using the export tool.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li>' . __( "If you <strong>don't create a column for passwords (nor user_pass nor password)</strong>: passwords will be generated automatically.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li>' . __( "You should not use both columns in the same import", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '</ul>';
|
|
}
|
|
|
|
static function section_roles(){
|
|
return
|
|
__( "Plugin can import roles from the CSV. This is how it works:", 'import-users-from-csv-with-meta' )
|
|
. '<ul style="list-style:disc outside none; margin-left:2em;">'
|
|
. '<li>' . __( "If you <strong>don't create a column for roles</strong>: roles will be chosen from the 'Default role' field in import screen.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li>' . __( "If you <strong>create a column called 'role'</strong>: if the cell is empty, roles will be chosen from 'Default role' field in import screen; if the cell has a value, it will be used as role, if this role doesn't exist the default one would be used", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li>' . __( "Multiple roles can be imported creating <strong>a list of roles</strong> using commas to separate values.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li>' . __( "If you choose <strong>no role</strong> checkbox or write <strong>no_role</strong> in the column role, the user created or updated won't have any role assigned.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '</ul>'
|
|
. '<em>' . __( "Notice: If the default new role is administrator in WordPress settings, role will not be set during a CSV file import with this plugin. Check it if all users are being imported as administrators and you have set another role in this plugin.", 'import-users-from-csv-with-meta' ) . '</em>';
|
|
}
|
|
|
|
static function section_serialized(){
|
|
return __( "Plugin can now import serialized data. You have to use the serialized string directly in the CSV cell in order the plugin will be able to understand it as an serialized data instead as any other string.", 'import-users-from-csv-with-meta' );
|
|
}
|
|
|
|
static function section_lists(){
|
|
return
|
|
__( "Plugin can import lists as an array. Use this separator:", 'import-users-from-csv-with-meta' )
|
|
. ' <strong>::</strong> '
|
|
. __( "two colons, inside the cell in order to split the string in a list of items.", 'import-users-from-csv-with-meta' );
|
|
}
|
|
|
|
static function section_arrays(){
|
|
return
|
|
__( "Plugin can also import arrays with string keys. Use this separator:", 'import-users-from-csv-with-meta' )
|
|
. ' <strong>::</strong> '
|
|
. __( "two colons, inside the cell, in order to split the string in a list of items. Every item should be split using => to separate the key from the value. For example:", 'import-users-from-csv-with-meta' )
|
|
. ' key1=>value1::key2=>value2::key3=>value3';
|
|
}
|
|
|
|
static function section_force_reset_password(){
|
|
return
|
|
'<ul style="list-style:disc outside none; margin-left:2em;">'
|
|
. '<li>' . __( "This option will force users to go to their edit password screen after being created with this plugin. As this is an option that deals with profile screens and password edit actions that can change, <strong>you should be careful if you use a plugin to modify any of these functions</strong>.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li>' . __( "We <strong>support the standard WordPress method and WooCommerce</strong>. But if you use other plugins that modify these views or actions, you may have problems with infinite redirection loops with users who have this option checked.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li>' . __( "If you suffer from this redirection loop problem, apart from not using this option again, you can solve the problem for users already created by deleting the metadata that controls this action. Just use the following button to do so:", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '</ul>'
|
|
. '<input type="button" id="delete_all_metadata_forcing_password_change" class="button button-primary" value="' . esc_attr( __( 'Delete all metadata that would force a password change for all users', 'import-users-from-csv-with-meta' ) ) . '">';
|
|
}
|
|
|
|
static function section_wp_profile(){
|
|
return
|
|
__( "You can use those labels if you want to set data adapted to the WordPress default user columns (the ones who use the function", 'import-users-from-csv-with-meta' )
|
|
. ' <a href="http://codex.wordpress.org/Function_Reference/wp_update_user">wp_update_user</a>)'
|
|
. '<ol>'
|
|
. '<li><strong>user_nicename</strong>: ' . __( "A string that contains a URL-friendly name for the user. The default is the user's username.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li><strong>user_url</strong>: ' . __( "A string containing the user's URL for the user's web site.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li><strong>display_name</strong>: ' . __( "A string that will be shown on the site. Defaults to user's username.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li><strong>nickname</strong>: ' . __( "The user's nickname, defaults to the user's username.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li><strong>first_name</strong>: ' . __( "The user's first name.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li><strong>last_name</strong>: ' . __( "The user's last name.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li><strong>description</strong>: ' . __( "A string containing content about the user.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li><strong>jabber</strong>: ' . __( "User's Jabber account.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li><strong>aim</strong>: ' . __( "User's AOL IM account.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li><strong>yim</strong>: ' . __( "User's Yahoo IM account.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '<li><strong>user_registered</strong>: ' . __( "Using the WordPress format for this kind of data Y-m-d H:i:s.", 'import-users-from-csv-with-meta' ) . '</li>'
|
|
. '</ol>';
|
|
}
|
|
|
|
static function section_cron(){
|
|
return __( 'The Cron tab allows you to make periodic imports using the WordPress cron scheduler.', 'import-users-from-csv-with-meta' );
|
|
}
|
|
|
|
static function section_hooks(){
|
|
return __( 'If you are a developer, you can extend or use this plugin with all the hooks we provide, you have <a href="https://codection.com/import-users-csv-meta/listado-de-hooks-de-import-and-exports-users-and-customers/">a list of them here</a>', 'import-users-from-csv-with-meta' );
|
|
}
|
|
|
|
static function section_example(){
|
|
return
|
|
__( 'Download this', 'import-users-from-csv-with-meta' )
|
|
. ' <a href="' . esc_url( plugins_url( 'test.csv', dirname( __FILE__ ) ) ) . '">.csv ' . __( 'file', 'import-users-from-csv-with-meta' ) . '</a> '
|
|
. __( 'to test', 'import-users-from-csv-with-meta' );
|
|
}
|
|
|
|
static function section_support(){
|
|
return
|
|
'<ul style="list-style:disc outside none; margin-left:2em;">'
|
|
. '<li>' . __( 'Free support (in WordPress forums):', 'import-users-from-csv-with-meta' ) . ' <a href="https://wordpress.org/support/plugin/import-users-from-csv-with-meta">https://wordpress.org/support/plugin/import-users-from-csv-with-meta</a>.</li>'
|
|
. '<li>' . __( 'Premium support (with a quote):', 'import-users-from-csv-with-meta' ) . ' <a href="mailto:contacto@codection.com">contacto@codection.com</a>.</li>'
|
|
. '</ul>';
|
|
}
|
|
}
|