Blocks - Revision history

Devdocsbot: Protected "Blocks": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-06-07T07:31:12Z

Protected "Blocks": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 07:31, 7 June 2022
(No difference)

Devdocsbot: Update migration status and path

2022-06-07T07:28:44Z

Update migration status and path

← Older revision		Revision as of 07:28, 7 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/plugintypes/blocks}}
	''' A Step-by-step Guide To Creating Blocks '''		''' A Step-by-step Guide To Creating Blocks '''

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:38:45Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"
Show changes

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T13:09:48Z

Text replacement - "</code>" to "</syntaxhighlight>"

Show changes

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:03:52Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:03, 14 July 2021
				
Line 297:
Line 297:
=== Enabling Global Configuration === === Enabling Global Configuration ===
{{Moodle 2.4}}Since version 2.4, the following line must be added to the /blocks/simplehtml/block_simplehtml.php file in order to enable global configuration: {{Moodle 2.4}}Since version 2.4, the following line must be added to the /blocks/simplehtml/block_simplehtml.php file in order to enable global configuration:
<code> <syntaxhighlight lang="php">
     function has_config() {return true;}      function has_config() {return true;}
</code> </code>



Meeth: /* I Just Hear Static */
2020-07-08T09:10:01Z
I Just Hear Static

				
				
				
				
				
				← Older revision
				Revision as of 09:10, 8 July 2020
				
Line 119:
Line 119:



== I Just Hear Static == == I Just Hear Static ==
In order to get our block to actually display something on screen, we need to add one more method to our class (before the final closing brace in our file). The new code is: In order to get our block to actually display something on screen, we need to add one more method to our class (before the final closing brace in our file) inside of the block_simplehtml.php script. The new code is:



<code php>    <code php>   



Plemaire: /* lang/en/block_simplehtml.php */
2019-03-13T11:52:49Z
lang/en/block_simplehtml.php

				
				
				
				
				
				← Older revision
				Revision as of 11:52, 13 March 2019
				
Line 85:
Line 85:
=== lang/en/block_simplehtml.php === === lang/en/block_simplehtml.php ===



This is the English language file for your block. If you are not an English speaker, you can replace 'en' with your appropriate language code. All language files for blocks go under the /lang subfolder of the block's installation folder. This is the English language file for your block. If you are not an English speaker, you can replace 'en' with your appropriate language code (but even then you will need english folder !). All language files for blocks go under the /lang subfolder of the block's installation folder.



Moodle 2.0 and above require a name for our plugin to show in the upgrading page. We set this value, along with the capabilities we created and any other language strings we wish to use within the block, in a language package as previously mentioned (the same file where we put our string for the plugin title). Moodle 2.0 and above require a name for our plugin to show in the upgrading page. We set this value, along with the capabilities we created and any other language strings we wish to use within the block, in a language package as previously mentioned (the same file where we put our string for the plugin title).



Faridmurzone at 18:56, 6 September 2018
2018-09-06T18:56:44Z


				
				
				
				
				
				← Older revision
				Revision as of 18:56, 6 September 2018
				
Line 39:
Line 39:
     // The PHP tag and the curly bracket for the class definition        // The PHP tag and the curly bracket for the class definition  
     // will only be closed after there is another function added in the next section.      // will only be closed after there is another function added in the next section.
}
</code> </code>






Mohessaid: Fixed the name of the field following what was mentioned in the note above about adding 'config_' to form elements names.
2018-03-06T13:21:27Z
Fixed the name of the field following what was mentioned in the note above about adding 'config_' to form elements names.

				
				
				
				
				
				← Older revision
				Revision as of 13:21, 6 March 2018
				
Line 161:
Line 161:
                     
         // Section header title according to language file.          // Section header title according to language file.
         $mform->addElement('header', 'configheader', get_string('blocksettings', 'block'));          $mform->addElement('header', 'config_header', get_string('blocksettings', 'block'));



         // A sample string variable with a default value.          // A sample string variable with a default value.



Quen: /* db/access.php */ Tweaked to make it clear that the myaddinstance capability is not optional
2016-12-06T10:38:29Z
db/access.php:  Tweaked to make it clear that the myaddinstance capability is not optional

				
				
				
				
				
				← Older revision
				Revision as of 10:38, 6 December 2016
				
Line 51:
Line 51:
This file will hold the new capabilities created by the block. This file will hold the new capabilities created by the block.



Moodle 2.4 onwards introduced the capabilities addinstance and myaddinstance for core blocks. They were introduced so that it was possible to control the use of individual blocks. These capabilities should also be added to your custom block, so in this case to the file blocks/simplehtml/db/access.php. If your block is not going to be used in the 'My Moodle page' (ie, your applicable_formats function (discussed later) has 'my' set to false.) then the myaddinstance capability is not required. The following is the capabilities array and how it should look for any new blocks. Moodle 2.4 onwards introduced the capabilities addinstance and myaddinstance for core blocks. They were introduced so that it was possible to control the use of individual blocks. These capabilities should also be added to your custom block, so in this case to the file blocks/simplehtml/db/access.php. If your block is not going to be used in the 'My Moodle page' (ie, your applicable_formats function (discussed later) has 'my' set to false.) then the myaddinstance capability does not need to be given to any user, but it must still be defined here otherwise you will get errors on certain pages. The following is the capabilities array and how it should look for any new blocks.



