text_input position parameter for prefs page

Pat64 · 2014-12-31 08:43:07

Hey guys.

I need documentation on the “position” parameter for the creation of text_input into the page prefs.
Where can I find it?

Best regards,

Bloke · 2014-12-31 09:46:42

Pat64 wrote #286963:

I need documentation on the “position” parameter for the creation of text_input into the page prefs.

I’m not sure there’s any official documentation on it. But generally, you use it to determine the order things appear within each group. Lower numbers appear first (higher up the page).

You’ll notice that we often leave gaps between successive entries (e.g. a spacing of 10 or so) which allows us to more easily insert entries later without altering more rows than necessary. Not a huge problem if not, it’s just less work to add one row than it is to add the row and increment everything after it as well.

Hope that helps.

Pat64 · 2014-12-31 12:20:26

Yep. Tks Mr Bloke ;)

So, what is your advice? I need to add an entry just after the rvm_css_directory (for example).
Do you think a 20 position is good?

(Is there a programming way to avoid conflicts with existant ones?)

Best regards,

Last edited by Pat64 (2014-12-31 12:23:49)

Bloke · 2014-12-31 12:33:14

Pat64 wrote #286972:

So, what is your advice? I need to add an entry just after the rvm_css_directory (for example).

Pick a number higher than Ruud chose and lower than the next item in the list ;-) If someone else writes a plugin that puts something in between, and you feel strongly about it, you’ll have to update your plugin to put yours back where you think it needs to be. There’s no easy way to determine if a slot is “taken” short of querying the txp_prefs table.

Alternatively, create your own prefixed group for your plugin’s prefs, then you have complete control over the order inside that group.

Pat64 · 2014-12-31 12:38:23

Yeah. Very interesting ;)

Stef, what is the maximum number for this part of text input group?

/**
 * Plugin prefs: entry for cache dir.
 *
 */
function pat_article_social_prefs()
{
	global $textarray;
	$textarray['pat_article_social_dir'] = 'Cache directory';
	if (!safe_field ('name', 'txp_prefs', "name='pat_article_social_dir'"))
		safe_insert('txp_prefs', "prefs_id=1, name='pat_article_social_dir', val='cache', type=1, event='admin', html='text_input', position=21");
	safe_repair('txp_plugin');
}

Last edited by Pat64 (2014-12-31 12:41:32)

Bloke · 2014-12-31 14:03:35

Pat64 wrote #286975:

what is the maximum number for this part of text input group?

65535. Plenty of wiggle room.

Pat64 · 2014-12-31 14:47:00

:D :D :D

Thanks lot Stef for your help.

I wish you a happy new year.

Textpattern CMS

Textpattern CMS support forum

#1 2014-12-31 08:43:07