The settings page<\/p>","2":"
A coloured log file<\/p>"},"jetpack_post_was_ever_published":false},"plugin_section":[],"plugin_tags":[94,9231],"plugin_category":[59],"plugin_contributors":[],"plugin_business_model":[],"class_list":["post-23721","plugin","type-plugin","status-publish","hentry","plugin_tags-debug","plugin_tags-syslog","plugin_category-utilities-and-tools","plugin_committers-marcusdowning"],"banners":[],"icons":{"svg":false,"icon":"https:\/\/s.w.org\/plugins\/geopattern-icon\/bang-syslog.svg","icon_2x":false,"generated":true},"screenshots":[{"src":"https:\/\/ps.w.org\/bang-syslog\/trunk\/screenshot-1.png?rev=1566982","caption":"
The settings page<\/p>"},{"src":"https:\/\/ps.w.org\/bang-syslog\/trunk\/screenshot-2.png?rev=1566982","caption":"
A coloured log file<\/p>"}],"raw_content":"\n
Enable system logging for WordPress plugin and theme development. This can make it easier to know what your code is doing.<\/p>\n\n
Features include:<\/p>\n\n
Using it is as simple as calling the This will produce a line in your system log:<\/p>\n\n This includes:<\/p>\n\n For more detailed instructions, see the How to use<\/strong> tab.<\/p>\n\n To log a message, use the This will output the log message:<\/p>\n\n If you include extra parameters, they'll be added at the end of the log message:<\/p>\n\n This will produce the log message:<\/p>\n\n The value will be formatted correctly depending on its type: integers, strings, arrays, objects, booleans etc. \nYou don't need to check if values are null or empty, they'll still be output safely.<\/p>\n\n If you put the code This will produce the log message:<\/p>\n\n Logging a complete object - such as a WordPress post - can be very large, and sometimes it's only one or two fields you need. \nIf you put a string starting with an exclamation point This will produce the log message:<\/p>\n\n If you do this with an array of objects, those fields will be selected from each of them. The following will output a list of post This will produce the log message:<\/p>\n\n If you have coloured logging switched on, values will appear in different colours to indicate their type.\nThis can make for quicker scanning of log files. \nTo enable coloured logs, tick the Coloured logs<\/em> checkbox on the settings page.\nThen use the Normally, this plugin can only begin logging once the plugin has loaded.\nIf you're using logging to develop your own plugin, you may find it helpful to activate this plugin earlier.\nPut this line near the bottom of your The plugin does nothing until it's called in PHP code.\nSee the How to use<\/strong> tab for more information.<\/p>\n\n\n The By default, the message will be written to the computer's system log.\nThe exact location of this file varies depending on your operating system.\nOn linux, the logs will typically go to The System Logging<\/em> settings page can be used to send the logs instead to the Apache error log, or into a file in your web folder.<\/p><\/dd>\n Like this?<\/p>\n\n You have coloured logging switched on. The codes are unix terminal colour codes, which don't show properly in a normal text editor. You need to use the correct tool to view them.<\/p>\n\n You can either switch coloured logging off in the settings page, or you can use the included script 'log'<\/code> action in your templates or plugin.<\/p>\n\n<?php do_action('log', 'Some log message'); ?>\n<\/code><\/pre>\n\nJun 4 11:23:08 myserver php\/mysite.com[1553]: b8e mysite.com\/path-to-page: Some log message\n<\/code><\/pre>\n\n\n
Jun 4 11:23:08<\/code> - The date and time of the log message<\/li>\nmyserver<\/code> - The name of this computer<\/li>\nphp<\/code> - The program that produced the message<\/li>\nmysite.com<\/code> - The domain name of the site<\/li>\n1553<\/code> - The process ID of the running PHP process<\/li>\nb8e<\/code> - A random 3-digit code identifying each page request<\/li>\nmysite.com\/path-to-page<\/code> - The URL of the request<\/li>\nSome log message<\/code> - Your message<\/li>\n<\/ul>\n\nHow to use<\/h3>\n\n
'log'<\/code> action in your templates or plugins:<\/p>\n\n<?php do_action('log', 'Some log message'); ?>\n<\/code><\/pre>\n\nSome log message\n<\/code><\/pre>\n\nEmbedding values<\/h4>\n\n
<?php do_action('log', 'A number and a string', 17, 'foo'); ?>\n<\/code><\/pre>\n\nA number and a string: 17, foo\n<\/code><\/pre>\n\n%s<\/code> into your log message, then one of the arguments will be dropped into the message:<\/p>\n\n<?php do_action('log', 'I have %s numbers', count($numbers), $numbers); ?>\n<\/code><\/pre>\n\nI have 4 numbers: [9, 16, 307, 1]\n<\/code><\/pre>\n\nSelecting fields<\/h4>\n\n
\"!\"<\/code> followed by a list of field names, they will be selected from the following object.\nThe following will only show the ID<\/code> and post_title<\/code> fields of the post:<\/p>\n\n<?php do_action('log', 'Loaded the post', '!ID,post_title', $post); ?>\n<\/code><\/pre>\n\nLoaded the post: {ID: 1932, post_title: Test page}\n<\/code><\/pre>\n\nID<\/code>s:<\/p>\n\n<?php do_action('log', 'Loaded %s posts', count($posts), '!ID', $posts); ?>\n<\/code><\/pre>\n\nLoaded 3 posts: [1932, 1594, 1103]\n<\/code><\/pre>\n\nColoured logs<\/h4>\n\n
log.sh<\/code> script, included with this plugin, to decode and display the coloured log files.<\/p>\n\n\nBasic installation<\/h4>\n\n
\n
bang-syslog<\/code> directory into the \/wp-content\/plugins\/<\/code> directory<\/li>\n<?php do_action('log', 'Some log message'); ?><\/code> in your templates and plugins<\/li>\n<\/ol>\n\nEarly logging for plugin developers<\/h4>\n\n
wp-config.php<\/code> file:<\/p>\n\nrequire_once(ABSPATH . 'wp-content\/plugins\/bang-syslog\/include.php');\n<\/code><\/pre>\n\nUsing the plugin<\/h4>\n\n
\n
'log'<\/code> action will have no effect.\nNo logs will be written, but there should be no errors either.<\/p><\/dd>\n\/var\/log\/syslog<\/code> or \/var\/log\/messages<\/code>.<\/p>\n\nJun 4 11:23:08 potassium php\/app.k[1553]: \\033[36m\\033[44m97a\\033[0m \\033[32mapp.k\/app-content\/public-order\/policing-football\/www.legislation.gov.uk\/ukpga\/2000\/23\/contents\\033[0m: \\033[37m\\033[1mfs: Setting page params: page = \\033[0m\\033[31mnull\\033[0m\\033[1m, offset = \\033[0m\\033[31mnull\\033[0m\\033[1m, size = \\033[0m\\033[36m10\\033[0m\\033[1m\\033[0m\n<\/code><\/pre>\n\nlog.sh<\/code> to decode the coloured logs.<\/p><\/dd>\n\n<\/dl>","raw_excerpt":"Enable system logging for WordPress plugin and theme development.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/szl.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/23721","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/szl.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/szl.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/szl.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=23721"}],"author":[{"embeddable":true,"href":"https:\/\/szl.wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/marcusdowning"}],"wp:attachment":[{"href":"https:\/\/szl.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=23721"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/szl.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=23721"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/szl.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=23721"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/szl.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=23721"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/szl.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=23721"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/szl.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=23721"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}