<code php> <code php>

← Older revision		Revision as of 13:03, 14 July 2021
Line 297:		Line 297:
	=== Enabling Global Configuration ===		=== Enabling Global Configuration ===
	{{Moodle 2.4}}Since version 2.4, the following line must be added to the /blocks/simplehtml/block_simplehtml.php file in order to enable global configuration:		{{Moodle 2.4}}Since version 2.4, the following line must be added to the /blocks/simplehtml/block_simplehtml.php file in order to enable global configuration:
	<~~code~~>		<syntaxhighlight lang="php">
	function has_config() {return true;}		function has_config() {return true;}
	</code>		</code>

← Older revision		Revision as of 09:10, 8 July 2020
Line 119:		Line 119:

	== I Just Hear Static ==		== I Just Hear Static ==
	In order to get our block to actually display something on screen, we need to add one more method to our class (before the final closing brace in our file). The new code is:		In order to get our block to actually display something on screen, we need to add one more method to our class (before the final closing brace in our file) inside of the block_simplehtml.php script. The new code is:

	<code php>		<code php>

← Older revision		Revision as of 11:52, 13 March 2019
Line 85:		Line 85:
	=== lang/en/block_simplehtml.php ===		=== lang/en/block_simplehtml.php ===

	This is the English language file for your block. If you are not an English speaker, you can replace 'en' with your appropriate language code. All language files for blocks go under the /lang subfolder of the block's installation folder.		This is the English language file for your block. If you are not an English speaker, you can replace 'en' with your appropriate language code (but even then you will need english folder !). All language files for blocks go under the /lang subfolder of the block's installation folder.

	Moodle 2.0 and above require a name for our plugin to show in the upgrading page. We set this value, along with the capabilities we created and any other language strings we wish to use within the block, in a language package as previously mentioned (the same file where we put our string for the plugin title).		Moodle 2.0 and above require a name for our plugin to show in the upgrading page. We set this value, along with the capabilities we created and any other language strings we wish to use within the block, in a language package as previously mentioned (the same file where we put our string for the plugin title).

← Older revision		Revision as of 18:56, 6 September 2018
Line 39:		Line 39:
	// The PHP tag and the curly bracket for the class definition		// The PHP tag and the curly bracket for the class definition
	// will only be closed after there is another function added in the next section.		// will only be closed after there is another function added in the next section.
			}
	</code>		</code>

← Older revision		Revision as of 13:21, 6 March 2018
Line 161:		Line 161:

	// Section header title according to language file.		// Section header title according to language file.
	$mform->addElement('header', '~~configheader~~', get_string('blocksettings', 'block'));		$mform->addElement('header', 'config_header', get_string('blocksettings', 'block'));

	// A sample string variable with a default value.		// A sample string variable with a default value.

← Older revision		Revision as of 10:38, 6 December 2016
Line 51:		Line 51:
	This file will hold the new capabilities created by the block.		This file will hold the new capabilities created by the block.

	Moodle 2.4 onwards introduced the capabilities addinstance and myaddinstance for core blocks. They were introduced so that it was possible to control the use of individual blocks. These capabilities should also be added to your custom block, so in this case to the file blocks/simplehtml/db/access.php. If your block is not going to be used in the 'My Moodle page' (ie, your applicable_formats function (discussed later) has 'my' set to false.) then the myaddinstance capability is not ~~required~~. The following is the capabilities array and how it should look for any new blocks.		Moodle 2.4 onwards introduced the capabilities addinstance and myaddinstance for core blocks. They were introduced so that it was possible to control the use of individual blocks. These capabilities should also be added to your custom block, so in this case to the file blocks/simplehtml/db/access.php. If your block is not going to be used in the 'My Moodle page' (ie, your applicable_formats function (discussed later) has 'my' set to false.) then the myaddinstance capability does not need to be given to any user, but it must still be defined here otherwise you will get errors on certain pages. The following is the capabilities array and how it should look for any new blocks.

	<code php>		<code php>

Blocks - Revision history

Devdocsbot: Protected "Blocks": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

Devdocsbot: Update migration status and path

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Meeth: /* I Just Hear Static */

Plemaire: /* lang/en/block_simplehtml.php */

Faridmurzone at 18:56, 6 September 2018

Mohessaid: Fixed the name of the field following what was mentioned in the note above about adding 'config_' to form elements names.

Quen: /* db/access.php */ Tweaked to make it clear that the myaddinstance capability is not optional

Mudrd8mz: Text replacement - "`" to ""`

`Mudrd8mz: Text replacement - "`" to ""

Mudrd8mz: Text replacement - "`" to ""`